Skip to main content

Bootswatch + Bootstrap 5 themes for Shiny.

Project description

shinyswatch

Bootswatch + Bootstrap 5 themes for Shiny.

Here are just three of the 25 themes in shinyswatch:

Minty Sketchy Superhero
Minty Sketchy Superhero

Installation

pip install shinyswatch

To install the latest development version from this repository:

pip install https://github.com/rstudio/py-shinyswatch/tarball/main

Usage

To use a theme, add a shinyswatch.theme theme object to your App’s UI definition.

# Minty theme
shinyswatch.theme.minty

# Sketchy theme
shinyswatch.theme.sketchy

# Superhero theme
shinyswatch.theme.superhero

Example Shiny application:

File: app.py

Screenshot

from shiny import App, Inputs, Outputs, Session, render, ui

import shinyswatch

app_ui = ui.page_fluid(
    ui.input_slider("num", "Number:", min=10, max=100, value=30),
    ui.output_text_verbatim("slider_val"),
    theme=shinyswatch.theme.darkly,  # <- Use a shinyswatch theme here
)


def server(input: Inputs, output: Outputs, session: Session):
    @output
    @render.text
    def slider_val():
        return f"{input.num()}"


app = App(app_ui, server)

darkly theme

Note: When writing shiny apps that use shinyswatch on shinylive.io, remember to add shinyswatch to your requirements.txt file!

Theme picker

To add a theme picker to your app, add the theme picker UI and server functions to your app’s UI and server definitions.

Demo theme picker app on shinylive.io.

Plot Theming

shinyswatch themes include a .colors attribute that can be used to theme plots or other outputs and UI elements. In the example below, try changing the theme and re-running the app to see how the plot changes.

Demo plot theming app on shinylive.io.

Development

If you want to do development on shinyswatch for Python:

pip install -e ".[dev,test,docs]"

Examples

There are multiple examples in the shinyswatch repo.

To run the demos locally, you can run the examples by calling:

python3 -m shiny run examples/basic-darkly/app.py
python3 -m shiny run examples/big-sketchy/app.py
python3 -m shiny run examples/components/app.py
python3 -m shiny run examples/theme-picker/app.py

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

shinyswatch-0.9.0.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

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

shinyswatch-0.9.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file shinyswatch-0.9.0.tar.gz.

File metadata

  • Download URL: shinyswatch-0.9.0.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for shinyswatch-0.9.0.tar.gz
Algorithm Hash digest
SHA256 090b89668691a1c520c79b7e36b03901489976199b64988e05ad4c86924da17d
MD5 f9000560734724afae8a86ab7c68f815
BLAKE2b-256 ce63092491e79e022f7dc722cc0ea293b43d3fff68528a87e128d86b51b7873d

See more details on using hashes here.

File details

Details for the file shinyswatch-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: shinyswatch-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for shinyswatch-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb335a1db9bf5fc84867e2644ffbcc61ccad452d38c7b386651c2b78ab0f734a
MD5 c9492949267677fc4cfbf06ee84ac95d
BLAKE2b-256 a30435477d786dbe2ace26bf34c8251a3213fcb4c70e25539f3739dda9d81dba

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