Checkbox

Module: graphite

Toggleable checkbox with a label and change callback support.

Declaration

export class Checkbox extends UIObject { ... }

Extends: UIObject

constructor();

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

label: string;

font: Font;

position: Position3d;

fontSize: number;

padding: Size2d;

boxSize: number;

spacing: number;

checked: boolean;

enabled: boolean;

textColor: Color;

boxBackgroundColor: Color;

hoverBoxBackgroundColor: Color;

borderColor: Color;

activeBorderColor: Color;

checkColor: Color;

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;

isChecked(): boolean;

isHovered(): boolean;

isEnabled(): boolean;

Returns the element's style.

style(): UIStyle;

setLabel(label: string): Checkbox;

setPadding(padding: Size2d): Checkbox;

setFontSize(size: number): Checkbox;

setBoxSize(size: number): Checkbox;

setSpacing(spacing: number): Checkbox;

Applies a style to the element.

setStyle(style: UIStyle): Checkbox;

Registers the toggle callback and returns this checkbox for chaining.

setOnToggle(callback: Checkbox.ToggleCallback): Checkbox;

setChecked(checked: boolean): void;

setEnabled(enabled: boolean): void;

toggle(): void;