🌲 Streamlit Checkbox Tree

A simple checkbox tree component for Streamlit, forked from streamlit_tree_selector, built on react-checkbox-tree.

Installation

pip install st-checkbox-tree

Quick start

Using st-checkbox-tree is as simple as importing checkbox_tree and passing a list of nodes.

import streamlit as st
from st_checkbox_tree import checkbox_tree

st.title("🌲 Streamlit Checkbox Tree")

# Create nodes to display
nodes = [
    {"label": "Folder A", "value": "folder_a"},
    {
        "label": "<b> Folder B </b>",
        "value": "<u> folder_b </u>",
        "children": [
            {"label": "Sub-folder A", "value": "sub_a"},
            {"label": "Sub-folder B", "value": "sub_b"},
            {"label": "Sub-folder C", "value": "sub_c"},
        ],
    },
    {
        "label": "Folder C",
        "value": "folder_c",
        "children": [
            {"label": "Sub-folder D", "value": "sub_d"},
            {
                "label": "Sub-folder E",
                "value": "sub_e",
                "children": [
                    {"label": "Sub-sub-folder A", "value": "sub_sub_a"},
                    {"label": "Sub-sub-folder B", "value": "sub_sub_b"},
                ],
            },
            {"label": "Sub-folder F", "value": "sub_f"},
        ],
    },
]

return_select = checkbox_tree(nodes)
st.write(return_select)

Parameters

Returns

checkbox_tree returns a dictionary containing the keys checked node values as well as expanded node values.