DateRangeField

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

Hierarchy

RangeField<Date,string|Date>
DateRangeField

Examples

Default widget in a Form

Default formatter for DateRangeField

API

Show inherited

Constructor

new DateRangeField(?props)

Arguments:

	Argument	Type	Description
	props An object with the properties below
	props.blank	boolean
	props.blankAsNull	boolean
	props.boundsFieldProps
	props.defaultValue	null\|ValueT\|
	props.formatterProps	Record
	props.helpText	string
	props.label	string
	props.readOnly	boolean
	props.widgetProps	Record
	props.writeOnly	boolean

Methods

clone()

Returns:Field

contributeToClass(viewModel)

Arguments:

	Argument	Type	Description
*	viewModel	ViewModelConstructor

Returns:void

format(value)

Arguments:

	Argument	Type	Description
*	value

Returns:any

getFormatterProps()

Returns:{[fieldName: string]: any }

getWidgetProps()

Returns:{[fieldName: string]: any }

isEqual(?value1,?value2)

Arguments:

	Argument	Type	Description
	value1
	value2

Returns:boolean

normalize(value)

Arguments:

	Argument	Type	Description
*	value

Returns:null|

An object with these properties:
	Property	Type	Description
*	lower	T
*	upper	T

parse(value)

Arguments:

	Argument	Type	Description
*	value	null\|

Returns:null|

An object with these properties:
	Property	Type	Description
*	lower	T
*	upper	T

toJS(value)

Arguments:

	Argument	Type	Description
*	value

Returns:null|string|number|Record

toString()

Returns:string

Properties

asyncChoices

AsyncChoicesInterface

blank

boolean

blankAsNull

boolean

boundRecord

undefined|ViewModelInterface

boundsField

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

string