Button

Module: graphite

Clickable text button with hover, enabled state, and click callback support.

Declaration

export class Button extends UIObject { ... }

Extends: UIObject

constructor();

constructor(font: Font, label: string, position: Position2d);

label: string;

font: Font;

position: Position3d;

fontSize: number;

padding: Size2d;

minimumSize: Size2d;

textColor: Color;

backgroundColor: Color;

hoverBackgroundColor: Color;

pressedBackgroundColor: Color;

borderColor: Color;

hoverBorderColor: Color;

enabled: boolean;

Returns the current dimensions.

override getSize(): Size2d;

Returns the UI element's screen-space position.

override getScreenPosition(): Position2d;

Sets the UI element's screen-space position.

override setScreenPosition(position: Position2d): void;

getLabel(): string;

isHovered(): boolean;

isEnabled(): boolean;

Returns the element's style.

style(): UIStyle;

setLabel(label: string): Button;

setPadding(padding: Size2d): Button;

setMinimumSize(size: Size2d): Button;

setFontSize(size: number): Button;

Applies a style to the element.

setStyle(style: UIStyle): Button;

Registers the click callback and returns this button for chaining.

setOnClick(callback: Button.ClickCallback): Button;

setEnabled(enabled: boolean): void;