Toggling component for Streamlit
Project description
Streamlit Toggle
Add toggle switches to your Streamlit app.
Installation
pip install streamlit-toggle
Quickstart
import streamlit as st
from streamlit_toggle import toggle
st.title('Streamlit Toggle')
toggle()
License
Streamlit Toggle has an MIT license, as found in the LICENSE file.
Documentation
streamlit_toggle.toggle
streamlit_toggle.toggle(container=None, widget='slider', label='', value=False, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False)
Add a toggle switch to Streamlit app.
Parameters:
- container (any, optional): The Streamlit container. Defaults to
None
. - widget (str, optional): The input widget. Defaults to
'slider'
. - label (str, optional): The short label explaining what the toggle switch is for. Defaults to
''
. - value (bool, optional): The preselected value on first renders. Defaults to
False
. - key (str, optional): The unique key for the widget. Defaults to
None
, a key will be automatically generated. - help (str, optional): The tooltip that gets displayed next to the toggle switch. Defaults to
None
. - on_change (callable, optional): The callback invoked when the value of the toggle switch changes. Defaults to
None
. - args (tuple, optional): The tuple of args to pass to the callback. Defaults to
None
. - kwargs (dict, optional): The dictionary of kwargs to pass to the callback. Defaults to
None
. - disabled (bool, optional, keyword-only): Whether the toggle switch is to be disabled. Defaults to
False
.
Returns:
(bool): The value of the toggle switch.
streamlit_toggle.theme
streamlit_toggle.theme(container=None, widget='checkbox', label='Dark', value=False, key=None, help=None, *, disabled=False, path=None)
Add a Streamlit Light and Dark theme toggle switch to Streamlit app.
Parameters:
- container (any, optional): The Streamlit container. Defaults to
None
. - widget (str, optional): The input widget. Defaults to
'checkbox'
. - label (str, optional): The short label explaining what the toggle switch is for. Defaults to
'Dark'
. - value (bool, optional): The preselected value on first renders. Defaults to
False
, the default Streamlit Light theme. - key (str, optional): The unique key for the widget. Defaults to
None
, a key will be automatically generated. - help (str, optional): The tooltip that gets displayed next to the toggle switch. Defaults to
None
. - disabled (bool, optional, keyword-only): Whether the toggle switch is to be disabled. Defaults to
False
. - path (str, optional, keyword-only): The path of Stramlit app. Defaults to
None
, the file path of the caller.
Returns:
(bool): The value of the toggle switch.
Contribution
Changelog
Version 0.1.0:
- Made toggling component functional
- Made essential theming component functional, toggling between Streamlit Light and Dark theme
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file streamlit_toggle-0.1.3.tar.gz
.
File metadata
- Download URL: streamlit_toggle-0.1.3.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d2f5dd0283e0d02ba611f943c8cfb650ed3338df7d43d6476e13f2b76147584 |
|
MD5 | 9737320553f9660095486308f0771da9 |
|
BLAKE2b-256 | 5e70235e4ab6dbd24e335de40256cab6b8d31ebd375b6d1c3e33fb5a92dbbbea |
File details
Details for the file streamlit_toggle-0.1.3-py3-none-any.whl
.
File metadata
- Download URL: streamlit_toggle-0.1.3-py3-none-any.whl
- Upload date:
- Size: 5.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb2f36d9f6d8cb20a30d4ed3e10827daeea0270826eeebea1c078b3448550a76 |
|
MD5 | 27335fc63f55277bb4a439dc4f57327a |
|
BLAKE2b-256 | 0710355b5e8339e1ba28a826b9f8b661443a033c24874f6138554937856eb8f0 |