Sunbelt Computer Software

A short label explaining to the user what this time input is for. The label can optionally contain GitHub-flavored Markdown of the following types: Bold, Italics, Strikethroughs, Inline Code, Links, and Images. Images display like icons, with a max height equal to the font height.

Unsupported Markdown elements are unwrapped so only their children (text contents) render. Common block-level Markdown (headings, lists, blockquotes) is automatically escaped and displays as literal text in labels.

See the body parameter of st.markdown for additional, supported Markdown directives.

For accessibility reasons, you should never set an empty label, but you can hide it with label_visibility if needed. In the future, we may disallow empty labels by raising an exception.

The value of this widget when it first renders. This can be one of the following:

• "now" (default): The widget initializes with the current time.
• A datetime.time or datetime.datetime object: The widget initializes with the given time, ignoring any date if included.
• An ISO-formatted time (hh:mm[:ss[.ffffff]]) or datetime (YYYY-MM-DD hh:mm[:ss]) string: The widget initializes with the given time, ignoring any date if included.
• None: The widget initializes with no time and returns None until the user selects a time.

Any seconds in the initial value are only preserved in the returned datetime.time when step is not a whole number of minutes (step % 60 != 0). With the default step, seconds are stripped from the initial value.

An optional string or integer to use as the unique key for the widget. If this is None (default), a key will be generated for the widget based on the values of the other parameters. No two widgets may have the same key. Assigning a key stabilizes the widget's identity and preserves its state across reruns even when other parameters change.

A key lets you read or update the widget's value via st.session_state[key]. For more details, see Widget behavior.

Additionally, if key is provided, it will be used as a CSS class name prefixed with st-key-.

A tooltip that gets displayed next to the widget label. Streamlit only displays the tooltip when label_visibility="visible". If this is None (default), no tooltip is displayed.

The tooltip can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the body parameter of st.markdown.

How the time input should respond to value changes. This controls whether or not Streamlit reruns the app when the user interacts with the time input. on_change can be one of the following:

• "rerun" (default): Streamlit will rerun the app when the user commits a new value (pressing Enter, blurring the field, pressing the up or down arrow keys, pasting a valid time, or clearing the value).
• "ignore": Streamlit will not rerun the app when the user commits a new value. The time input still updates in the UI. The new value is available on the next rerun triggered by something else, such as another widget interaction. Ignored commits are held in the browser and are lost if the page is refreshed before that rerun, unless bind="query-params" is set (see bind). Inside st.form, this has no effect: the form already defers all commits until submit.
• A callable: Streamlit will rerun the app and execute the callable as a callback function before the rest of the app.
• None: This is the same as on_change="rerun". This value exists for backwards compatibility and shouldn't be used.

An optional list or tuple of args to pass to the callback.

An optional dict of kwargs to pass to the callback.

An optional boolean that disables the time input if set to True. The default is False.

The visibility of the label. The default is "visible". If this is "hidden", Streamlit displays an empty spacer instead of the label, which can help keep the widget aligned with other widgets. If this is "collapsed", Streamlit displays no label or spacer.

Controls which time components are displayed in the widget. This defaults to 900 (15 minutes). You can also pass a datetime.timedelta object. The value must be between 1 second and 23 hours.

• If step is divisible by 60: hour and minute components are shown. Arrow keys snap to the nearest step boundary.
• Otherwise (step is not a whole number of minutes, i.e. step % 60 != 0): hour, minute, and second components are shown, and the returned datetime.time includes seconds. Arrow keys snap to the nearest step boundary across the full time value.

Any valid time may be entered regardless of the step value. Step does not restrict or snap the entered value.

Controls whether the hour is displayed in 12-hour or 24-hour format. Defaults to "24h".

• "24h" (default): hours are displayed from 0 to 23.
• "12h": hours are displayed from 1 to 12 with an AM/PM indicator.
• "localized": the format is determined by the user's browser locale (may be 12-hour or 24-hour depending on the locale).

The format setting is a display preference only and does not affect the returned datetime.time value, which always uses 24-hour representation.

The width of the time input widget. This can be one of the following:

• "stretch" (default): The width of the widget matches the width of the parent container.
• An integer specifying the width in pixels: The widget has a fixed width. If the specified width is greater than the width of the parent container, the width of the widget matches the width of the parent container.

Binding mode for syncing the widget's value with a URL query parameter. If this is None (default), the widget's value is not synced to the URL. When this is set to "query-params", changes to the widget update the URL, and the widget can be initialized or updated through a query parameter in the URL. This requires key to be set. The key is used as the query parameter name.

When the widget's value equals its default, the query parameter is removed from the URL to keep it clean. A bound query parameter can't be set or deleted through st.query_params; it can only be programmatically changed through st.session_state.

Times use HH:MM format in the URL (HH:MM:SS when step has a sub-minute component). Invalid query parameter values are ignored and removed from the URL. If value is None, an empty query parameter (e.g., ?my_key=) clears the widget.

When on_change="ignore", the URL is updated as soon as the value is committed (Enter, blur, arrow keys, pasting a valid time, or clearing the value); typing a segment alone does not update it. As with widgets inside a form, the URL can show a value that Python hasn't received yet. Python receives the new value on the next rerun, so a page load or share uses the updated URL value.

How long to preserve the widget's value when it isn't rendered. If this is None (default), the value is lost when the widget stops being rendered or the user switches pages. If this is "page", the value is preserved only while the user stays on the page where the widget is defined (for example, while the widget is conditionally hidden); it is discarded on a page switch and is not restored if the user returns to the page. If this is "session", the value is preserved for the entire session, including across page switches, so it returns when the user navigates back. This requires key to be set. If bind="query-params" is also set, the binding takes precedence: the value is stored in the URL, so it persists across page switches regardless of the persist_state scope.