UI Framework ReferenceICanvasDefinitionSetTheme

Interface: ICanvasDefinitionSetTheme

Provides properties to define a product theme.

For details, you can refer to the SetTheme command.

{
  "type": "canvas",
  "name": "editor",
  "params": {
    "initial": { ... },
    "setTheme": {
      "primary": "{{ "#f00" }}",
      "secondary": "{{ "#0f0" }}"
    }
  }
}

Hierarchy

Index

Properties

Properties

Optional after

after? : string | string[]

Inherited from ICanvasCommandDefinition.after

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:30

The next commands to be executed after this command completes.


theme

theme: string | CustomersCanvas.IframeApi.Configuration.IProductThemeConfig

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:112

Typically, it is a theme name as a string, but you can also pass a structure describing an "ad-hoc" theme.