@itwin/appui-abstract/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts

iTwin.js UI abstractions

/** @packageDocumentation
 * @module Toolbar
 */
import { BadgeType } from "../items/BadgeType";
import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
import { ConditionalStringValue } from "../items/ConditionalStringValue";
/** Describes the data needed to insert a UI items into an existing set of UI items.
 * @public
 */
export interface ToolbarItem {
    /** can be used by application to store miscellaneous data. */
    readonly applicationData?: any;
    /** id of UiItemsProvider */
    readonly providerId?: string;
    /** Describes badge. Renders no badge if not specified. */
    readonly badgeType?: BadgeType;
    /** Optional description */
    readonly description?: string | ConditionalStringValue;
    /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
    readonly id: string;
    /** optional data to used by item implementor. */
    readonly internalData?: Map<string, any>;
    /** Defines if the item is active (shown with an active stripe/bar). */
    readonly isActive?: boolean;
    /** Describes if the item is visible or hidden. The default is for the item to be visible. */
    readonly isHidden?: boolean | ConditionalBooleanValue;
    /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
    readonly isDisabled?: boolean | ConditionalBooleanValue;
    /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars
     * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars
     * the icon is usually changed to denote the state of a toggle.
     */
    readonly isPressed?: boolean;
    /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
     * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
     * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.
     */
    readonly groupPriority?: number;
    /** Priority within a toolbar or group. */
    readonly itemPriority: number;
    /** Optional parent tool group to add tool. */
    readonly parentToolGroupId?: string;
}
/** Describes the data needed to insert an action button into a toolbar.
 * @public
 */
export interface ActionButton extends ToolbarItem {
    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
    readonly icon: string | ConditionalStringValue;
    /** label, shown as tool tip on a button or an item label in a group. */
    readonly label: string | ConditionalStringValue;
    /** function to run when the button is pressed. */
    readonly execute: () => void;
}
/** Describes the data needed to insert a group button into a toolbar.
 * @public
 */
export interface GroupButton extends ToolbarItem {
    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
    readonly icon: string | ConditionalStringValue;
    /** label, shown as tool tip on group button or a group button label in a group panel. */
    readonly label: string | ConditionalStringValue;
    /** label shown as the title in at top of group panel. */
    readonly panelLabel?: string | ConditionalStringValue;
    /** children of the group */
    readonly items: ReadonlyArray<ActionButton | GroupButton>;
}
/** Describes the data needed to insert a custom button into a toolbar.
 * @public
 */
export interface CustomButtonDefinition extends ToolbarItem {
    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
    readonly icon?: string | ConditionalStringValue;
    /** label, shown as tool tip on group button or a group button label in a group panel. */
    readonly label?: string | ConditionalStringValue;
    /** parameter that marks data as being a custom definition. */
    readonly isCustom: true;
}
/** Any Button Type that can be inserted into a toolbar.
 * @public
 */
export type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;
/** Helper class to create Abstract StatusBar Item definitions.
 * @public
 */
export declare class ToolbarItemUtilities {
    /** Creates an Action Button */
    static createActionButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>) => ActionButton;
    /** Creates a Group button. */
    static createGroupButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton>) => GroupButton;
    /** ActionButton type guard. */
    static isActionButton(item: CommonToolbarItem): item is ActionButton;
    /** GroupButton type guard. */
    static isGroupButton(item: CommonToolbarItem): item is GroupButton;
    /** CustomButtonDefinition type guard. */
    static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition;
}
//# sourceMappingURL=ToolbarItem.d.ts.map