st.column_config.CheckboxColumn

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

This is the default column type for boolean 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 checkbox widget.

Function signature[source]

st.column_config.CheckboxColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=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 (bool or None)

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

Examples

import pandas as pd
import streamlit as st

data_df = pd.DataFrame(
    {
        "widgets": ["st.selectbox", "st.number_input", "st.text_area", "st.button"],
        "favorite": [True, False, False, True],
    }
)

st.data_editor(
    data_df,
    column_config={
        "favorite": st.column_config.CheckboxColumn(
            "Your favorite?",
            help="Select your **favorite** widgets",
            default=False,
        )
    },
    disabled=["widgets"],
    hide_index=True,
)
Built with Streamlit 🎈
Previous: Number columnNext: Selectbox column
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.