Skip to main content
Version: 2.x (upcoming)

Branding

The Branding page makes the application look like your organisation for all of its members. Each organisation has its own theme, based on Material 3 theming.

Authorization​

Open to the System Administrator and Organisation Admin roles. See Roles.

Switch the sidebar to the Admin view, choose Settings under Organisation, then Branding in the Appearance group. See Organisation settings.

The page​

The page has three cards and a live Preview:

  • Main colour: the color the theme is generated from.
  • Logo: an image shown next to the product name in the top bar.
  • Advanced: custom style variables: CSS variables that override the generated theme.

Each card shows whether the organisation uses its own value (Changed, with Reset to default), the Default organisation's (Set by the installation, with Use your own value), or the built-in one (Default); see How settings are saved.

The Preview updates as you change the color and the logo. Nobody else sees the changes until you save. Once saved, they apply to every member of the organisation, and the new colors apply to your own session at once.

The Branding page: the Main colour card with five suggested colours and the Custom colour field, the Logo card with Upload logo, the collapsed Advanced: custom style variables card, and the Preview on the right


Main colour​

Pick one of the suggested colors (Blue, Teal, Indigo, Red, or Slate), type any color in Custom colour, or choose it with the color picker. The theme used for buttons, links, and highlights is generated from it.

The main color is the base from which Material generates the theme. The generated theme does not necessarily use that exact color as its primary color: the theme builder keeps the primary color as close to your choice as it can without breaking the theme's contrast rules. To use one specific color as is, set it in the custom style variables.


Upload an image, for example SVG, or PNG with a transparent background. It is shown next to the product name in the top bar. Replace or remove it at any time; a new logo reads New logo, not saved yet until you save.


Advanced: custom style variables​

The CSS Override (json) field takes one JSON object of variable names and values, for example { "--link-color": "#1F57C3" }. The accepted variables are the Material theme variables, plus a few specific to OpenCDMP. They are applied after the theme generated from the main color, so they take precedence over it.

The card links to the List of theming variables, which is this page, and to the Material Theme Builder, which helps generate matching color values. OpenCDMP themes are generated in light mode.

The Advanced: custom style variables card of the Branding page, with the CSS Override (json) field and links to the theming variables and the Material Theme Builder

Color variables​

Colors use the Material --mat-sys-<token> naming convention. Commonly used color tokens:

NameDescription
--mat-sys-surfaceThe background color of most surfaces, such as cards and dialogs
--mat-sys-on-surfaceIcons, text, and other elements placed on a surface
--mat-sys-backgroundThe background of the main area, behind every element users interact with
--mat-sys-on-backgroundIcons, text, and other elements placed on the background
--mat-sys-primaryThe most common color of components. Also the color associated with plans.
--mat-sys-on-primaryIcons, text, and other elements placed on a primary background
--mat-sys-tertiaryThe accent color of components. Also the color associated with assets.
--mat-sys-on-tertiaryIcons, text, and other elements placed on a tertiary background

See the full list of color tokens.

Typography variables​

Typography uses the --mat-sys-<scale>-<size>-<property> naming convention:

PartValues
scaledisplay, headline, title, body, label
sizelarge, medium, small
propertysize, line-height, weight

Where some of the sizes are used:

NameUsed for
--mat-sys-body-large-sizeEditor input fields
--mat-sys-body-medium-sizeThe base text size of the application
--mat-sys-body-small-sizeHints, tooltips, the sidebar menu footer
--mat-sys-label-large-sizeButtons
--mat-sys-headline-large-sizeDialog and other main titles
--mat-sys-headline-medium-sizeSecondary titles
--mat-sys-headline-small-sizeSidebar menu items, section titles

See the full list of typography tokens.

OpenCDMP variables​

Variables added by OpenCDMP, overridden the same way as the Material ones:

NameDefault valueDescription
--link-color#1E59B1The color of every link in the application

See also​