Interface: Timepicker
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
- Time picker element reference.
- This is an interactive component - see our guide to enabling interactivity.
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
Defined in
confirm?
optional confirm: ConfirmationDialog;
Description
A Confirm object that defines an optional confirmation dialog after the element is interacted with.
Inherited from
Defined in
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
Defined in
initial_time?
optional initial_time: string;
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.
Defined in
block-kit/block-elements.ts:599
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
Defined in
timezone?
optional timezone: string;
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.
Defined in
block-kit/block-elements.ts:604
type
type: "timepicker";
Description
The type of element. In this case type is always timepicker.