streamlit-navigation-bar
A component that allows you to place a navigation bar in your Streamlit app.
Readme
A component that allows you to place a navigation bar in your Streamlit app.
pip install streamlit-navigation-bar
If there is no st.set_page_config
command on the app page, st_navbar must be the first Streamlit command used,
and must only be set once per page. If there is a st.set_page_config
command, then st_navbar must be the second one, right after it.
pages : list of str
A list with the name of each page that will be displayed in the navigation bar.
selected : str or None, optional
The preselected page on first render. It can be a name from pages, the
logo_page (when there is a logo) or None. Defaults to the logo_page
value, if there is a logo. In case there is not one, defaults to the first page
of the pages list. When set to None, it will initialize empty and return
None until the user selects a page.
logo_path : str, optional
The absolute path to an SVG file for a logo. It will be shown on the left side
of the navigation bar. Defaults to None, where no logo is displayed.
logo_page : str or None, default="Home"
The page value that will be returned when the logo is selected, if there is
one. Defaults to "Home". For a non-clickable logo, set this to None.
urls : dict of {str : str}, optional
A dictionary with the page name as the key and an external URL as the value,
both as strings. The page name must be contained in the pages list. The URL
will open in a new window or tab. The default is None.
styles : dict of {str : {dict of {str : str}}, optional
Apply CSS styles to desired targets, through a dictionary with the HTML tag or
pseudo-class name as the key and another dictionary to style it as the value.
In the second dictionary, the key-value pair is the name of a CSS property and
the value it takes. The keys and values must be strings. Defaults to None,
where no custom style is applied.
The available HTML tags are: "nav", "div", "ul", "li", "a",
"img" and "span". To better understand the Document Object Model, check
the notes section.
The available pseudo-classes are: "active" and "hover", which direct
the styling to the "span" tag. The menu and sidebar buttons are only styled
by "hover" (if they are set to True in options). Currently,
"hover" only accepts two CSS properties, they are: "color" and
"background-color".
options : bool or dict of {str : bool}, default=True
Customize the navbar with options that can be toggled on or off. It accepts a
dictionary with the option name as the key and a boolean as the value. The
available options are: "show_menu", "show_sidebar", "fix_shadow"
and "use_padding". Check the notes section for a description of each one.
It is also possible to toggle all options to the same state. Simply pass
True to options, which is the parameter default value, or False.
adjust : bool, default=True
When set to True (default), it overrides some Streamlit behaviors and makes
a series of CSS adjustments to display the navbar correctly.
In most cases, the CSS adjustments do not interfere with the rest of the web
app, however there could be some situations where this occurs. If this happens,
or it is desired to disable all of them, pass False to adjust and, when
necessary, make your own CSS adjustments with st.markdown.
If set to False, it will also disable all adjustments made by options,
regardless of whether they are on or off.
key : str or int, optional
A string or integer to use as a unique key for the component. If this is
omitted, a key will be generated for the widget based on its content. Multiple
navbars of the same type may not share the same key.
page : str or None
The page selected by the user. If there has been no interaction yet, returns
the preselected page or None.
The component accepts theme configuration options to be passed as CSS variables in the styles dictionary, for example:
styles = {
"nav": {
"background-color": "var(--primary-color)"
}
}
The CSS variables that can be used are:
--primary-color
--background-color
--secondary-background-color
--text-color
--font
By default, the navbar uses in the following targets these CSS variables:
styles = {
"nav": {
"font-family": "var(--font)",
"background-color": "var(--secondary-background-color)"
},
"span": {
"color": "var(--text-color)"
},
"active": {
"color": "var(--text-color)"
}
}
They can be overridden by simply passing another value to the respective target and CSS property in styles.
To style the navigation bar, it is important to understand its Document Object
Model (DOM). For example, if a navbar is created with
pages=["Hello, World!"] and an SVG logo. On the frontend side, the
component builds this DOM (simplified for readability):
<nav>
<div>
<ul>
<li>
<a>
<img src="svg_logo" img/>
</a>
</li>
<li>
<a>
<span>
Hello, World!
</span>
</a>
</li>
</ul>
</div>
</nav>
Notice that the "a" tag will style both the logo and the page name.
However, the "img" tag is unique to the logo, just as "span" is to the
page names.
A fundamental CSS property to adjust is the "max-width" for the "div"
tag. Because it controls how much space the page names have between them. The
default value is "43.75rem", which works well in most cases. But if the
navbar has a large number of pages, or longer names, it might be necessary to
increase the maximum width. Conversely, whenever the navbar has few pages or
short names, this value may need to be reduced.
The available options and their descriptions are:
"show_menu"
Show Streamlit's menu button in the navbar.
"show_sidebar"
Show Streamlit's sidebar button in the navbar. However, it is still needed to
use st.sidebar in the app, in order for the sidebar button to properly
appear. Just like Streamlit's default behavior.
"fix_shadow"
Fix the shadow of the expanded sidebar, showing it no matter the window width.
It is useful when the navbar and the sidebar have the same background color,
which they do by default, because the shadow makes it possible to differentiate
between the two elements.
When set to False, it assumes Streamlit's default behavior, where it
applies the shadow only when the window width is below a certain threshold.
"use_padding"
Position the body of the app, in the y axis of the window, 6rem from the top
(if the navbar has a default height). This is the default style used by
Streamlit. When set to False, it removes this padding and positions the
body right below the navbar.
A basic example:
import streamlit as st
from streamlit_navigation_bar import st_navbar
page = st_navbar(["Home", "Documentation", "Examples", "Community", "About"])
st.write(page)
An example with a sidebar and applying a custom style:
import streamlit as st
from streamlit_navigation_bar import st_navbar
st.set_page_config(initial_sidebar_state="collapsed")
pages = ["Home", "Library", "Tutorials", "Development", "Download"]
styles = {
"nav": {
"background-color": "#7BD192",
},
"div": {
"max-width": "32rem",
},
"span": {
"border-radius": "0.5rem",
"padding": "0.4375rem 0.625rem",
"margin": "0 0.125rem",
},
"active": {
"background-color": "rgba(255, 255, 255, 0.25)",
},
"hover": {
"background-color": "rgba(255, 255, 255, 0.35)",
},
}
page = st_navbar(pages, styles=styles)
st.write(page)
with st.sidebar:
st.write("Sidebar")
An example using a logo, an external URL, multiple pages with content, among other things:
import os
import streamlit as st
from streamlit_navigation_bar import st_navbar
import pages as pg
st.set_page_config(initial_sidebar_state="collapsed")
pages = ["Install", "User Guide", "API", "Examples", "Community", "GitHub"]
parent_dir = os.path.dirname(os.path.abspath(__file__))
logo_path = os.path.join(parent_dir, "cubes.svg")
urls = {"GitHub": "https://github.com/gabrieltempass/streamlit-navigation-bar"}
styles = {
"nav": {
"background-color": "royalblue",
"justify-content": "left",
},
"img": {
"padding-right": "14px",
},
"span": {
"color": "white",
"padding": "14px",
},
"active": {
"color": "var(--text-color)",
"background-color": "white",
"font-weight": "normal",
"padding": "14px",
}
}
options = {
"show_menu": False,
"show_sidebar": False,
}
page = st_navbar(
pages,
logo_path=logo_path,
urls=urls,
styles=styles,
options=options,
)
functions = {
"Home": pg.show_home,
"Install": pg.show_install,
"User Guide": pg.show_user_guide,
"API": pg.show_api,
"Examples": pg.show_examples,
"Community": pg.show_community,
}
go_to = functions.get(page)
if go_to:
go_to()
To use the navigation bar component in your Streamlit app, you will need:
The current version of the Streamlit Navigation Bar still has some limitations, that are planned to be addressed in future updates. Those are:
.png and .jpg image formats for the logo:link and :visited pseudo-classes and any CSS property for
:hoverYou 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, if you want. To submit code for a pull request, make sure to read the guide on how to contribute.
The Streamlit Navigation Bar was made with:
And based on:
FAQs
A component that allows you to place a navigation bar in your Streamlit app.
We found that streamlit-navigation-bar demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.