Module: ui/action-button
Functions
add
▸ add(messageOptions): Promise<void>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"actionButtonAdd"> |
Returns
Promise<void>
Defined in
packages/admin-sdk/src/channel.ts:446
Type Aliases
actionButtonAdd
Ƭ actionButtonAdd: Object
Add an ActionButton.
Type declaration
| Name | Type | Description |
|---|---|---|
responseType | void | - |
name | string | Unique identifier for the action. |
entity | "product" | "order" | "category" | "promotion" | "customer" | Defines which entity you're working on. |
view | "detail" | "list" | Where the button should be added to. "detail" for the detail page "list" for the entity listing |
label | string | Label of your action button. |
callback | (entity: string, entityIdList: string[]) => void | Callback function which will be called once the action button is clicked. |
Defined in
packages/admin-sdk/src/ui/action-button/index.ts:8