Field

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

Field<ValueT,ParsableValueT = ValueT,SingleValueT = ValueT>

Hierarchy

API

Constructor

new Field(?options)

Arguments:

	Argument	Type	Description
	options An object with the properties below
	options.asyncChoices	AsyncChoicesInterface
	options.blank	boolean
	options.blankAsNull	boolean
	options.choices	\|[SingleValueT, string][]
	options.defaultValue	null\|ValueT\|
	options.formatterProps	Record
	options.helpText	string
	options.label	string
	options.readOnly	boolean
	options.widgetProps	Record
	options.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

model

ViewModelConstructor

name

string

readOnly

boolean

value

undefined|ValueT

widgetProps

Record

writeOnly

boolean

Static Properties

fieldClassName

null|string