Streamlit-Pages技术文档

Streamlit-Pages是一个专为Streamlit应用程序设计的库，旨在简化多页面应用的管理和导航。它通过.toml文件配置页面结构，提供了一种直观的方式去组织和控制你的Streamlit项目中的各个部分。以下是使用Streamlit-Pages进行项目设置、操作及自定义的全面指南。

安装指南

要安装Streamlit-Pages，只需在命令行执行以下命令：

pip install st-pages

这将把最新的Streamlit-Pages包添加到你的Python环境中。确保你的环境支持所需的Python版本（具体到此项目支持的版本，参考其PyPI badge）。

项目使用说明

初始化与配置

Streamlit-Pages的核心在于使用.toml文件来声明你的应用程序页面。创建或编辑.streamlit/pages.toml（或.streamlit/pages_sections.toml以支持分段）来定义你的页面路径、名称以及图标。

基础配置示例:

[[pages]]
path = "page1.py"
name = "首页"
icon = "🏠"

[[pages]]
path = "other_pages/page2.py"
name = "第二页"
icon = ":books:"

流程集成

在你的Streamlit脚本中，首先导入必要的模块，并调用相关函数来实现页面切换和标题显示。

import streamlit as st
from st_pages import add_page_title, get_nav_from_toml

st.set_page_config(layout="wide")

# 加载页面导航配置
nav = get_nav_from_toml(".streamlit/pages.toml")  # 或者使用 ".streamlit/pages_sections.toml"

# 显示logo（假设logo.png位于当前目录）
st.logo("logo.png")

# 使用导航配置
pg = st.sidebar.navigation(nav)

# 添加当前页面标题
add_page_title(pg)

# 运行当前页面代码
pg.run()

隐藏页面

若需要为特定用户隐藏某些页面，可以使用hide_pages函数，传递一个页面名列表作为参数。

from st_pages import hide_pages

hide_pages(["第二页"])  # 隐藏名为“第二页”的页面

项目API使用文档

• get_nav_from_toml(path): 根据提供的.toml文件路径加载导航数据。
• add_page_title(page): 在每个页面上自动添加页面标题。
• hide_pages(pages_to_hide): 动态地从导航中隐藏指定的页面，页面隐藏效果对每个用户独立。

项目安装方式

再次强调，安装Streamlit-Pages，简单执行pip install st-pages即可快速集成进你的Python环境和Streamlit项目中。

遵循以上步骤，你可以高效地管理一个多页面的Streamlit应用程序，为用户提供清晰的导航体验，同时保持代码结构的整洁和可维护性。