A package for customizing themes in Streamlit apps.
Project description
Streamlit-Themes
The streamlit-themes
package provides a streamlined way to customize the visual appearance of Streamlit applications.
Note: This package accesses the internal config at st._config
, and is likely to break with future Streamlit updates.
Use with caution. Also, updating the theme with streamlit-themes
updates the theme for the entire Streamlit app
(including all users), so it's not suitable for multi-user apps.
Installation
To install the streamlit-themes
package, simply use pip:
pip install streamlit-themes
Demo
Basic Usage
Here's a basic example of how to use the streamlit-themes
package:
import streamlit_themes as st_theme
# Set a custom theme
st_theme.set_theme(
background_color='#FFFFFF',
primary_color='#1A73E8',
secondary_background_color='#F1F3F4',
text_color='#202124',
font='sans serif'
)
Functions
The following functions are available directly through the __init__.py
file:
get_theme
: retrieves the current theme settings.set_theme
: Sets the theme with given parameters.get_preset_theme
: Retrieves a preset theme.set_preset_theme
: Sets a preset theme.get_all_preset_themes
: Retrieves all preset themes.custom_theme_widget
: Creates a custom theme widget for user interaction.preset_theme_widget
: Creates a preset theme widget for user interaction.Theme
: Dataclass for storing themes.
Here are the preset theme keys available in the constants.py
file:
Preset Themes
The streamlit-themes
package provides a set of preset keys that can be used to quickly apply predefined themes.
Available Preset Keys
Beach
Pineapple
Peachy
Tropical
Mater
Gastly
Ocean
Abyssal
Green
Sandy
Sunset
Midnight
Example Usage
import streamlit_themes as st_theme
# Directly apply a preset theme
st_theme.set_preset_theme('Beach')
Project details
Release history Release notifications | RSS feed
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_themes-0.1.0.tar.gz
.
File metadata
- Download URL: streamlit_themes-0.1.0.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32b428379cfef9285cdbac1dac12e63a9df7f8fe6d286983841e3826e60fdbe3 |
|
MD5 | 24d8a77b9d5393da52f623623a53616c |
|
BLAKE2b-256 | 7588695c868eed5784e4c34e8b90869d8ff837a86237b11d720786bd1e29ac2f |
File details
Details for the file streamlit_themes-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: streamlit_themes-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 379d571d2887bb21bbe0851fb315ffb3f755843a1e5937e54b8256ddb0b38432 |
|
MD5 | 1d327ec3d14efb8b894784ff82a16fa7 |
|
BLAKE2b-256 | c4ba7137a687488cff04041c961384011d6a96c4a2ab0959209dbd2557bfd2db |