Home Reference Source
import CalendarWidget from 'formiojs/src/widgets/CalendarWidget.js'
public class | source

CalendarWidget

Extends:

src/Element.js~ElementInputWidget → CalendarWidget

Static Member Summary

Static Public Members
public static get

defaultSettings: {"type": string, "altInput": boolean, "allowInput": boolean, "clickOpens": boolean, "enableDate": boolean, "enableTime": boolean, "mode": string, "noCalendar": *, "format": *, "dateFormat": *, "useLocaleSettings": *, "language": string, "hourIncrement": number, "minuteIncrement": number, "time_24hr": *, "saveAs": string, "displayInTimezone": *, "timezone": *, "disable": *, "minDate": *, "maxDate": *}

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public
public get
public get
public

defaultFormat: {"date": *, "time": string}

public get
public get
public get
public get
public set
public get
public get
public get

input: *

public get
public get
public
public

Method Summary

Public Methods
public

addSuffix(suffix: *): *

public

attach(input: *): *

public
public

getDateValue(date: *, format: *): string

Return the date value.

public

getValue(): *

Return the value of the selected date.

public

getValueAsString(value: *, format: *): *

public

Load the timezones.

public

setPlaceholder(input: *)

public

setValue(value: *): *

Set the selected date value.

public

validationValue(value: *): *

Inherited Summary

From class InputWidget
public static get

defaultSettings: {"type": string}

public get
public set
public get

input: *

public
public
public
private

_input: *

public

addPrefix(): *

public

addSuffix(): *

public

attach(input: *): *

public

getValue(): *

public

getValueAsString(value: *): *

public

setValue(value: *)

public

validationValue(value: *): *

Static Public Members

public static get defaultSettings: {"type": string, "altInput": boolean, "allowInput": boolean, "clickOpens": boolean, "enableDate": boolean, "enableTime": boolean, "mode": string, "noCalendar": *, "format": *, "dateFormat": *, "useLocaleSettings": *, "language": string, "hourIncrement": number, "minuteIncrement": number, "time_24hr": *, "saveAs": string, "displayInTimezone": *, "timezone": *, "disable": *, "minDate": *, "maxDate": *} source

Override:

InputWidget#defaultSettings

Public Constructors

public constructor() source

Override:

InputWidget#constructor

Public Members

public calendar: * source

public closedOn: number source

public get dateFormat: * source

public get dateTimeFormat: * source

public defaultFormat: {"date": *, "time": string} source

public get defaultSettings: * source

Override:

InputWidget#defaultSettings

public get disableFunction: * source

public get disableWeekdays: * source

public get disableWeekends: * source

public set disabled source

Override:

InputWidget#disabled

public get disabledDates: *[] source

public get flatpickrType: string source

public get input: * source

Override:

InputWidget#input

public get localeFormat: * source

public get timezone: * source

public valueFormat: * source

public valueMomentFormat: * source

Public Methods

public addSuffix(suffix: *): * source

Override:

InputWidget#addSuffix

Params:

NameTypeAttributeDescription
suffix *

Return:

*

public attach(input: *): * source

Override:

InputWidget#attach

Params:

NameTypeAttributeDescription
input *

Return:

*

public destroy() source

public getDateValue(date: *, format: *): string source

Return the date value.

Params:

NameTypeAttributeDescription
date *
format *

Return:

string

public getValue(): * source

Return the value of the selected date.

Override:

InputWidget#getValue

Return:

*

public getValueAsString(value: *, format: *): * source

Override:

InputWidget#getValueAsString

Params:

NameTypeAttributeDescription
value *
format *

Return:

*

public loadZones(): boolean source

Load the timezones.

Return:

boolean

TRUE if the zones are loading, FALSE otherwise.

public setPlaceholder(input: *) source

Params:

NameTypeAttributeDescription
input *

public setValue(value: *): * source

Set the selected date value.

Override:

InputWidget#setValue

Params:

NameTypeAttributeDescription
value *

Return:

*

public validationValue(value: *): * source

Override:

InputWidget#validationValue

Params:

NameTypeAttributeDescription
value *

Return:

*