Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 2.58 KB

配置参数.md

File metadata and controls

40 lines (31 loc) · 2.58 KB

magic-dash配置参数

magic-dash的配置集中在configs/目录,主要由BaseConfig、LayoutConfig和RouterConfig三类组成。

configs/base_config.py

参数 类型 默认值 说明
app_title str "Magic Dash" 应用标题,会影响浏览器标题和页面展示
app_version str "dev" 应用版本;通过CLI创建项目时会被替换为当前magic-dash版本
enable_version_changelog_modal bool False 是否启用版本更新日志通知弹窗
version_changelog_markdown_folder str "changelogs" 更新日志Markdown文件目录,文件名建议使用版本号.md
min_browser_versions List[dict] Chrome88、Firefox78、Edge100 浏览器最低版本限制规则
strict_browser_type_check bool False 是否拦截不在规则内的浏览器类型

configs/layout_config.py

参数 类型 默认值 说明
core_side_width int 350 核心页面侧边栏宽度,单位为像素
core_layout_type "single" | "tabs" "single" 核心页面展示方式:单页面或多标签页
show_core_page_search bool True 是否在页首显示页面搜索框

configs/router_config.py

参数 类型 说明
index_pathname str 应用首页对应的pathname
core_side_menu List[dict] 侧边菜单结构,菜单项的key、href通常与页面pathname对齐
wildcard_patterns dict 通配页面正则规则
valid_pathnames dict 有效页面pathname到页面标题的映射
independent_core_pathnames List[Union[str, re.Pattern]] 不嵌入核心布局、独立渲染的核心页面
side_menu_open_keys dict 指定pathname访问时默认展开的侧边菜单层级

配置修改原则

  • 新增核心页面时,通常需要同步维护core_side_menu、valid_pathnames和components/page_content.py中的页面渲染分发逻辑。
  • 新增独立页面时,需要将pathname加入valid_pathnames和independent_core_pathnames,并在views/core_pages/__init__.py中补充独立渲染分支。
  • 新增通配页面时,先在wildcard_patterns中定义正则,再把对应正则对象加入valid_pathnames;若作为独立通配页面渲染,还需要加入independent_core_pathnames并在views/core_pages/__init__.py中补充匹配后的渲染分支。
  • 调整侧边菜单层级后,检查side_menu_open_keys,确保子菜单访问时能正确展开。