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
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
