A component that allows you to place a navigation bar in your Streamlit app.
Project description
Streamlit Navigation Bar
A component that allows you to place a navigation bar in your Streamlit app.
The navbar was built to:
- Be simple to use
- Look great out of the box
- Apply custom styles
- Integrate with Streamlit’s UI
- Have a well-written documentation
It has some cool functionalities, like displaying an optional logo and external URLs. It also matches the active theme by default.
Installation
Open a terminal and run:
pip install streamlit-navigation-bar
Example
Here is a basic example of how to use it:
import streamlit as st
from streamlit_navigation_bar import st_navbar
page = st_navbar(["Home", "Documentation", "Examples", "Community", "About"])
st.write(page)
Jump to the examples gallery to see more demos of what the navbar is capable of.
Documentation
The complete documentation is on the GitHub Wiki. There, you can check:
Requirements
To use the navigation bar component in your Streamlit app, you will need:
- Python >= 3.8
- Streamlit >= 1.33
- Streamlit Theme >= 1.2.3
- The CSS adjustment depends on the browser compatibility with the :has pseudo-class
Contributing
You are welcome to help develop the Streamlit Navigation Bar! There are multiple ways to contribute, such as reporting a bug or requesting a feature. You can also just ask a question, or join the discussions in the community forum. To submit code for a pull request, make sure to read the guide on how to contribute.
References
The Streamlit Navigation Bar was made with:
- The streamlit-component-vue-vite-template, by @gabrieltempass
- The st-theme component, by @gabrieltempass
And based on:
- The streamlit-option-menu component, by @victoryhb
- The styleable container, by @LukasMasuch
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
Hashes for streamlit-navigation-bar-3.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42e59b6521f40ad76f1f3d0046da84201b6e3d62c74ca0746ff7288c01eef29f |
|
MD5 | 490bac2e50adbc4940c1676bf053feac |
|
BLAKE2b-256 | 4190877909ad318123a7fb195ca8a65b2646479c6e4860f2f9ad76b9fdcd3085 |
Hashes for streamlit_navigation_bar-3.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 242a35efa51dd12d3dc779ac7a50ec40cf0bcf2e0a125f39613375163348ac0b |
|
MD5 | f31e485010c6f13b2145db88a07a2d8b |
|
BLAKE2b-256 | 24811736943fe0d2a3ba384b70ef8622f336869f42b86e2d229cc893699bab0f |