feat: magic-dash模板新增版本更新日志通知功能

Author: CNFeffery

magic_dash/templates/magic-dash/components/version_changelog_modal.py

@@ -0,0 +1,61 @@
+import os
+
+from dash import dcc
+import feffery_antd_components as fac
+import feffery_markdown_components as fmc
+from dash.dependencies import Input, Output
+
+from server import app
+from configs.base_config import BaseConfig
+
+
+def render():
+    """渲染版本更新日志通知"""
+
+    if BaseConfig.enable_version_changelog_modal:
+        return fac.Fragment(
+            [
+                # 最近一次已读版本标识
+                dcc.Store(
+                    id="core-page-version-changelog-viewed-version",
+                    storage_type="local",
+                ),
+                # 当前版本更新内容模态框
+                fac.AntdModal(
+                    fmc.FefferyMarkdown(
+                        markdownStr=open(
+                            os.path.join(
+                                BaseConfig.version_changelog_markdown_folder,
+                                "{}.md".format(BaseConfig.app_version),
+                            ),
+                            encoding="utf-8",
+                        ).read(),
+                    ),
+                    id="core-page-version-changelog-modal",
+                    title="{}版本更新内容".format(BaseConfig.app_version),
+                    renderFooter=True,
+                    cancelButtonProps={"style": {"display": "none"}},
+                    okText="已阅",
+                ),
+            ]
+        )
+
+
+@app.callback(
+    Output("core-page-version-changelog-modal", "visible"),
+    Input("core-page-version-changelog-viewed-version", "data"),
+)
+def handle_version_changelog_visible(version):
+    """判断是否显示版本更新内容通知"""
+    if version != BaseConfig.app_version:
+        return True
+
+
+@app.callback(
+    Output("core-page-version-changelog-viewed-version", "data"),
+    Input("core-page-version-changelog-modal", "okCounts"),
+    prevent_initial_call=True,
+)
+def update_version_changelog_viewed_version(okCounts):
+    """在用户点击“已阅”后，更新最近一次已读版本标识"""
+    return BaseConfig.app_version

magic_dash/templates/magic-dash/configs/base_config.py

@@ -10,6 +10,12 @@ class BaseConfig:
     # 应用版本
     app_version: str = "0.5.0"
 
+    # 是否启用版本更新日志通知功能，每次的新版本更新日志将在用户点击“已阅”按钮后不再重复展示
+    enable_version_changelog_modal: bool = False
+
+    # 设置版本更新日志通知对应的markdown文件所在目录，目录下文件名格式应为“版本号.md”
+    version_changelog_markdown_folder: str = "changelogs"
+
     # 浏览器最低版本限制规则
     min_browser_versions: List[dict] = [
         {"browser": "Chrome", "version": 88},

magic_dash/templates/magic-dash/requirements.txt

@@ -2,6 +2,7 @@ dash>=3.4.0,<4.0.0
 feffery_antd_components>=0.4.4,<0.5.0
 feffery_dash_utils>=0.2.6
 feffery_utils_components>=0.3.6,<0.4.0
+feffery_markdown_components>=0.4.3
 flask-compress
 user_agents
 yarl

magic_dash/templates/magic-dash/views/core_pages/__init__.py

@@ -4,8 +4,8 @@
 import feffery_utils_components as fuc
 from feffery_dash_utils.style_utils import style
 
-from components import core_side_menu
 from configs import BaseConfig, RouterConfig, LayoutConfig
+from components import core_side_menu, version_changelog_modal
 from views.core_pages import independent_page_demo, independent_wildcard_page_demo
 
 # 令绑定的回调函数子模块生效
@@ -88,6 +88,8 @@ def render(current_pathname: str = None):
             fuc.FefferyFullscreen(
                 id="core-fullscreen",
             ),
+            # 版本更新日志通知
+            version_changelog_modal.render(),
             # 页首
             fac.AntdRow(
                 [