Label Naming Conventions
Author:
Fluent Commerce
Changed on:
25 Oct 2023
Overview
This page provides naming recommendations to follow for labels across the Fluent platform.
- nameSpace.domain.[subdomain].module.[submodules...].label
- submodules = page.tab.component(card/table)
- All levels use the singular. For example, order instead of orders and component instead of components.
- Use Camel Case to separate words. For example,: fc.om.order.ui.list.title).
Key points
- Namespace
- Domain
- Module
- Label
Namespace
fc namespace is reserved for Fluent Commerce components and keys. Partners have their own namespace.
Example: fc.om..ui.list.title
Domain
The domain represents the Fluent domain where the key is used. For example, Management (om), (gi), and Product Availability (pa).
Example: fc.om..ui.list.title
Subdomain
Subdomain represents the within the primary domain where this key is used. For example, the keys used in the will have order as the subdomain.
Example.: fc.om..ui.list.title
Module
The module is the section where key is used within the application. All UI labels have ui as the module key.
Example: fc.om..ui.list.title
Sub modules
There can be a number of sub-modules. For example, the page (list or details), card (summary), tab or list can be included as sub module to create a unique key.
Example: fc.om..ui.list.title
Label
Label represents the value that is getting translated.
Example: fc.om..ui.list.title
The entire key is checked to find a matching translation available in the language resource bundles.
For example:
Order Management Domain
non-UI-centric order
fc.om..[....].status.created fc.om..status.booked fc.om..type.hd fc.om..type.cc
order listing page
fc.om..ui.list.nav fc.om..ui.list.title fc.om..ui.list.results.column.ref fc.om..ui.list.results.column.customer fc.om..ui.list.results.column.status fc.om..ui.list.results.column.
customer listing page
fc.om.customer.ui.list.nav fc.om.customer.ui.list.title fc.om.customer.ui.list.results.column.ref fc.om..ui.detail.title # page title fc.om..ui.detail.overview.title # tab title
overview (tab), summary (card)
fc.om..ui.detail.overview.summary.title fc.om..ui.detail.overview.summary.field.type fc.om..ui.detail.overview.summary.field.status fc.om..ui.detail.overview.summary.field.created
overview (tab), retailer (card)
fc.om..ui.detail.overview..title fc.om..ui.detail.overview..field.
fulfilment (tab), list (card/table)
fc.om..ui.detail.fulfilment.title fc.om..ui.detail.fulfilment.list.title fc.om..ui.detail.fulfilment.list.column.id fc.om..ui.detail.fulfilment.list.column.status fc.om..ui.detail.fulfilment.list.column.deliveryType fc.om..ui.detail.fulfilment.list.column. fc.om..ui.detail.tab.overview fc.om..ui.detail.tab.fulfilment fc.om..ui.detail.summary.field.type fc.om..ui.detail.summary.field.status fc.om..ui.detail.summary.field.created
