NumberField

import { NumberField } from "@prestojs/viewmodel";

NumberField<ValueT = string|number,ParsableValueT = ValueT>

Hierarchy

Field<ValueT,ParsableValueT>
NumberField
DecimalField
FloatField
IntegerField

Examples

Default widget in a Form

Default formatter for NumberField

API

Show inherited

Constructor

new NumberField(?values)

Arguments:

	Argument	Type	Description
	values An object with the properties below
	values.asyncChoices	AsyncChoicesInterface
	values.blank	boolean
	values.blankAsNull	boolean
	values.choices	\|[ValueT, string][]
	values.defaultValue	null\|ValueT\|
	values.formatterProps	Record
	values.helpText	string
	values.label	string
	values.maxValue	string\|number
	values.minValue	string\|number
	values.readOnly	boolean
	values.widgetProps	Record
	values.writeOnly	boolean

Methods

clone()

Returns:Field

contributeToClass(viewModel)

Arguments:

	Argument	Type	Description
*	viewModel	ViewModelConstructor

Returns:void

format(value)

Arguments:

	Argument	Type	Description
*	value	ValueT

Returns:any

getFormatterProps()

Returns:{[fieldName: string]: any }

getWidgetProps()

Returns:{[fieldName: string]: any }

isEqual(?value1,?value2)

Arguments:

	Argument	Type	Description
	value1	ValueT
	value2	ValueT

Returns:boolean

normalize(value)

Arguments:

	Argument	Type	Description
*	value	ParsableValueT

Returns:null|ValueT

parse(value)

Arguments:

	Argument	Type	Description
*	value	null\|ParsableValueT

Returns:null|ValueT

toJS(value)

Arguments:

	Argument	Type	Description
*	value	ValueT

Returns:null|string|number|Record

toString()

Returns:string

Properties

asyncChoices

AsyncChoicesInterface

blank

boolean

blankAsNull

boolean

boundRecord

undefined|ViewModelInterface

choices

defaultValue

undefined|null|ValueT|Promise

formatterProps

Record

helpText

string

isBound

boolean

label

string

maxValue

string|number

minValue

string|number

model

ViewModelConstructor

name

string

readOnly

boolean

value

undefined|ValueT

widgetProps

Record

writeOnly

boolean

Static Properties

fieldClassName

string