ToggleField

import { ToggleField } from 'pixi-silk/ui/inspector';

An on and off switch with a springy knob. Mixed values park the knob in the middle.

Extends#

Field

Constructors#

Constructor#

new ToggleField(ctx: FieldContext, options: ToggleFieldOptions): ToggleField;

Parameters#

Parameter	Type
`ctx`	`FieldContext`
`options`	`ToggleFieldOptions`

Returns#

ToggleField

Overrides#

Field.constructor

Accessors#

fieldWidth#

Get Signature#

get fieldWidth(): number;

Width of the field box. Default 120 until Field.resize.

Returns

number

Inherited from#

Field.fieldWidth

value#

Get Signature#

get value(): boolean;

True when on (and not mixed).

Returns

boolean

Methods#

destroy()#

destroy(options?: DestroyOptions): void;

Stops the animation. Destroys children unless options says otherwise.

Parameters#

Parameter	Type
`options?`	`DestroyOptions`

Returns#

void

Inherited from#

Field.destroy

resize()#

resize(width: number, height: number): void;

Sets the size of the field box and redraws.

Parameters#

Parameter	Type
`width`	`number`
`height`	`number`

Returns#

void

Inherited from#

Field.resize

setEnabled()#

setEnabled(on: boolean): void;

False dims the field and ignores input, while nothing is edited.

Parameters#

Parameter	Type
`on`	`boolean`

Returns#

void

Inherited from#

Field.setEnabled

show()#

show(values: readonly unknown[]): void;

Shows the values of the edited objects, one per object. Differing values show as mixed. An empty list disables the field.

Parameters#

Parameter	Type
`values`	readonly `unknown`[]

Returns#

void

Overrides#

Field.show

tick()#

tick(dt: number): boolean;

Advances the motion by dt seconds (only needed with ticker: null). Returns true while moving.

Parameters#

Parameter	Type
`dt`	`number`

Returns#

boolean

Inherited from#

Field.tick

toggle()#

toggle(): void;

Flips the switch: on for every edited object, unless all were on.

Returns#

void