Skip to main content

Interface: Timepicker

Defined in: block-kit/block-elements.ts:589

Description​

Allows users to choose a time from a rich dropdown UI. On desktop clients, this time picker will take the form of a dropdown list with free-text entry for precise choices. On mobile clients, the time picker will use native time picker UIs.

See​

Extends​

Properties​

action_id?​

optional action_id: string;

Defined in: block-kit/extensions.ts:15

@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

confirm?​

optional confirm: ConfirmationDialog;

Defined in: block-kit/extensions.ts:25

Description​

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

Inherited from​

Confirmable.confirm

focus_on_load?​

optional focus_on_load: boolean;

Defined in: block-kit/extensions.ts:42

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

initial_time?​

optional initial_time: string;

Defined in: block-kit/block-elements.ts:599

Description​

The initial time that is selected when the element is loaded. This should be in the format HH:mm, where HH is the 24-hour format of an hour (00 to 23) and mm is minutes with leading zeros (00 to 59), for example 22:25 for 10:25pm.

placeholder?​

optional placeholder: PlainTextElement;

Defined in: block-kit/extensions.ts:57

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

timezone?​

optional timezone: string;

Defined in: block-kit/block-elements.ts:604

Description​

A string in the IANA format, e.g. 'America/Chicago'. The timezone is displayed to end users as hint text underneath the time picker. It is also passed to the app upon certain interactions, such as view_submission.

type​

type: "timepicker";

Defined in: block-kit/block-elements.ts:593

Description​

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

Overrides​

Actionable.type