Module: ui/settings
Functions
addSettingsItem
▸ addSettingsItem(messageOptions): Promise<void>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"settingsItemAdd"> |
Returns
Promise<void>
Defined in
packages/admin-sdk/src/channel.ts:446
Type Aliases
settingsItemAdd
Ƭ settingsItemAdd: Object
Type declaration
| Name | Type | Description |
|---|---|---|
responseType | void | - |
label | string | Label of the settings item. |
locationId | string | The locationId you want to display. |
icon | icons | The icon to display in your settings item. |
tab? | "shop" | "system" | "plugins" | Determines in which tab your settings item will be displayed. Defaults to plugins. |
displaySearchBar? | boolean | Toggles the sw-page search bar on/off. Defaults to true. |
Defined in
packages/admin-sdk/src/ui/settings/index.ts:6