streamlit-option-menu

streamlit-option-menu is a simple Streamlit component that allows users to select a single item from a list of options in a menu. It is similar in function to st.selectbox(), except that:

• It uses a simple static list to display the options instead of a dropdown
• It has configurable icons for each option item and the menu title
• The CSS styles of most HTML elements in the menu can be customized (see the styles parameter and Example #3 below)

It is built on streamlit-component-template-vue, styled with Bootstrap and with icons from bootstrap-icons

Installation

pip install streamlit-option-menu

Parameters

The option_menu function accepts the following parameters:

• menu_title (required): the title of the menu; pass None to hide the title
• options (required): list of (string) options to display in the menu; set an option to "---" if you want to insert a section separator
• default_index (optional, default=0): the index of the selected option by default
• menu_icon (optional, default="menu-up"): name of the bootstrap-icon to be used for the menu title
• icons (optional, default=["caret-right"]): list of bootstrap-icon names to be used for each option; its length should be equal to the length of options
• orientation (optional, default="vertical"): "vertical" or "horizontal"; whether to display the menu vertically or horizontally
• styles (optional, default=None): A dictionary containing the CSS definitions for most HTML elements in the menu, including:
  • "container": the container div of the entire menu
  • "menu-title": the <a> element containing the menu title
  • "menu-icon": the icon next to the menu title
  • "nav": the <ul> containing "nav-link"
  • "nav-item": the <li> element containing "nav-link"
  • "nav-link": the <a> element containing the text of each option
  • "nav-link-selected": the <a> element containing the text of the selected option
  • "icon": the icon next to each option
  • "separator": the <hr> element separating the options

The function returns the (string) option currently selected

Examples

import streamlit as st
from streamlit_option_menu import option_menu

# 1. as sidebar menu
with st.sidebar:
    selected = option_menu("Main Menu", ["Home", 'Settings'], 
        icons=['house', 'gear'], menu_icon="cast", default_index=1)
    selected

# 2. horizontal menu
selected2 = option_menu(None, ["Home", "Upload", "Tasks", 'Settings'], 
    icons=['house', 'cloud-upload', "list-task", 'gear'], 
    menu_icon="cast", default_index=0, orientation="horizontal")
selected2

# 3. CSS style definitions
selected3 = option_menu(None, ["Home", "Upload",  "Tasks", 'Settings'], 
    icons=['house', 'cloud-upload', "list-task", 'gear'], 
    menu_icon="cast", default_index=0, orientation="horizontal",
    styles={
        "container": {"padding": "0!important", "background-color": "#fafafa"},
        "icon": {"color": "orange", "font-size": "25px"}, 
        "nav-link": {"font-size": "25px", "text-align": "left", "margin":"0px", "--hover-color": "#eee"},
        "nav-link-selected": {"background-color": "green"},
    }
)