# Source: https://docs.streamlit.io/develop/api-reference/data/st.column_config/st.column_config.checkboxcolumn

# 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.

## Examples

```python
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,
)
```

## Parameters

- **label**: (str or None)
  - The label shown at the top of the column. If this is `None` (default), the column name is used.

- **width**: ("small", "medium", "large", int, or None)
  - The display width of the column. If this is `None` (default), the column will be sized to fit the cell contents. Otherwise, this can be one of the following:
    - `"small"`: 75px wide
    - `"medium"`: 200px wide
    - `"large"`: 400px wide
    - An integer specifying the width in pixels

  If the total width of all columns is less than the width of the dataframe, the remaining space will be distributed evenly among all columns.

- **help**: (str or None)
  - A tooltip that gets displayed when hovering over the column label. 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`.

- **disabled**: (bool or None)
  - Whether editing should be disabled for this column. If this is `None` (default), Streamlit will enable editing wherever possible.

  If a column has mixed types, it may become uneditable regardless of `disabled`.

- **required**: (bool or None)
  - Whether edited cells in the column need to have a value. If this is `False` (default), the user can submit empty values for this column. If this is `True`, an edited cell in this column can only be submitted if its value is not `None`, and a new row will only be submitted after the user fills in this column.

- **pinned**: (bool or None)
  - Whether the column is pinned. A pinned column will stay visible on the left side no matter where the user scrolls. If this is `None` (default), Streamlit will decide: index columns are pinned, and data columns are not pinned.

- **default**: (bool or None)
  - Specifies the default value in this column when a new row is added by the user. This defaults to `None`.

## Returns

- (None)

## Source

https://github.com/streamlit/streamlit/blob/1.52.0/lib/streamlit/elements/lib/column_types.py#L892