Skip to main content

LensStudio:Ui.ToolbarSettings

Class

Settings for toolbar configuration.

Index

Example

// ToolbarSettings configures toolbar button position and display.
// Properties: position (ToolbarPosition), primary, priority, showText.
const settings = new ToolbarSettings();
settings.position = ToolbarPosition.Right;
settings.primary = false;
settings.priority = 50;
settings.showText = true;

console.log('position:', settings.position);
console.log('primary:', settings.primary);
console.log('priority:', settings.priority);
console.log('showText:', settings.showText);
// Assign to ToolbarConfig.settings before registering a toolbar action

Constructors

Constructor

new ToolbarSettings(): ToolbarSettings

Constructs a new ToolbarSettings configuration object for use in a plugin descriptor's toolbar configuration.

Returns

ToolbarSettings

Properties

position

position: ToolbarPosition

Position of the toolbar within the editor layout, as a ToolbarPosition value.


primary

primary: boolean

Whether this toolbar is designated as the primary toolbar.


priority

priority: number

Numeric priority used to determine toolbar ordering when multiple toolbars share the same position.


showText

showText: boolean

Whether text labels are shown alongside toolbar icons.