Skip to content

InputOptions

Defined in: ui/Input.ts:156

Main configuration options for the Input component InputOptions

const input = new Input({
value: 'Initial value',
type: 'text',
minWidth: 400,
padding: [12, 15],
placeholder: {
text: 'Enter text...',
color: 0x666666
},
bg: {
radius: 10,
stroke: { width: 2, color: 0x000000 }
},
focusOverlay: {
activeFilter: ['mobile', 'touch'],
scale: 2.5
}
});

[key: string]: any

optional alpha: number

Defined in: mixins/factory/props.ts:42

Partial.alpha


optional anchor: PointLike

Defined in: mixins/factory/props.ts:136

Partial.anchor


bg: Partial<BgStyleOptions>

Defined in: ui/Input.ts:178

Background style configuration


blurOnEnter: boolean

Defined in: ui/Input.ts:174

Whether to blur on Enter key


caret: Partial<ColorOptions>

Defined in: ui/Input.ts:184

Caret configuration


debug: boolean

Defined in: ui/Input.ts:166

Enable debug mode


optional error: object

Defined in: ui/Input.ts:186

Error state styling

optional bg: Partial<Omit<BgStyleOptions, "stroke">>

optional input: object

optional fill: number


fixed: boolean

Defined in: ui/Input.ts:162

Whether the input width is fixed


focusOverlay: Partial<FocusOverlayOptions>

Defined in: ui/Input.ts:193

Focus overlay configuration


optional layout: null | boolean | Omit<LayoutOptions, "target">

Defined in: mixins/factory/props.ts:47

Partial.layout


optional maxLength: number

Defined in: ui/Input.ts:172

Maximum length of input


minWidth: number

Defined in: ui/Input.ts:168

Minimum width of the input


padding: Padding

Defined in: ui/Input.ts:170

Padding configuration


pattern: string

Defined in: ui/Input.ts:164

Pattern for input validation


placeholder: Partial<PlaceholderOptions & ColorOptions & ExtraPlaceholderOptions>

Defined in: ui/Input.ts:180

Placeholder configuration


optional position: PointLike

Defined in: mixins/factory/props.ts:28

Partial.position


optional regex: RegExp

Defined in: ui/Input.ts:176

Custom regex for validation


optional resolution: number

Defined in: mixins/factory/props.ts:137

Partial.resolution


optional roundPixels: boolean

Defined in: mixins/factory/props.ts:138

Partial.roundPixels


optional scale: PointLike

Defined in: mixins/factory/props.ts:34

Partial.scale


optional scaleX: number

Defined in: mixins/factory/props.ts:32

Partial.scaleX


optional scaleY: number

Defined in: mixins/factory/props.ts:33

Partial.scaleY


selection: Partial<ColorOptions>

Defined in: ui/Input.ts:182

Selection highlight configuration


optional style: Partial<Omit<TextStyleOptions, "fontFamily"> & object>

Defined in: mixins/factory/props.ts:139

Partial.style


optional text: string

Defined in: mixins/factory/props.ts:135

Partial.text


type: "number" | "text" | "password" | "email" | "tel" | "url"

Defined in: ui/Input.ts:160

Input type (text, password, number, etc.)


value: string

Defined in: ui/Input.ts:158

Initial value of the input


optional visible: boolean

Defined in: mixins/factory/props.ts:43

Partial.visible


optional x: number

Defined in: mixins/factory/props.ts:26

Partial.x


optional y: number

Defined in: mixins/factory/props.ts:27

Partial.y