Skip to main content

streamlit-option-menu is a simple Streamlit component that allows users to select a single item from a list of options in a menu.

Project description

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

It is built on [streamlit-component-template-vue](https://github.com/andfanilo/streamlit-component-template-vue), styled with [Bootstrap](https://getbootstrap.com/) and with icons from [bootstrap-icons](https://icons.getbootstrap.com/)

## 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](https://icons.getbootstrap.com/) to be used for the menu title
- icons (optional, default=["caret-right"]): list of [bootstrap-icon](https://icons.getbootstrap.com/) 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

The function returns the (string) option currently selected

## Example
```
import streamlit as st
from streamlit_option_menu import option_menu

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

# 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
```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

streamlit-option-menu-0.4.0.tar.gz (827.3 kB view details)

Uploaded Source

Built Distribution

streamlit_option_menu-0.4.0-py3-none-any.whl (829.3 kB view details)

Uploaded Python 3

File details

Details for the file streamlit-option-menu-0.4.0.tar.gz.

File metadata

  • Download URL: streamlit-option-menu-0.4.0.tar.gz
  • Upload date:
  • Size: 827.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for streamlit-option-menu-0.4.0.tar.gz
Algorithm Hash digest
SHA256 48ec69d59e547fa2fa4bfae001620df8af56a80de2f765ddbb9fcbfb84017129
MD5 e6c03badfd91039dbd292550d79655eb
BLAKE2b-256 5e2772dc451cdaef1714fd0d75cc430e50a06c12c9046295fdf1f94af1b766eb

See more details on using hashes here.

File details

Details for the file streamlit_option_menu-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_option_menu-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a55fc7554047b6db371595af2182e435b8a2c715ee6124e8543685bd4670b07e
MD5 f94be8209ca1a41d6e85608502b2a55d
BLAKE2b-256 fd522f525ad4262dc83d67297f69ec5afcee1438b9e9ae22aa318396725ddbed

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page