Skip to content
pixi-silk
GitHub repository
Interface

NumberFieldOptions

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

Options of NumberField.

Extends#

Properties#

PropertyTypeDescriptionDefined in
max?numberHighest value. Scrubs and typed values clamp to it. Default no limit.ui/panels/fields.ts:149
min?numberLowest value. Scrubs and typed values clamp to it. Default no limit.ui/panels/fields.ts:147
perPixel?numberChange per pixel of a scrub. Default step.ui/panels/fields.ts:153
precision?numberDecimals shown. Default from the step.ui/panels/fields.ts:157
prefix?stringA short name inside the field, such as X or W. Drag it to scrub.ui/panels/fields.ts:145
step?numberSnap step of scrubs. Default 1.ui/panels/fields.ts:151
unit?stringShown after the value, such as px or %.ui/panels/fields.ts:155

Methods#

begin()#

begin(): void;

A gesture starts. Capture the values to undo to.

Returns#

void

Inherited from#

FieldEdit.begin


end()#

end(): void;

The gesture ends. Record one undo step.

Returns#

void

Inherited from#

FieldEdit.end


input()#

input(values: readonly number[]): void;

New values, one per edited object, while the gesture runs. Write them through.

Parameters#

ParameterType
valuesreadonly number[]

Returns#

void

Inherited from#

FieldEdit.input