Skip to content

@serenity-is/corelib / DateEditor

Class: DateEditor<P>

Extends

Type Parameters

P extends DateEditorOptions = DateEditorOptions

Implements

Constructors

new DateEditor()

new DateEditor<P>(props): DateEditor<P>

Parameters

props

EditorProps<P>

Returns

DateEditor<P>

Overrides

EditorWidget.constructor

Defined in

src/ui/editors/dateeditor.tsx:21

Properties

domNode

readonly domNode: HTMLInputElement

Overrides

EditorWidget.domNode

Defined in

src/ui/editors/dateeditor.tsx:19


idPrefix

readonly idPrefix: string

Inherited from

EditorWidget.idPrefix

Defined in

src/ui/widgets/widget.ts:16


options

protected readonly options: WidgetProps<EditorProps<P>>

Inherited from

EditorWidget.options

Defined in

src/ui/widgets/widget.ts:14


uniqueName

readonly uniqueName: string

Inherited from

EditorWidget.uniqueName

Defined in

src/ui/widgets/widget.ts:15


dateInputChange()

static dateInputChange: (e) => void

Parameters

e

Event

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:213


isComponent

readonly static isComponent: true = true

Inherited from

EditorWidget.isComponent

Defined in

src/ui/widgets/widget.ts:223


typeInfo

static typeInfo: ClassTypeInfo<"Serenity.EditorWidget">

Inherited from

EditorWidget.typeInfo

Defined in

src/ui/editors/editorwidget.ts:17


useFlatpickr

static useFlatpickr: boolean

Defined in

src/ui/editors/dateeditor.tsx:221

Accessors

element

Get Signature

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

EditorWidget.element

Defined in

src/ui/widgets/widget.ts:63


props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

EditorWidget.props

Defined in

src/ui/widgets/widget.ts:207


readOnly

Get Signature

get readOnly(): boolean

Returns

boolean

Set Signature

set readOnly(value): void

Parameters
value

boolean

Returns

void

Inherited from

EditorWidget.readOnly

Defined in

src/ui/editors/editorwidget.ts:23


value

Get Signature

get value(): string

Returns

string

Set Signature

set value(v): void

Parameters
v

string

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:110


valueAsDate

Get Signature

get valueAsDate(): Date

Returns

Date

Set Signature

set valueAsDate(v): void

Parameters
v

Date

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:137

Methods

addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

EditorWidget.addCssClass

Defined in

src/ui/widgets/widget.ts:67


addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters
rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

EditorWidget.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

Call Signature

addValidationRule(uniqueName, rule): void

Parameters
uniqueName

string

rule

(input) => string

Returns

void

Inherited from

EditorWidget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100


afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

EditorWidget.afterRender

Defined in

src/ui/widgets/widget.ts:146


byId()

protected byId<TElement>(id): Fluent<TElement>

Type Parameters

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

EditorWidget.byId

Defined in

src/ui/widgets/widget.ts:106


change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.change

Defined in

src/ui/widgets/widget.ts:118


changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.changeSelect2

Defined in

src/ui/widgets/widget.ts:122


createFlatPickrTrigger()

createFlatPickrTrigger(): HTMLElement

Returns

HTMLElement

Defined in

src/ui/editors/dateeditor.tsx:253


deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

EditorWidget.deferRender

Defined in

src/ui/widgets/widget.ts:71


destroy()

destroy(): void

Returns

void

Overrides

EditorWidget.destroy

Defined in

src/ui/editors/dateeditor.tsx:94


findById()

protected findById<TElement>(id): TElement

Type Parameters

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

EditorWidget.findById

Defined in

src/ui/widgets/widget.ts:110


get_maxDate()

get_maxDate(): Date

Returns

Date

Defined in

src/ui/editors/dateeditor.tsx:190


get_maxValue()

get_maxValue(): string

Returns

string

Defined in

src/ui/editors/dateeditor.tsx:174


get_minDate()

get_minDate(): Date

Returns

Date

Defined in

src/ui/editors/dateeditor.tsx:182


get_minValue()

get_minValue(): string

Returns

string

Defined in

src/ui/editors/dateeditor.tsx:166


get_readOnly()

get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/editors/dateeditor.tsx:153


get_sqlMinMax()

get_sqlMinMax(): boolean

Returns

boolean

Defined in

src/ui/editors/dateeditor.tsx:198


get_value()

get_value(): string

Returns

string

Implementation of

IStringValue.get_value

Defined in

src/ui/editors/dateeditor.tsx:101


getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

EditorWidget.getCssClass

Defined in

src/ui/widgets/widget.ts:75


getCustomAttribute()

protected getCustomAttribute<TAttr>(attrType, inherit): TAttr

Type Parameters

TAttr

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

EditorWidget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142


getFlatpickrOptions()

getFlatpickrOptions(input): any

Parameters

input

HTMLElement

Returns

any

Defined in

src/ui/editors/dateeditor.tsx:223


getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

EditorWidget.getGridField

Defined in

src/ui/widgets/widget.ts:114


init()

init(): this

Returns

this

Inherited from

EditorWidget.init

Defined in

src/ui/widgets/widget.ts:157


internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

EditorWidget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177


legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

EditorWidget.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194


render()

render(): any

Returns the main element for this widget or the document fragment. As widgets may get their elements from props unlike regular JSX widgets, this method should not be overridden. Override renderContents() instead.

Returns

any

Inherited from

EditorWidget.render

Defined in

src/ui/widgets/widget.ts:167


renderContents()

protected renderContents(): any

Returns

any

Inherited from

EditorWidget.renderContents

Defined in

src/ui/widgets/widget.ts:188


set_maxDate()

set_maxDate(value): void

Parameters

value

Date

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:194


set_maxValue()

set_maxValue(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:178


set_minDate()

set_minDate(value): void

Parameters

value

Date

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:186


set_minValue()

set_minValue(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:170


set_readOnly()

set_readOnly(value): void

Parameters

value

boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/editors/dateeditor.tsx:157


set_sqlMinMax()

set_sqlMinMax(value): void

Parameters

value

boolean

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:202


set_value()

set_value(value): void

Parameters

value

string

Returns

void

Implementation of

IStringValue.set_value

Defined in

src/ui/editors/dateeditor.tsx:114


setToToday()

setToToday(triggerChange?): void

Parameters

triggerChange?

boolean

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:89


syncOrAsyncThen()

protected syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void

Type Parameters

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

EditorWidget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211


useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

EditorWidget.useIdPrefix

Defined in

src/ui/widgets/widget.ts:218


create()

static create<TWidget, P>(params): TWidget

Type Parameters

TWidget extends Widget<P>

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

EditorWidget.create

Defined in

src/ui/widgets/widget.ts:130


createDefaultElement()

static createDefaultElement(): HTMLInputElement

Returns

HTMLInputElement

Overrides

EditorWidget.createDefaultElement

Defined in

src/ui/editors/dateeditor.tsx:18


dateInputKeyup()

static dateInputKeyup(e): void

Parameters

e

KeyboardEvent

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:217


getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

EditorWidget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95


uiPickerZIndexWorkaround()

static uiPickerZIndexWorkaround(el): void

Parameters

el

HTMLElement | ArrayLike<HTMLElement>

Returns

void

Defined in

src/ui/editors/dateeditor.tsx:259