Skip to main content

Interface: ThemeConfigurationPageItem

Properties​

disabled?​

optional disabled?: boolean

Optional: When true, this page will not be active by default. Note that if you specify toggleable: true, this only acts as a default value.

icon?​

optional icon?: string

Optional: the name of an icon to display next to the page name, in the form of "my-icon-name". The list of available icon names can be viewed here: https://phosphoricons.com

key​

key: string

An identifier used for the system to reference this page by. You may also use this to reference the page in your theme at runtime.

previewElement?​

optional previewElement?: string

Optional: HTML code to render in the middle preview section, using Handlebars.js templating syntax to inject configuration values into the preview whenever changes are made.

Available context variables are:

  • Every field from your configuration (that you expect to be available).
  • A "sampleData" object with the following fields: { products: []{name: string}; }

sections​

sections: ThemeConfigurationPageSection[]

Groups of configuration fields to be editable on this page.

subtitle?​

optional subtitle?: string | null

Optional: A sub-heading to display in the configuration page.

title​

title: string

The heading to display in the configuration page. This will also be displayed in summary views.

toggleable​

toggleable: boolean

Whether this page can be disabled/enabled/hidden/visible. Note that fields on page will still be configurable by the user.