Toolbar
Displays frequently used actions or tools in a compact, easily accessible bar.
Structure
API Reference
The root component which contains the toolbar.
Property | Type | Description |
---|---|---|
loop | boolean | Whether or not the toolbar should loop when navigating. Default: true |
orientation | enum | The orientation of the toolbar. Default: horizontal |
asChild | boolean | Whether to use render delegation with this component or not. Default: false |
el | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to programatically interact with the element. Default: undefined |
Slot Property | Type | Description |
---|---|---|
builder | object | The builder attributes and actions to apply to the element if using the |
Data Attribute | Value | Description |
---|---|---|
data-orientation | —— | The orientation of the toolbar. |
data-toolbar-root | —— | Present on the root element. |
A button in the toolbar.
Property | Type | Description |
---|---|---|
asChild | boolean | Whether to use render delegation with this component or not. Default: false |
el | HTMLButtonElement | The underlying DOM element being rendered. You can bind to this to programatically interact with the element. Default: undefined |
Slot Property | Type | Description |
---|---|---|
builder | object | The builder attributes and actions to apply to the element if using the |
Data Attribute | Value | Description |
---|---|---|
data-toolbar-button | —— | Present on the button element. |
A link in the toolbar.
Property | Type | Description |
---|---|---|
asChild | boolean | Whether to use render delegation with this component or not. Default: false |
el | HTMLAnchorElement | The underlying DOM element being rendered. You can bind to this to programatically interact with the element. Default: undefined |
Slot Property | Type | Description |
---|---|---|
builder | object | The builder attributes and actions to apply to the element if using the |
Data Attribute | Value | Description |
---|---|---|
data-toolbar-link | —— | Present on the link element. |
A group of toggle items in the toolbar.
Property | Type | Description |
---|---|---|
value | union | The value of the toggle group. If the type is multiple, this will be an array of strings, otherwise it will be a string. Default: undefined |
onValueChange | function | A callback function called when the value changes. Default: undefined |
disabled | boolean | Whether or not the switch is disabled. Default: false |
type | enum | The type of toggle group. Default: single |
asChild | boolean | Whether to use render delegation with this component or not. Default: false |
el | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to programatically interact with the element. Default: undefined |
Slot Property | Type | Description |
---|---|---|
builder | object | The builder attributes and actions to apply to the element if using the |
Data Attribute | Value | Description |
---|---|---|
data-toolbar-group | —— | Present on the group element. |
A toggle item in the toolbar toggle group.
Property | Type | Description |
---|---|---|
value | string | The value of the toolbar toggle group item. When the toolbar toggle group item is selected, toolbar the toggle group's value will be set to this value if in single mode, or this value will be pushed to the toggle group's array value if in multiple mode. Default: undefined |
disabled | boolean | Whether or not the item is disabled. Default: false |
asChild | boolean | Whether to use render delegation with this component or not. Default: false |
el | HTMLButtonElement | The underlying DOM element being rendered. You can bind to this to programatically interact with the element. Default: undefined |
Slot Property | Type | Description |
---|---|---|
builder | object | The builder attributes and actions to apply to the element if using the |
Data Attribute | Value | Description |
---|---|---|
data-state | enum | Whether the toolbar toggle item is in the on or off state. |
data-value | —— | The value of the toolbar toggle item. |
data-disabled | —— | Present when the toolbar toggle item is disabled. |
data-toolbar-item | —— | Present on the item element. |