CharField

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

Hierarchy

Examples

Default widget in a Form

Default formatter for CharField

API

Show inherited

Constructor

new CharField(?values)

Arguments:

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

Returns:any

getFormatterProps()

Returns:{[fieldName: string]: any }

getWidgetProps()

Returns:

An object with these properties:
	Property	Type	Description
	maxLength	number

isEqual(?value1,?value2)

Arguments:

	Argument	Type	Description
	value1	string
	value2	string

Returns:boolean

normalize(value)

Arguments:

	Argument	Type	Description
*	value	string

Returns:null|string

parse(value)

Arguments:

	Argument	Type	Description
*	value	null\|string

Returns:null|string

toJS(value)

Arguments:

	Argument	Type	Description
*	value	string

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

maxLength

number

model

ViewModelConstructor

name

string

readOnly

boolean

value

undefined|ValueT

widgetProps

Record

writeOnly

boolean

Static Properties

fieldClassName

string