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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f458c3f9bbb72a3fa07a28c1db98eceabdd49b19f71fafb44dc36042e0d4b4c4 |
|
MD5 | b1f9670d4b546d87885960913b8d232b |
|
BLAKE2b-256 | 33f55f950940d4e729bfb441245ca1a979be6a2feb862162af07c799575fc4d1 |
Hashes for streamlit_navigation_bar-3.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25be9657d7f44c0d4f2759a12bd75de7bb0829ed1dc69d9a5e91a77bc69924d8 |
|
MD5 | 58907508137ac099794e1fca10497dc9 |
|
BLAKE2b-256 | 342f44010a5393faf2c6f5506096f3cff6bc618bc010f412a56c30a99398f52c |