Skip to main content

Interface: Datepicker

Description​

Allows users to select a date from a calendar style UI.

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?​

optional initial_date: string;

Description​

The initial date that is selected when the element is loaded. This should be in the format YYYY-MM-DD.

Defined in​

block-kit/block-elements.ts:101

placeholder?​

optional placeholder: PlainTextElement;

Description​

A PlainTextElement object that defines the placeholder text shown on the element. Maximum length for the text field in this object is 150 characters.

Inherited from​

Placeholdable.placeholder

Defined in​

block-kit/extensions.ts:57

type​

type: "datepicker";

Description​

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

Overrides​

Actionable.type

Defined in​

block-kit/block-elements.ts:96