zhenxun_bot/zhenxun/ui/models/presets/plugin_help_page.py
webjoin111 f89d677def feat(ui): 增强表格构建器并完善组件模型文档
- 增强 `TableBuilder`,新增 `_normalize_cell` 辅助方法,支持自动将原生数据类型(如 `str`, `int`, `Path`)转换为 `TableCell` 模型,简化了表格行的创建。
- 完善 `zhenxun/ui/models` 目录下所有组件模型字段的 `description` 属性和文档字符串,显著提升了代码可读性和开发者体验。
- 优化 `shop/_data_source.py` 中 `gold_rank` 函数的平台路径判断格式,并统一 `my_props` 函数中图标路径的处理逻辑。
2025-09-09 20:35:46 +08:00

49 lines
1019 B
Python

from pydantic import BaseModel
from ..core.base import RenderableComponent
__all__ = [
"HelpCategory",
"HelpItem",
"PluginHelpPageData",
]
class HelpItem(BaseModel):
"""帮助菜单中的单个功能项"""
name: str
"""功能名称"""
description: str
"""功能描述"""
usage: str
"""功能用法说明"""
class HelpCategory(BaseModel):
"""帮助菜单中的一个功能类别"""
title: str
"""分类标题"""
icon_svg_path: str
"""分类图标的SVG路径数据"""
items: list[HelpItem]
"""该分类下的功能项列表"""
class PluginHelpPageData(RenderableComponent):
"""通用插件帮助页面的数据模型"""
style_name: str | None = None
"""页面样式名称"""
bot_nickname: str
"""机器人昵称"""
page_title: str
"""页面主标题"""
categories: list[HelpCategory]
"""帮助分类列表"""
@property
def template_name(self) -> str:
return "pages/core/plugin_help_page"