Skip to main content

A customized Streamlit toggle switch component with customizable labels, colors, and border radius

Project description

streamlit-toggle-diy

Creates a toggle switch with color and placement customizations, and you can change the label's color, radius, font size, and more.

Function

  • Customize label background color
  • Customize the text color, font size, and font weight for both labels
  • Customize the Switch size (small or medium)
  • Customize the background color near the button
  • Custom rounded corners
  • Support multiple layout methods

Installation

pip install streamlit-toggle-diy

Usage

import streamlit as st
import streamlit-toggle-diy as tog

tog.st_toggle_switch(
    key=None,
    label_start="111",
    label_end="",
    justify='flex-start',
    default_value=False,
    inactive_color='#D3D3D3',
    active_color="#11567f",
    track_color="#29B5E8",
    label_bg_color_start=None,
    label_bg_color_end=None,
    background_color_near_button_start=None,
    background_color_near_button_end=None,
    border_radius=None,
)

Parameters

Parameter Name Type Default Description
key str None The unique identifier for each component instance.
Used to distinguish different component instances in the Streamlit application.
label_start str "" The text content of the label before the switch. If a preceding label is not needed, pass an empty string"".
label_end str "" The text content of the label after the switch. If a following label is not needed, pass an empty string"".
justify {'flex-start','center','flex-end'} 'flex-start' Controls alignment of labels and the switch within the container.
default_value bool False The initial state of the toggle switch.True= On,False= Off.
inactive_color str '#D3D3D3' The color of the slider when the switch is inactive (off).
active_color str '#11567f' The color of the slider when the switch is active (on).
track_color str '#29B5E8' The color of the switch track (background).
label_bg_color_start str None The starting value of the label background color, used to create a gradient effect.
label_bg_color_end str None The ending value of the label background color, used to create a gradient effect.
background_color_near_button_start str None The starting value of the background color near the switch, used to create a gradient effect behind the component.
background_color_near_button_end str None The ending value of the background color near the switch, used to create a gradient effect behind the component.
border_radius str None The border-radius of the component, such as'4px','8px','50%', etc.
label_start_color str "#7f1916" Text color for the left (start) label.
label_end_color str "#FFFFFF" Text color for the right (end) label.
label_font_size str "14px" Font size for both labels (e.g."14px","12pt").
label_font_weight str "bold" Font weight for both labels (e.g."bold","normal","500").
switch_size {'small','medium'} "medium" The size of the Switch component.

Note:

  • If both label_bg_color_start and label_bg_color_end are set, a gradient background for the label(s) will be created.
  • If both background_color_near_button_start and background_color_near_button_end are provided, a gradient behind the switch is created.
  • If you only provide one color, it will be used as a solid background.
  • label_start_color and label_end_color control the text color of labels, while label_bg_color_start and label_bg_color_end control the background of those labels.

Operation

streamlit.gif

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

streamlit_toggle_diy-1.1.4.tar.gz (713.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

streamlit_toggle_diy-1.1.4-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file streamlit_toggle_diy-1.1.4.tar.gz.

File metadata

  • Download URL: streamlit_toggle_diy-1.1.4.tar.gz
  • Upload date:
  • Size: 713.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.20

File hashes

Hashes for streamlit_toggle_diy-1.1.4.tar.gz
Algorithm Hash digest
SHA256 a44b784b75b214ee196d95e14a802913545dffa1152f20b2b9ef828dc66dba7f
MD5 72e8482d08db9afe141e7a31619e4616
BLAKE2b-256 7e10d6a292c89989a480abbb644d847b4f9bb86e1237322c337da871b42da31e

See more details on using hashes here.

File details

Details for the file streamlit_toggle_diy-1.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_toggle_diy-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 89414bb07b8d0f1bb304c951ab1f7ee55a1410a9181c0e11baf0a9f708fa10a2
MD5 f349fa7aa5c959a5cdf2fc7dd8570ef3
BLAKE2b-256 1ec76383225115ead524133d4ec4f0bf538d5ee79e9bbeab6836c7d9cffb600a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page