Skip to main content

Name each component in your project

To help anyone understand your project and find what they need easily, it is recommended to use the following naming conventions.

  • Case styles: Define when to use PascalCase (Pages, Components), camelCase (Variables, Data Types), and kebab-case (URLs, CSS classes).

    • Search is case-sensitive across the KAIZEN platform and all modules. Therefore, establishing a consistent case style is highly recommended.

  • Prefixes: Use prefixes for visual clarity (e.g., btn_ for buttons, ds_ for datasources, svc_ for services).

  • Semantic meaning: Avoid generic names such as test_page or button1. Use functional names e.g., user_registration_form or btn_submit_order.

    • Valid values for Page ID: When you create or edit a page, use valid values like a to z, A to Z, 0 to 9 and underscore _. Other values will trigger an error message before you can save it.

  • Domain alignment: Ensure names in the Domain Model match the business logic (e.g., use invoice_amount instead of price_val).

  • Global vs. local: Differentiate between global shared resources and page-specific assets to prevent accidental overwrites.

Aiming at consistency and clarity, you can also set specific rules to name your project components.

Last updated on 20 May 2026