streamlit-option-menu-patch


Namestreamlit-option-menu-patch JSON
Version 0.3.12 PyPI version JSON
download
home_pagehttps://github.com/victoryhb/streamlit-option-menu
Summarystreamlit-option-menu is a simple Streamlit component that allows users to select a single item from a list of options in a menu.
upload_time2024-05-23 12:04:55
maintainerNone
docs_urlNone
authorVictor Yan
requires_python>=3.6
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/victoryhb/streamlit-option-menu",
    "name": "streamlit-option-menu-patch",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Victor Yan",
    "author_email": "victoryhb@163.com",
    "download_url": "https://files.pythonhosted.org/packages/c3/24/ce8634bd004a8990142751cd09dbac8048531ff3724bcf22d6ebb7418202/streamlit_option_menu_patch-0.3.12.tar.gz",
    "platform": null,
    "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.\nIt is similar in function to st.selectbox(), except that:\n- It uses a simple static list to display the options instead of a dropdown\n- It has configurable icons for each option item and the menu title\n\nIt 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/)\n\n## Installation\n```\npip install streamlit-option-menu\n```\n\n## Parameters\nThe `option_menu` function accepts the following parameters:\n- menu_title (required): the title of the menu; pass None to hide the title\n- options (required): list of (string) options to display in the menu; set an option to \"---\" if you want to insert a section separator\n- default_index (optional, default=0): the index of the selected option by default\n- menu_icon (optional, default=\"menu-up\"): name of the [bootstrap-icon](https://icons.getbootstrap.com/) to be used for the menu title\n- 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\n- orientation (optional, default=\"vertical\"): \"vertical\" or \"horizontal\"; whether to display the menu vertically or horizontally\n\nThe function returns the (string) option currently selected\n\n## Example\n```\nimport streamlit as st\nfrom streamlit_option_menu import option_menu\n\nwith st.sidebar:\n    selected = option_menu(\"Main Menu\", [\"Home\", 'Settings'], \n        icons=['house', 'gear'], menu_icon=\"cast\", default_index=1)\n    selected\n\n# horizontal Menu\nselected2 = option_menu(None, [\"Home\", \"Upload\", \"Tasks\", 'Settings'], \n    icons=['house', 'cloud-upload', \"list-task\", 'gear'], \n    menu_icon=\"cast\", default_index=0, orientation=\"horizontal\")\n    selected2\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "streamlit-option-menu is a simple Streamlit component that allows users to select a single item from a list of options in a menu.",
    "version": "0.3.12",
    "project_urls": {
        "Homepage": "https://github.com/victoryhb/streamlit-option-menu"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f6ae77b6024e68220a84c92ac56ded4d35966f63d4b242d4fa94aab6ff27091d",
                "md5": "02416a1f5b05c4206aeb4dae1bff581a",
                "sha256": "90aecb9b8360a5ddfbf87713b626c8f3ad182e82a6176304bfd7960b1be00757"
            },
            "downloads": -1,
            "filename": "streamlit_option_menu_patch-0.3.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "02416a1f5b05c4206aeb4dae1bff581a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 823464,
            "upload_time": "2024-05-23T12:04:53",
            "upload_time_iso_8601": "2024-05-23T12:04:53.586309Z",
            "url": "https://files.pythonhosted.org/packages/f6/ae/77b6024e68220a84c92ac56ded4d35966f63d4b242d4fa94aab6ff27091d/streamlit_option_menu_patch-0.3.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c324ce8634bd004a8990142751cd09dbac8048531ff3724bcf22d6ebb7418202",
                "md5": "821e7ccbbe6adc32c1747d9039d801ce",
                "sha256": "1bc211c06a44c035853c81a9f36fb9f93d6f4fdd945e5b584e803c8367eefe67"
            },
            "downloads": -1,
            "filename": "streamlit_option_menu_patch-0.3.12.tar.gz",
            "has_sig": false,
            "md5_digest": "821e7ccbbe6adc32c1747d9039d801ce",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 821067,
            "upload_time": "2024-05-23T12:04:55",
            "upload_time_iso_8601": "2024-05-23T12:04:55.659220Z",
            "url": "https://files.pythonhosted.org/packages/c3/24/ce8634bd004a8990142751cd09dbac8048531ff3724bcf22d6ebb7418202/streamlit_option_menu_patch-0.3.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-23 12:04:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "victoryhb",
    "github_project": "streamlit-option-menu",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "streamlit-option-menu-patch"
}
        
Elapsed time: 0.24523s