streamlit-custom-toggle

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

streamlit-custom-toggle

★ 11 Open GitHub ↗

Insert heart-shaped Toggle Switch within Streamlit apps! 🧡

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![streamlit-custom-toggle](https://socialify.git.ci/ShruAgarwal/streamlit-custom-toggle/image?description=1&font=Rokkitt&forks=1&language=1&logo=https%3A%2F%2Fimg.icons8.com%2Fplasticine%2F256%2Freact.png&name=1&owner=1&pattern=Charlie%20Brown&stargazers=1&theme=Light)

⚡ A custom component that can load heart-shaped Toggle Switch inside your Streamlit apps.  Also, you can **sync this toggle with different Streamlit widgets!**

## Demo 🕹
[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://shru-examples.streamlit.app/Heart_Toggle_Switch)

## Installation ⬇

First `pip install streamlit`. Don't know how? 👉 [Check here!](https://30days.streamlit.app/?challenge=Day+1)

After that, install this component:

```
pip install streamlit-custom-toggle
```

## How to Use? 🤓

*Here's an example code 👇*

```python
import streamlit as st
from streamlit_custom_toggle import st_custom_toggle

st.subheader('Music Choices 🎵')
col1, col2, col3 = st.columns(3, gap="small")

with col1:
    # Disabled toggle switch
    calm = st_custom_toggle('Calm', active_track_fill="#EAE4E4", active_thumb_color="#EAE4E4", value="true", key="toggle1")

with col2:
    fun = st_custom_toggle('Fun', active_track_fill="#57FD6E", active_thumb_color="#EAE4E4", key="toggle2")

with col3:
    music_toggle = st_custom_toggle('Rock', active_track_fill="#FF5733", active_thumb_color="#900C3F", key="toggle3")
    
    music = st.radio(
    "Select your favorite artist",
    ('The Beatles', 'AC/DC', 'Pink Floyd', 'Elvis Presley', 'MÃ¥neskin'), disabled=music_toggle)
    st.markdown(f"You choose {music}")

# Checking the toggle state
st.code(f"Calm = {calm}, Fun = {fun}, Rock = {music_toggle}")
```

## Arguments Config ⚙
It supports the following arguments customization:

| Args                          | Type   | Required | Description                                                                                              |
| ----------------------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------- |
| label                         | string |   YES    | Define the toggle with a short label value
| active_track_fill             | string |   YES    | Changes the color of the track when the toggle is in the active/on state. Default value is: `#ff708f`
| active_thumb_color            | string |   YES    | Changes the color of the thumb when the toggle is in the active/on state. Default value is: `#ffffff`
| value                         | bool   | OPTIONAL | If it's value is set to `true`, then the toggle switch is deactivated. **The toggle is activated by default**
| key                           | string |   YES    | An optional key value that uniquely identifies this component.

## Tech Stack 🧰

 <img src="https://streamlit.io/images/brand/streamlit-mark-color.png" width="50" />
 <img src="https://img.icons8.com/plasticine/256/react.png" width="50" alt="React" />
 <img src="https://img.icons8.com/color/256/python.png" width="50" />
 <img src="https://img.icons8.com/color/256/typescript.png" width="50" />
 <img src="https://img.icons8.com/color/256/nodejs.png" width="50" />
 <img src="https://files.anaconda.com/production/resources/open-source/conda-artboard.svg" width="80" />

## Workflow 👀
Here's the blueprint on how my component works. For understanding it in details, 👉 **[Read here please!](https://shru.hashnode.dev/dont-let-those-bugs-slow-you-down#heading-final-code-blueprint)**

## License 📝
This software is open source, licensed under the [MIT License.](https://github.com/ShruAgarwal/streamlit-custom-toggle/blob/main/LICENSE)

## Helpful References 🤩

- [React heart-switch](https://github.com/anatoliygatt/heart-switch)
- [Streamlit Components Tutorial by FANILO](https://streamlit-components-tutorial.netlify.app/)
- [Streamlit Component Publish Docs](https://docs.streamlit.io/library/components/publish)

streamlit-custom-toggle

Today's picks

Was this content helpful?

Recent Feedback

streamlit-custom-toggle

Today's picks

Was this content helpful?

Recent Feedback

Download README