Skip to content

ToolbarButtonProperties

export type ToolbarButtonProperties = {
    Active: CanBeState<boolean>?,
    Toolbar: PluginToolbar,
    ToolTip: string,
    Image: string,
    Name: string,
    [any]: any,
}

The ToolbarButtonProperties table that is given to the ToolbarButton() function that contains data about the desired ToolbarButton.


Properties

Name : string

The name of the ToolbarButton.


Image : string

The Image that will be on the ToolbarButton.


Tooltip : string

The tooltip that will appear when the user hovers over the ToolbarButton.


Toolbar : PluginToolbar

The toolbar that the ToolbarButton will be in.


Active : CanBeState<boolean>?

Sets whether the ToolbarButton will be active or not. Can either be a State containing a boolean, or a boolean.