Skip to main content

Interface: DateTimepicker

Description

Allows users to select both a date and a time of day, formatted as a Unix timestamp. On desktop clients, this time picker will take the form of a dropdown list and the date picker will take the form of a dropdown calendar. Both options will have free-text entry for precise choices. On mobile clients, the time picker and date picker will use native UIs.

See

Extends

Properties

action_id?

optional action_id: string;

@description: An identifier for this action. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids in the containing block. Maximum length for this field is 255 characters.

Inherited from

Actionable.action_id

Defined in

block-kit/extensions.ts:15


confirm?

optional confirm: ConfirmationDialog;

Description

A Confirm object that defines an optional confirmation dialog after the element is interacted with.

Inherited from

Confirmable.confirm

Defined in

block-kit/extensions.ts:25


focus_on_load?

optional focus_on_load: boolean;

Description

Indicates whether the element will be set to auto focus within the view object. Only one element can be set to true. Defaults to false.

Inherited from

Focusable.focus_on_load

Defined in

block-kit/extensions.ts:42


initial_date_time?

optional initial_date_time: number;

Description

The initial date and time that is selected when the element is loaded, represented as a UNIX timestamp in seconds. This should be in the format of 10 digits, for example 1628633820 represents the date and time August 10th, 2021 at 03:17pm PST.

Defined in

block-kit/block-elements.ts:122


type

type: "datetimepicker";

Description

The type of element. In this case type is always datetimepicker.

Overrides

Actionable.type

Defined in

block-kit/block-elements.ts:116