Documentation

Style Book Token Definitions

Style Books have options grouped into various categories that are defined per theme. Each option is defined with a token. The collection of all tokens defined for a theme is a token definition.

When you assign a theme to your Site’s Public Pages, the token definition included with that theme is used when creating a Style Book for the Site.

Defining Tokens for Your Style Book

Since the token definition is tied to your theme, token definitions must correspond to a CSS variable contained within your theme module. Specify the token definitions themselves in a .json file within your theme module’s folder, named frontend-token-definition.json.

Token Categories

Tokens defining the options for configuring your Style Book are grouped into categories. Each category appears as one of the options in the drop-down menu when you are editing your Style Book.

Each of the options in the drop-down menu corresponds to one category of Style Book tokens.

Define each of these categories within a frontendTokenCategories field within your frontend-token-definition.json file:

{
    "frontendTokenCategories": [
        {
            "frontendTokenSets": [],
            "label": "buttons",
            "name": "buttons"
        }
    ]
}

Define a label and a name for each of your token categories. The label value is interpreted as a language key and displayed as the option in the drop-down menu for your category.

Token Sets

Each category is further organized into token sets. Token sets correspond to the collapsible groups of options that appear when you are editing a Style Book.

For example, using the default Classic theme, the Button Primary token set (within the Buttons category) includes all tokens for standard button color options:

The Button Primary token set includes all of the customizable colors for the main buttons in the Classic theme.

Define each token set inside a category’s frontendTokenSets field:

{
    "frontendTokenCategories": [
        {
            "frontendTokenSets": [
                {
                    "frontendTokens": [],
                    "label": "primary-buttons",
                    "name": "primaryButtons"
                }
            ],
            "label": "buttons",
            "name": "buttons"
        }
    ]
}

Define a label and name for each token set just like with each category.

Token Definitions

Finally, all tokens in each token set contain properties for configuring each option.

Define all of the tokens within each token set’s frontendTokens field. Here is a list of all of the properties you can use for your tokens:

defaultValue: The default value displayed for the option. This field must match the default value used in the CSS.

editorType: Use this field if you want to use a color picker editor for the field. The only supported value is "ColorPicker". If no value is set, a text input is used. If a select input is needed, use the validValues property instead (the two properties cannot be used together).

mappings: The mapping between the token definition name to the corresponding CSS variable name (must contain type and value as nested fields). Use "cssVariable" as the type and define the value as the CSS variable name.

label: The language key that appears for the option when editing a Style Book.

name: The token’s name.

type: The type of data that the token displays. Use "Integer", "Float", or "String" to display a text field holding those types of values. Use "Boolean" to display a checkbox.

validValues: Optional property that lists available options for the User in the UI. This field must contain a nested list of label and value pairs (value is the field’s value in CSS). This property cannot be used together with editorType. Defining a value for validValues makes the input type automatically a select input.

Here is an example list of tokens within a token set:

"frontendTokens": [
    {
        "defaultValue": "#0B5FFF",
        "editorType": "ColorPicker",
        "label": "primary",
        "mappings": [
            {
                "type": "cssVariable",
                "value": "primary"
            }
        ],
        "name": "primaryColor",
        "type": "String"
    },
    {
        "defaultValue": "sans-serif",
        "label": "font-family",
        "mappings": [
            {
                "type": "cssVariable",
                "value": "fontFamily"
            }
        ],
        "name": "fontFamily",
        "type": "String",
        "validValues": [
            {
                "label": "sans-serif",
                "value": "sans-serif"
            },
            {
                "label": "monospace",
                "value": "Courier New"
            }
        ]
    }
]

Matching CSS Variables to Style Book Tokens

The frontend-token-definition.json file containing your token definition must be in the src/WEB-INF folder of your theme module folder. Every token defined in your token definition must represent a style (color, spacing, font, etc.) in the CSS of your theme.

All styles that your tokens represent must be coded as CSS variables. For example, take this definition of a token (giving an option to configure a font):

{
    "defaultValue": "sans-serif",
    "label": "font-family-base",
    "mappings": [
        {
            "type": "cssVariable",
            "value": "font-family-base"
        }
    ],
    "name": "fontFamilyBase",
    "type": "String"
}

This token may represent a style in your CSS like this:

:root {
    --font-family-base: 'sans-serif'
}

body {
    font-family: var(--font-family-base);
}

The value in the token definition’s mappings (font-family-base) matches the variable name in the CSS. Use two hyphens to precede the CSS variable name (in this example, --font-family-base).

Important

If a value for defaultValue is included in your token definition, then this must match the default value defined in the matching CSS variable definition.