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
- options (required): the array of (string) options to display in the menu
- 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"]): array of [bootstrap-icon](https://icons.getbootstrap.com/) names to be used for each option; its length should be equal to the length of options;
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
```
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
streamlit-option-menu-0.2.0.tar.gz
(705.6 kB
view hashes)
Built Distribution
Close
Hashes for streamlit-option-menu-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd6922839690ff7bdcff28023008f406b0b48a3f444e2bb943aa406719af8857 |
|
MD5 | 79d2f8947702717f332238a07f531b26 |
|
BLAKE2b-256 | 914765a76ece6f65d6f6717f8a1212485e5f97b6b36e8df684455c12af617ee5 |
Close
Hashes for streamlit_option_menu-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a59ae5415af77e11ede12ad2e57158299d49bd30a6ad36caa70d980c600c8330 |
|
MD5 | cefcf03d7060de82f6bfc285236bb52f |
|
BLAKE2b-256 | ad3131883826f09c0ceebd29454d9390b793c70fe168d1b7ed579aa7aca04e70 |