Module: ui/mainModule
Functions
addMainModule
▸ addMainModule(messageOptions): Promise<void>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"mainModuleAdd"> |
Returns
Promise<void>
Defined in
src/channel.ts:462
addSmartBarButton
▸ addSmartBarButton(messageOptions): Promise<void>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"smartBarButtonAdd"> |
Returns
Promise<void>
Defined in
src/channel.ts:462
Type Aliases
mainModuleAdd
Ƭ mainModuleAdd: Object
Type declaration
| Name | Type | Description |
|---|---|---|
responseType | void | - |
heading | string | Heading of the main module. |
locationId | string | The locationId you want to display. |
displaySearchBar? | boolean | Toggles the sw-page search bar on/off. Defaults to true. |
displayLanguageSwitch? | boolean | Toggles the sw-page language switch on/off. Defaults to false. |
Defined in
src/ui/mainModule/index.ts:6
smartBarButtonAdd
Ƭ smartBarButtonAdd: Object
Type declaration
| Name | Type | Description |
|---|---|---|
responseType | void | - |
locationId | string | The locationId you want to display. |
buttonId | string | The id of the button |
label | string | The label of the button |
disabled? | boolean | Toggle disabled state of the button |
variant | "primary" | "ghost" | "danger" | "ghost-danger" | "contrast" | "context" | Set the variant of the button |
onClickCallback | () => void | Callback function which will be called once the button is clicked. |
Defined in
src/ui/mainModule/index.ts:32