---
title: "Timepicker"
summary: "@slack/web-api / Timepicker"
url: "https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/Timepicker"
type: "guide"
---

Source: https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/Timepicker

[@slack/web-api](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api.md) / Timepicker

# Interface: Timepicker

Defined in: packages/types/dist/block-kit/block-elements.d.ts:586

## Description {#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 {#see}

*   [Time picker element reference](https://docs.slack.dev/reference/block-kit/block-elements/time-picker-element.md).
*   [This is an interactive component - see our guide to enabling interactivity](https://docs.slack.dev/interactivity/handling-user-interaction.md).

## Extends {#extends}

*   [`Actionable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md).[`Confirmable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/confirmable.md).[`Focusable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/focusable.md).[`Placeholdable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/placeholdable.md)

## Properties {#properties}

### action_id? {#action_id}

```
optional action_id?: string;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:12

@description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction.md#payloads). Should be unique among all other `action_id`s in the containing block. Maximum length for this field is 255 characters.

#### Inherited from {#inherited-from}

[`Actionable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md).[`action_id`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md#action_id)

* * *

### confirm? {#confirm}

```
optional confirm?: ConfirmationDialog;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:21

#### Description {#description-1}

A [Confirm](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/confirm.md) object that defines an optional confirmation dialog after the element is interacted with.

#### Inherited from {#inherited-from-1}

[`Confirmable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/confirmable.md).[`confirm`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/confirmable.md#confirm)

* * *

### focus_on_load? {#focus_on_load}

```
optional focus_on_load?: boolean;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:36

#### Description {#description-2}

Indicates whether the element will be set to auto focus within the [\`view\` object](https://docs.slack.dev/surfaces/modals.md). Only one element can be set to `true`. Defaults to `false`.

#### Inherited from {#inherited-from-2}

[`Focusable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/focusable.md).[`focus_on_load`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/focusable.md#focus_on_load)

* * *

### initial_time? {#initial_time}

```
optional initial_time?: string;
```

Defined in: packages/types/dist/block-kit/block-elements.d.ts:596

#### Description {#description-3}

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? {#placeholder}

```
optional placeholder?: PlainTextElement;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:49

#### Description {#description-4}

A [PlainTextElement](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/plaintextelement.md) object that defines the placeholder text shown on the element. Maximum length for the `text` field in this object is 150 characters.

#### Inherited from {#inherited-from-3}

[`Placeholdable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/placeholdable.md).[`placeholder`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/placeholdable.md#placeholder)

* * *

### timezone? {#timezone}

```
optional timezone?: string;
```

Defined in: packages/types/dist/block-kit/block-elements.d.ts:601

#### Description {#description-5}

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}

```
type: "timepicker";
```

Defined in: packages/types/dist/block-kit/block-elements.d.ts:590

#### Description {#description-6}

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

#### Overrides {#overrides}

[`Actionable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md).[`type`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md#type)