Module: ui/cms
Functions
registerCmsElement
▸ registerCmsElement(messageOptions): Promise<void>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"cmsRegisterElement"> |
Returns
Promise<void>
Defined in
src/channel.ts:462
Type Aliases
cmsRegisterElement
Ƭ cmsRegisterElement: Object
Type declaration
| Name | Type | Description |
|---|---|---|
responseType | void | - |
name | string | The unique name of the cms element, which will also be used to generate locationIds - Should have vendor prefix Example ts 'company-my-image-slider' will result in the location ids: - 'company-my-image-slider-element' for the element in the cms itself - 'company-my-image-slider-preview' for the preview in the cms element selection - 'company-my-image-slider-config' for the configuration modal of a placed element |
label | string | The label, which is visible when selecting the cms element - Use snippet keys here! |
defaultConfig | { [key: string]: unknown; } | Object containing the defaultConfig; same like in plugin development. Url https://developer.shopware.com/docs/guides/plugins/plugins/content/cms/add-cms-element |
Defined in
src/ui/cms/index.ts:5