The plugin's top-level configuration object. Everything in the configuration and its sub-objects is optional (apart from the accessToken) and is filled with defaults if left empty.

Hierarchy

  • PluginConfig

Properties

accessToken: string

The access token for accessing the Pattern Design API

additionalStyle?: string

Additional CSS styles (style instructions inside a <style> block, i.e. without the <style>) that will be inserted by the plugin

colorPicker?: NativeColorPicker | Partial<SpectrumColorPicker>

Allows to configure the color pickers in the design view

colors?: ColorsConfig
filterOptions?: FilterOptions
host?: string

The host (domain name) of the API to use, defaults to patterndesigns.com (use apitest.patterndesigns.com for the sandbox system)

language?: string

Two-letter language code, defaults to the browser locale. See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

pageSize?: number

The page size when fetching designs

productPreviews?: ProductPreviewLayout

How the product previews are laid out.

protocol?: string

The protocol (default https), unless when using http for local development

scale?: ScaleOptions
texts?: {
    [key: string]: I18nTexts;
}

Type declaration

Generated using TypeDoc