ToolbarApi.ToolbarApiV1
Description
Contains APIs to allow toolbar creation, modification, and adjust visibility
Properties
Properties
createToolbarContent
Type declaration
- (
slot
, toolbarContent
, toolbarId?
): Promise
<string
>
Parameters
Name |
Type |
Description |
slot
|
ToolbarSlotName
|
The location on the page to create the toolbar (i.e. "header" | "dashboard" | "footer") |
toolbarContent
|
ToolbarContent
|
An object representing the toolbar including HTMLElements and CSS styling |
toolbarId?
|
string
|
The optional ID of the toolbar to be registered |
Returns
Promise
<string
>
A Promise to be resolved with the id assigned to the created toolbar.
Description
Allows the developer to create a toolbar for the current list.
Type declaration
Parameters
Returns
ToolbarStateItem
[]
An array of objects containing the state of each toolbar in the specified slot.
Description
Allows the developer to retrieve the current state of all toolbars in the specified slot.
Type declaration
Parameters
Returns
void
Description
Allows the developer to hide all the toolbars within the specified slot.
Type declaration
Parameters
Name |
Type |
Description |
slot
|
ToolbarSlotName
|
The location on the page of the toolbar to be hidden (i.e. "header" | "dashboard" | "footer") |
toolbarId
|
string
|
The id of the toolbar to be hidden. |
Returns
void
Description
Allows the developer to hide the specified toolbar.
modifyToolbarContent
Type declaration
- (
slot
, toolbarId
, factoryFn
): Promise
<void
>
Parameters
Name |
Type |
Description |
slot
|
ToolbarSlotName
|
The location on the page of the toolbar to be modified (i.e. "header" | "dashboard" | "footer"). |
toolbarId
|
string
|
The id of the toolbar to be modified. |
factoryFn
|
ToolbarFactory
|
A function to be called for modification of the specified toolbar. |
Returns
Promise
<void
>
A Promise to be resolved when the toolbar registry has been updated.
Description
Allows the developer to modify a toolbar for the current list via a callback function.
Type declaration
Parameters
Returns
void
Description
Allows the developer to show all the toolbars within the specified slot.
Type declaration
Parameters
Name |
Type |
Description |
slot
|
ToolbarSlotName
|
The location on the page of the toolbar to be shown (i.e. "header" | "dashboard" | "footer"). |
toolbarId
|
string
|
The id of the toolbar to be shown. |
Returns
void
Description
Allows the developer to show the specified toolbar.