# streamlit-plugins
Components and Frameworks to give new features to streamlit
## Frameworks
### Multilit (Inherit from Hydralit)
This is a fork of [Hydralit](https://github.com/TangleSpace/hydralit).
In this version, I update all the code to be compatible with the last version of streamlit.
And it improves the interface to be more user-friendly. Also, it respects the strealit active theme and can be override by the user.
In a future is planned to incorporate the new multipage native of streamlit. Instead of the current implementation.
Can use built-in buttons to change the page, or use a function to change the page programmatically.
You can install extra components to work with multilit framework.
```bash
pip install streamlit-framework-multilit[navbar,loader]
```
## Components
The Navbar and Loader component are inherited from Hydralit components, only to give support to the multilit framework.
But this version has improve the interface and loaders to be more user-friendly.
### Navbar (Inherit from Hydralit Components)
Component to use when you want to have a navbar in your streamlit app.
It can be used with native multipage streamlit, or use the multilit framework.
If you want to use the native multipage streamlit, you can use the `st_navbar` function to create the navbar.
This component it returns the id of the defined menu that has to run the page.
This is an example of multipage with native streamlit
```python
import streamlit as st
if "logged_in" not in st.session_state:
st.session_state.logged_in = False
def login():
if st.button("Log in"):
st.session_state.logged_in = True
st.rerun()
def logout():
if st.button("Log out"):
st.session_state.logged_in = False
st.rerun()
login_page = st.Page(login, title="Log in", icon=":material/login:")
logout_page = st.Page(logout, title="Log out", icon=":material/logout:")
dashboard = st.Page(
"reports/dashboard.py", title="Dashboard", icon=":material/dashboard:", default=True
)
bugs = st.Page("reports/bugs.py", title="Bug reports", icon=":material/bug_report:")
alerts = st.Page(
"reports/alerts.py", title="System alerts", icon=":material/notification_important:"
)
search = st.Page("tools/search.py", title="Search", icon=":material/search:")
history = st.Page("tools/history.py", title="History", icon=":material/history:")
if st.session_state.logged_in:
pg = st.navigation(
{
"Account": [logout_page],
"Reports": [dashboard, bugs, alerts],
"Tools": [search, history],
}
)
else:
pg = st.navigation([login_page])
pg.run()
```
And if you want to use streamlit Navbar, it has to be addapted to this code:
```python
import streamlit as st
st.set_page_config(layout="wide")
if "logged_in" not in st.session_state:
st.session_state.logged_in = False
if "app_id" not in st.session_state:
st.session_state.app_id = None
def login():
if st.button("Log in"):
st.session_state.logged_in = True
st.session_state.app_id = "app_default"
st.rerun()
def logout():
if st.button("Log out"):
st.session_state.logged_in = False
st.session_state.app_id = None
st.rerun()
login_page = st.Page(login, title="Log in", icon=":material/login:")
logout_page = st.Page(logout, title="Log out", icon=":material/logout:")
dashboard = st.Page(
"reports/dashboard.py", title="Dashboard", icon=":material/dashboard:", default=True
)
bugs = st.Page("reports/bugs.py", title="Bug reports", icon=":material/bug_report:")
alerts = st.Page(
"reports/alerts.py", title="System alerts", icon=":material/notification_important:"
)
search = st.Page("tools/search.py", title="Search", icon=":material/search:")
history = st.Page("tools/history.py", title="History", icon=":material/history:")
# HERE IS THE CHANGE
from streamlit_plugins.components.navbar import st_navbar, build_menu_from_st_pages
menu_data, app_map = build_menu_from_st_pages(
{"Reports": [dashboard, bugs, alerts]}, {"Tools": [search, history]},
login_app=login_page,
logout_app=logout_page,
)
app_id = st_navbar(
menu_definition=menu_data if st.session_state.logged_in else [],
login_name=logout_page.title if st.session_state.logged_in else login_page.title,
hide_streamlit_markers=False,
override_app_selected_id=st.session_state.app_id,
sticky_nav=True, # at the top or not
sticky_mode='pinned', # sticky or pinned
)
if app_id == "app_login":
if st.session_state.logged_in:
app_id = "app_logout"
st.session_state.app_id = None # Added to fix login/logout issue
app_map[app_id]._can_be_called = True
app_map[app_id].run()
# if st.session_state.logged_in:
# pg = st.navigation(
# {
# "Account": [logout_page],
# "Reports": [dashboard, bugs, alerts],
# "Tools": [search, history],
# },
# position="hidden"
# )
#
# else:
# pg = st.navigation([login_page], position="hidden")
#
#
# pg.run()
```
### Loader (Inherit from Hydralit Components)
Raw data
{
"_id": null,
"home_page": "https://github.com/quiradev/streamlit-plugins",
"name": "streamlit-framework-multilit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "streamlit, plugins, framework, multipage, multilit",
"author": "Victor Quilon Ranera",
"author_email": "v.quilonr@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f9/40/02fd20e8e8e7d049111b6ef91ad5a3beeb1f03eca7596d8375f9d42a458d/streamlit_framework_multilit-0.3.2.tar.gz",
"platform": null,
"description": "# streamlit-plugins\nComponents and Frameworks to give new features to streamlit\n\n\n\n## Frameworks\n### Multilit (Inherit from Hydralit)\nThis is a fork of [Hydralit](https://github.com/TangleSpace/hydralit).\n\nIn this version, I update all the code to be compatible with the last version of streamlit.\nAnd it improves the interface to be more user-friendly. Also, it respects the strealit active theme and can be override by the user.\nIn a future is planned to incorporate the new multipage native of streamlit. Instead of the current implementation.\n\nCan use built-in buttons to change the page, or use a function to change the page programmatically.\n\n\nYou can install extra components to work with multilit framework.\n```bash\npip install streamlit-framework-multilit[navbar,loader]\n```\n\n## Components\nThe Navbar and Loader component are inherited from Hydralit components, only to give support to the multilit framework.\nBut this version has improve the interface and loaders to be more user-friendly.\n\n### Navbar (Inherit from Hydralit Components)\nComponent to use when you want to have a navbar in your streamlit app.\nIt can be used with native multipage streamlit, or use the multilit framework.\n\nIf you want to use the native multipage streamlit, you can use the `st_navbar` function to create the navbar.\n\nThis component it returns the id of the defined menu that has to run the page.\n\nThis is an example of multipage with native streamlit\n```python\nimport streamlit as st\n\nif \"logged_in\" not in st.session_state:\n st.session_state.logged_in = False\n\ndef login():\n if st.button(\"Log in\"):\n st.session_state.logged_in = True\n st.rerun()\n\ndef logout():\n if st.button(\"Log out\"):\n st.session_state.logged_in = False\n st.rerun()\n\nlogin_page = st.Page(login, title=\"Log in\", icon=\":material/login:\")\nlogout_page = st.Page(logout, title=\"Log out\", icon=\":material/logout:\")\n\ndashboard = st.Page(\n \"reports/dashboard.py\", title=\"Dashboard\", icon=\":material/dashboard:\", default=True\n)\nbugs = st.Page(\"reports/bugs.py\", title=\"Bug reports\", icon=\":material/bug_report:\")\nalerts = st.Page(\n \"reports/alerts.py\", title=\"System alerts\", icon=\":material/notification_important:\"\n)\n\nsearch = st.Page(\"tools/search.py\", title=\"Search\", icon=\":material/search:\")\nhistory = st.Page(\"tools/history.py\", title=\"History\", icon=\":material/history:\")\n\nif st.session_state.logged_in:\n pg = st.navigation(\n {\n \"Account\": [logout_page],\n \"Reports\": [dashboard, bugs, alerts],\n \"Tools\": [search, history],\n }\n )\nelse:\n pg = st.navigation([login_page])\n\npg.run()\n```\n\nAnd if you want to use streamlit Navbar, it has to be addapted to this code:\n```python\nimport streamlit as st\n\nst.set_page_config(layout=\"wide\")\n\nif \"logged_in\" not in st.session_state:\n st.session_state.logged_in = False\n\nif \"app_id\" not in st.session_state:\n st.session_state.app_id = None\n\ndef login():\n if st.button(\"Log in\"):\n st.session_state.logged_in = True\n st.session_state.app_id = \"app_default\"\n st.rerun()\n\ndef logout():\n if st.button(\"Log out\"):\n st.session_state.logged_in = False\n st.session_state.app_id = None\n st.rerun()\n\n\nlogin_page = st.Page(login, title=\"Log in\", icon=\":material/login:\")\nlogout_page = st.Page(logout, title=\"Log out\", icon=\":material/logout:\")\n\ndashboard = st.Page(\n \"reports/dashboard.py\", title=\"Dashboard\", icon=\":material/dashboard:\", default=True\n)\nbugs = st.Page(\"reports/bugs.py\", title=\"Bug reports\", icon=\":material/bug_report:\")\nalerts = st.Page(\n \"reports/alerts.py\", title=\"System alerts\", icon=\":material/notification_important:\"\n)\n\nsearch = st.Page(\"tools/search.py\", title=\"Search\", icon=\":material/search:\")\nhistory = st.Page(\"tools/history.py\", title=\"History\", icon=\":material/history:\")\n\n# HERE IS THE CHANGE\nfrom streamlit_plugins.components.navbar import st_navbar, build_menu_from_st_pages\n\nmenu_data, app_map = build_menu_from_st_pages(\n {\"Reports\": [dashboard, bugs, alerts]}, {\"Tools\": [search, history]},\n login_app=login_page,\n logout_app=logout_page,\n)\n\napp_id = st_navbar(\n menu_definition=menu_data if st.session_state.logged_in else [],\n login_name=logout_page.title if st.session_state.logged_in else login_page.title,\n hide_streamlit_markers=False,\n override_app_selected_id=st.session_state.app_id,\n sticky_nav=True, # at the top or not\n sticky_mode='pinned', # sticky or pinned\n)\nif app_id == \"app_login\":\n if st.session_state.logged_in:\n app_id = \"app_logout\"\n\nst.session_state.app_id = None # Added to fix login/logout issue\napp_map[app_id]._can_be_called = True\napp_map[app_id].run()\n\n\n# if st.session_state.logged_in:\n# pg = st.navigation(\n# {\n# \"Account\": [logout_page],\n# \"Reports\": [dashboard, bugs, alerts],\n# \"Tools\": [search, history],\n# },\n# position=\"hidden\"\n# )\n#\n# else:\n# pg = st.navigation([login_page], position=\"hidden\")\n#\n#\n# pg.run()\n```\n\n### Loader (Inherit from Hydralit Components)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Components and Frameworks to give new features to streamlit",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/quiradev/streamlit-plugins"
},
"split_keywords": [
"streamlit",
" plugins",
" framework",
" multipage",
" multilit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce150c3b65c231166679f9a96e1930b4805da393cebb1eb8b777e44d57a6e0f8",
"md5": "43b5e18db1609fce732eddbca3f0aff6",
"sha256": "6169caebae8329cde6faf4364abda2eb0398067bb832a29ab43f428606b64c1d"
},
"downloads": -1,
"filename": "streamlit_framework_multilit-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43b5e18db1609fce732eddbca3f0aff6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18301,
"upload_time": "2024-11-08T10:59:26",
"upload_time_iso_8601": "2024-11-08T10:59:26.233847Z",
"url": "https://files.pythonhosted.org/packages/ce/15/0c3b65c231166679f9a96e1930b4805da393cebb1eb8b777e44d57a6e0f8/streamlit_framework_multilit-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f94002fd20e8e8e7d049111b6ef91ad5a3beeb1f03eca7596d8375f9d42a458d",
"md5": "46d943fbbb87f1889203fd8d8159d037",
"sha256": "86255e5288c27983a36b61c79834efc9faae73aa8e1af7c05747de60e4ed817c"
},
"downloads": -1,
"filename": "streamlit_framework_multilit-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "46d943fbbb87f1889203fd8d8159d037",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 18331,
"upload_time": "2024-11-08T10:59:27",
"upload_time_iso_8601": "2024-11-08T10:59:27.666481Z",
"url": "https://files.pythonhosted.org/packages/f9/40/02fd20e8e8e7d049111b6ef91ad5a3beeb1f03eca7596d8375f9d42a458d/streamlit_framework_multilit-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 10:59:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "quiradev",
"github_project": "streamlit-plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "streamlit-framework-multilit"
}
JSON
