# TimePicker

## Time Picker

### Introduction

**`TimePicker`** is a widget in Supervisely that allows to select time input.

### Function signature

```python
TimePicker(
    start="09:00",
    step="00:15",
    end="22:30",
    placeholder=None,
    size=None,
    readonly=False,
    disabled=False,
    editable=True,
    clearable=True,
    widget_id=None,
)
```

![time\_picker\_default](https://user-images.githubusercontent.com/120389559/226362544-665389df-e819-4bc2-908c-8b1b6effaf84.gif)

### Parameters

|   Parameters  |                    Type                   |            Description            |
| :-----------: | :---------------------------------------: | :-------------------------------: |
|    `value`    |                   `str`                   |         `TimePicker` value        |
|    `start`    |                   `str`                   |             Start time            |
|     `step`    |                   `str`                   |             Time step             |
|     `end`     |                   `str`                   |              End time             |
| `placeholder` |                   `str`                   |      `TimePicker` placeholder     |
|     `size`    | `Literal["large", "small", "mini", None]` |           Size of input           |
|   `readonly`  |                   `bool`                  | Whether `TimePicker` is read only |
|   `disabled`  |                   `bool`                  |  Whether `TimePicker` is disabled |
|   `editable`  |                   `bool`                  |   Whether the input is editable   |
|  `clearable`  |                   `bool`                  |    Whether to show clear button   |
|  `widget_id`  |                   `str`                   |          ID of the widget         |

#### start

Determine `TimePicker` start time.

**type:** `str`

**default value:** `"09:00"`

#### step

Determine `TimePicker` time step.

**type:** `str`

**default value:** `"00:15"`

#### end

Determine `TimePicker` end time.

**type:** `str`

**default value:** `"22:30"`

```python
time_picker = TimePicker(start="06:30", step="00:30", end="15:00")
```

![start\_step\_end](https://user-images.githubusercontent.com/120389559/226368722-3419a5fc-7a7d-401b-8084-0138209007ce.gif)

#### placeholder

Determine `TimePicker` placeholder.

**type:** `str`

**default value:** `None`

```python
time_picker = TimePicker(placeholder="Select time")
```

![placeholder](https://user-images.githubusercontent.com/120389559/226362933-1da5a4c1-d9a6-4ba3-85d2-831afb42e074.png)

#### size

Determine `TimePicker` size of input.

**type:** `Literal["large", "small", "mini", None]`

**default value:** `None`

```python
text = Text()
time_picker = TimePicker()
time_picker_mini = TimePicker(size="mini")
time_picker_small = TimePicker(size="small")
time_picker_large = TimePicker(size="large")
```

![size](https://user-images.githubusercontent.com/120389559/226363690-95e2def4-9154-44ef-8469-f0b4132e76e1.png)

#### readonly

Determine whether `TimePicker` is read only.

**type:** `bool`

**default value:** `False`

```python
time_picker = TimePicker(readonly=True)
```

![readonly](https://user-images.githubusercontent.com/120389559/226364643-d1f00154-accb-461f-a26a-971fa3a103e2.gif)

#### editable

Determine whether the input is editable.

**type:** `bool`

**default value:** `True`

#### clearable

Determine whether to show a clear button.

**type:** `bool`

**default value:** `True`

#### widget\_id

ID of the widget.

**type:** `str`

**default value:** `None`

### Methods and attributes

|  Attributes and Methods | Description                                      |
| :---------------------: | ------------------------------------------------ |
|      `set_value()`      | Set `TimePicker` current value.                  |
|      `get_value()`      | Return `TimePicker` current value.               |
|  `get_picker_options()` | Return `TimePicker` options(start, step, end).   |
| `set_start(value: str)` | Set `TimePicker` start time.                     |
|  `set_end(value: str)`  | Set `TimePicker` time step.                      |
|  `set_step(value: str)` | Set `TimePicker` end time.                       |
|     `@value_changed`    | Decorator function to handle `TimePicker` click. |

## Mini App Example

You can find this example in our Github repository:

[supervisely-ecosystem/ui-widgets-demos/input/008\_time\_picker/src/main.py](https://github.com/supervisely-ecosystem/ui-widgets-demos/blob/master/input/008_time_picker/src/main.py)

### Import libraries

```python
import os

import supervisely as sly
from dotenv import load_dotenv
from supervisely.app.widgets import Card, Container, Text, TimePicker
```

### Init API client

First, we load environment variables with credentials and init API for communicating with Supervisely Instance:

```python
load_dotenv("local.env")
load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api()
```

### Initialize `TimePicker` and `Text` widgets

```python
time_picker = TimePicker()

text = Text()
```

### Create app layout

Prepare a layout for app using `Card` widget with the `content` parameter.

```python
card = Card(
    "Time Picker",
    content=Container([time_picker, text]),
)
layout = Container(widgets=[card])
```

### Create app using layout

Create an app object with layout parameter.

```python
app = sly.Application(layout=card)
```

### Add functions to control widgets from python code

```python
@time_picker.value_changed
def show_time(res):
    info = f"Selected time: {res}"
    text.set(text=info, status="info")
```

<div align="center"><img src="https://user-images.githubusercontent.com/120389559/226366974-06d6fde5-11cc-4cdf-b743-93bf378b67fa.gif" alt=""></div>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.supervisely.com/app-development/widgets/input/timepicker.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.