Skip to main content

Interface: DateInput

Defined in: extensions/features/date-input.ts:18

What the inline editor mounts in a date cell.

Properties​

element​

readonly element: HTMLElement

Defined in: extensions/features/date-input.ts:20

The control to mount in the cell.


showsTimeOfDay​

readonly showsTimeOfDay: boolean

Defined in: extensions/features/date-input.ts:23

Does the control show a time of day? A control that shows none gets the date-only end rule on end. It opens on the last covered day. A typed day stores the start of the next day.

Methods​

destroy()​

destroy(): void

Defined in: extensions/features/date-input.ts:30

Returns​

void


onCommit()​

onCommit(handler): Disposer

Defined in: extensions/features/date-input.ts:29

The editor calls this to learn when the user is done (Enter, or the control's own commit).

Parameters​

handler​

() => void

Returns​

Disposer


read()​

read(): Instant | undefined

Defined in: extensions/features/date-input.ts:25

Reads what the user entered, in the dataset's zone. undefined means "not a date".

Returns​

Instant | undefined


write()​

write(at): void

Defined in: extensions/features/date-input.ts:27

Called when the editor opens.

Parameters​

at​

Instant

Returns​

void