Presto

BooleanField

Source
import { BooleanField } from "@prestojs/viewmodel";
Hierarchy

Examples

Default widget in a Form

Default formatter for BooleanField

API

Constructor

new BooleanField(?options)

Arguments:

ArgumentTypeDescription
options
An object with the properties below
options.asyncChoicesAsyncChoicesInterface
options.blankboolean
options.blankAsNullboolean
options.choices|[boolean, string][]
options.defaultValuenull|boolean|
options.formatterPropsRecord
options.helpTextstring
options.labelstring
options.readOnlyboolean
options.widgetPropsRecord
options.writeOnlyboolean

Methods

clone()
Returns:Field
contributeToClass(viewModel)

Arguments:

ArgumentTypeDescription
*viewModelViewModelConstructor
Returns:void
format(value)

Arguments:

ArgumentTypeDescription
*valueboolean
Returns:any
getFormatterProps()
Returns:{[fieldName: string]: any }
getWidgetProps()
Returns:{[fieldName: string]: any }
isEqual(value1,value2)

Arguments:

ArgumentTypeDescription
*value1boolean
*value2boolean
Returns:boolean
normalize(value)

Arguments:

ArgumentTypeDescription
*valueboolean
Returns:null|boolean
parse(value)

Arguments:

ArgumentTypeDescription
*valueany
Returns:boolean
toJS(value)

Arguments:

ArgumentTypeDescription
*valueboolean
Returns:null|string|number|Record
toString()
Returns:string

Properties

asyncChoices

Source
AsyncChoicesInterface

blank

Source
boolean

blankAsNull

Source
boolean

boundRecord

Source
undefined|ViewModelInterface

choices

Source

defaultValue

Source
undefined|null|boolean|Promise

formatterProps

Source
Record

helpText

Source
string

isBound

Source
boolean

label

Source
string

model

Source
ViewModelConstructor

name

Source
string

readOnly

Source
boolean

value

Source
undefined|boolean

widgetProps

Source
Record

writeOnly

Source
boolean

Static Properties

fieldClassName

Source
string