ob-toolplat-plugin-info v0.0.13

插件详情页面/pluginInfoPage(Spec)

目录

• 使用
• 样式
• 属性/事件
• 数据
  • 传入/使用
  • 数据结构体
• 依赖项
• 注意事项
• 潜在优化点

安装/引用

• 安装 在package.json中添加依赖项 - "element-ui": "^2.15.6" - "ob-toolplat-plugin-info: "^0.0.10"

  后使用`npm install`安装

• 引用
  • 引用ElementUI依赖 import ElementUI from 'element-ui' import 'element-ui/lib/theme-chalk/index.css' Vue.use(ElementUI)
  • 引用组件 import PluginInfo from 'ob-toolplat-plugin-info' import 'ob-toolplat-plugin-info/lib/ob-toolplat-plugin-info.css' Vue.use(PluginInfo)

使用

html标签为<plugin-info> 样例可参考ob-toolplat-plugin-info/Examples/App.vue

样式

• 主页面+Detail子页

• Dependency/依赖项子页

• Change Log/变更日志子页

• History Version/历史版本子页 --样式待定--

属性/事件

• 属性/Attribute | Attribute name | Type | Description | --- | ----------- |------| | pluginInfo | object | 插件信息 |

属性数据结构体

PluginInfo

• ER-Diagram

ps: pluginInfo.localStatus.enable功能待定，是否变更为start用作开启插件按钮？

• 事件/Event | Event name | Description | Parameter | --- | ----------- |------| | enable | 启用插件 | -- | | disable | 禁用插件 | -- | | install | 安装插件 | -- | | uninstall | 卸载插件 | -- | | beta | 插件切换为Beta版 | -- | | stable | 插件切换为稳定版 | -- |

依赖项

• ElementUI: "element-ui": "^2.4.5",
• Marked.js: "marked": "^4.0.12",
• github-markdown-css: "github-markdown-css": "^5.1.0",
• highlight.js: "highlight.js": "^11.5.0"

注意事项

• pluginInfo.iconSrc为插件图标的url，而非路径
• pluginInfo.markdown中的数据为.md格式的单行字符串，.md文件获取和转换为单行字符串的功能考虑是在vue上做还是数据库端做？

潜在优化点

• 数据结构体pluginInfo可考虑拆未两部分，一部分为主要信息primary，一部分为次要信息secondary，对于详细页面组件可提供两部分信息，而对于插件次要信息中的依赖项列表和插件列表组件可仅提供主要信息，能减少传输数据量