GitHub

Reference headless

numberField

interface 3 type 4 function 1
interface Interfaces 3
interface number-field/index.ts · L70

# CreateNumberFieldOptions

Members

defaultValue?
optional defaultValue?: number | null

###### Inherited from

CreateNumberFieldInput.defaultValue

disabled?
optional disabled?: boolean

###### Inherited from

CreateNumberFieldInput.disabled

format?
optional format?: (value) => string

Optional formatter. Receives the numeric value (never null) and returns the string to display in the input. Defaults to String(n).

###### Parameters

###### value

number

###### Returns

string

id?
optional id?: string
max?
optional max?: number

###### Inherited from

CreateNumberFieldInput.max

min?
optional min?: number

###### Inherited from

CreateNumberFieldInput.min

onValueChange?
optional onValueChange?: (value) => void

###### Parameters

###### value

number | null

###### Returns

void

pageStep?
optional pageStep?: number

PageUp/PageDown step. Default = step * 10.

###### Inherited from

CreateNumberFieldInput.pageStep

parse?
optional parse?: (raw) => number | null | undefined

Optional parser. Receives the raw input string and returns a number, null (cleared), or undefined (rejected — keep prior value). Defaults to a permissive Number(...) after stripping common separators.

###### Parameters

###### raw

string

###### Returns

number | null | undefined

step?
optional step?: number

###### Inherited from

CreateNumberFieldInput.step

interface

# NumberFieldContext

Members

max
max: number
min
min: number
pageStep
pageStep: number
step
step: number
value
value: number | null
interface number-field/index.ts · L35

# NumberFieldController

Members

context
readonly context: Readonly<NumberFieldContext>
decrement\_
readonly decrement_: Attachment
disabled
readonly disabled: boolean
id
readonly id: string
increment\_
readonly increment_: Attachment
input
readonly input: Attachment
inputId
readonly inputId: string
machine
readonly machine: NumberFieldMachine
root
readonly root: Attachment
state
readonly state: NumberFieldState
value
readonly value: number | null
clear()
clear(): void

###### Returns

void

decrement()
decrement(): void

###### Returns

void

increment()
increment(): void

###### Returns

void

pageDecrement()
pageDecrement(): void

###### Returns

void

pageIncrement()
pageIncrement(): void

###### Returns

void

setDisabled()
setDisabled(value): void

###### Parameters

###### value

boolean

###### Returns

void

setMax()
setMax(value): void

###### Parameters

###### value

number

###### Returns

void

setMin()
setMin(value): void

###### Parameters

###### value

number

###### Returns

void

setPageStep()
setPageStep(value): void

###### Parameters

###### value

number

###### Returns

void

setStep()
setStep(value): void

###### Parameters

###### value

number

###### Returns

void

setValue()
setValue(value): void

###### Parameters

###### value

number | null

###### Returns

void

subscribe()
subscribe(listener): () => void

###### Parameters

###### listener

(snapshot) => void

###### Returns

() => void

toMax()
toMax(): void

###### Returns

void

toMin()
toMin(): void

###### Returns

void

type Type Aliases 4
type number-field/index.ts · L33

# Attachment

Attachment = (node) => void | (() => void)

Parameters

node
HTMLElement

Returns

void | (() => void)
type

# NumberFieldEvent

NumberFieldEvent = { type: "INCREMENT"; } | { type: "DECREMENT"; } | { type: "PAGE_INCREMENT"; } | { type: "PAGE_DECREMENT"; } | { type: "TO_MIN"; } | { type: "TO_MAX"; } | { type: "CLEAR"; } | { type: "SET.VALUE"; value: number | null; } | { type: "SET.MIN"; value: number; } | { type: "SET.MAX"; value: number; } | { type: "SET.STEP"; value: number; } | { type: "SET.PAGE_STEP"; value: number; } | { type: "DISABLE"; } | { type: "ENABLE"; }
type

# NumberFieldState

NumberFieldState = "idle" | "disabled"
function Functions 1