Skip to content

✔️  To-do items

Submitted by Arnaud Miribel

Summary

Simple Python function to create to-do items in Streamlit!

Functions

_to_do

Source code in src/streamlit_extras/stodo/__init__.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@extra
def _to_do(
    label: str,
    key: str,
    bind: Literal["query-params"] | None = None,
) -> bool:
    with st.container(horizontal=True, vertical_alignment="top"):
        return st.checkbox(
            label=label,
            label_visibility="collapsed",
            width="stretch",
            bind=bind,
            key=key,
        )

Import:

from streamlit_extras.stodo import _to_do # (1)!
  1. You should add this to the top of your .py file 🛠

to_do

Create a to_do item

Parameters:

Name Type Description Default
st_commands _type_

List of (cmd, args) where cmd is a streamlit command and args are the arguments of the command

 required
checkbox_id str

Use as a key to the checkbox

 required

Returns:

Name Type Description
None bool

Prints the to do list
Source code in src/streamlit_extras/stodo/__init__.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@extra
def to_do(st_commands: Sequence[Sequence[Any]], checkbox_id: str) -> bool:
    """Create a to_do item

    Args:
        st_commands (_type_): List of (cmd, args) where cmd is a
            streamlit command and args are the arguments of the command
        checkbox_id (str): Use as a key to the checkbox

    Returns:
        None: Prints the to do list
    """
    cols = st.columns((1, 20), vertical_alignment="bottom")
    done = cols[0].checkbox(" ", key=checkbox_id)
    if done:
        for cmd, *args in st_commands:
            with cols[1]:
                if cmd == st.write:
                    text = args[0]
                    cols[1].write(
                        f"<s style='color: rgba(49, 51, 63, 0.4)'> {text} </s>",
                        unsafe_allow_html=True,
                    )
                elif cmd in (
                    st.slider,
                    st.button,
                    st.checkbox,
                    st.time_input,
                    st.color_picker,
                    st.selectbox,
                    st.camera_input,
                    st.radio,
                    st.date_input,
                    st.multiselect,
                    st.text_area,
                    st.text_input,
                ):
                    cmd(*args, disabled=True)
                else:
                    cmd(*args)

    else:
        for cmd, *args in st_commands:
            with cols[1]:
                if cmd == st.write:
                    st.write(*args, unsafe_allow_html=True)
                else:
                    cmd(*args)
    st.write("")
    return done

Import:

from streamlit_extras.stodo import to_do # (1)!
  1. You should add this to the top of your .py file 🛠

Examples

example

def example() -> None:
    _to_do("Take a coffee boy", "coffee_simple")

    to_do(
        [(st.write, "☕ Take my coffee")],
        "coffee_styled",
    )
    to_do(
        [(st.write, "🥞 Have a nice breakfast")],
        "pancakes",
    )
    to_do(
        [(st.write, ":train: Go to work!")],
        "work",
    )
Output (beta)