st.column_config.DatetimeColumn

Configure a datetime column in st.dataframe or st.data_editor.

This is the default column type for datetime values. This command needs to be used in the column_config parameter of st.dataframe or st.data_editor. When used with st.data_editor, editing will be enabled with a datetime picker widget.

Function signature[source]

st.column_config.DatetimeColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None, format=None, min_value=None, max_value=None, step=None, timezone=None)

Parameters

label (str or None)

The label shown at the top of the column. If None (default), the column name is used.

width ("small", "medium", "large", or None)

The display width of the column. Can be one of "small", "medium", or "large". If None (default), the column will be sized to fit the cell contents.

help (str or None)

An optional tooltip that gets displayed when hovering over the column label.

disabled (bool or None)

Whether editing should be disabled for this column. Defaults to False.

required (bool or None)

Whether edited cells in the column need to have a value. If True, an edited cell can only be submitted if it has a value other than None. Defaults to False.

default (datetime.datetime or None)

Specifies the default value in this column when a new row is added by the user.

format (str or None)

A momentJS format string controlling how datetimes are displayed. See momentJS docs for available formats. If None (default), uses YYYY-MM-DD HH:mm:ss.

Number formatting from column_config always takes precedence over number formatting from pandas.Styler.

min_value (datetime.datetime or None)

The minimum datetime that can be entered. If None (default), there will be no minimum.

max_value (datetime.datetime or None)

The maximum datetime that can be entered. If None (default), there will be no maximum.

step (int, float, datetime.timedelta, or None)

The stepping interval in seconds. If None (default), the step will be 1 second.

timezone (str or None)

The timezone of this column. If None (default), the timezone is inferred from the underlying data.

Examples

from datetime import datetime
import pandas as pd
import streamlit as st

data_df = pd.DataFrame(
    {
        "appointment": [
            datetime(2024, 2, 5, 12, 30),
            datetime(2023, 11, 10, 18, 0),
            datetime(2024, 3, 11, 20, 10),
            datetime(2023, 9, 12, 3, 0),
        ]
    }
)

st.data_editor(
    data_df,
    column_config={
        "appointment": st.column_config.DatetimeColumn(
            "Appointment",
            min_value=datetime(2023, 6, 1),
            max_value=datetime(2025, 1, 1),
            format="D MMM YYYY, h:mm a",
            step=60,
        ),
    },
    hide_index=True,
)
Built with Streamlit 🎈
Previous: Selectbox columnNext: Date column
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.