element-pro-components

element-pro-components 是一个基于 element-plus (opens new window), vue (opens new window), vue-router (opens new window) 的一个适用于中后台快速开发的一套组件库

# 起因

在工作中需要开发及维护多个后台管理系统。经常在想如何更优雅的处理不同项目间的协同开发,尝试过 git单模板多项目的探索 的方法优化,但还是觉得不够彻底。增加公共功能和修复公共的BUG,都需要前往 template 项目修改,完成后手动同步到各个需要的项目。后来尝试将公共的组件分离到一个单独的本地仓库中,通过 npm 能够安装本地包的特点,在需要的项目中安装。这样安装、修改、更新比起 template 都要方便不少,于是就有了做这个项目的想法。

当然这也仅仅是一个自用顺带分享的项目,不太可能像一些模版项目完善。它的目标不是代替模版项目,而是提供一套简单的组件任你自由发挥制作一套属于自己的模版项目

# 优势

  • 通过更新依赖版本及可同步组件变动,方便使用
  • 不需要花时间精简模版中未使用的依赖
  • 支持按需引入组件及样式
  • api 风格贴近 element-plus
  • 基于 TypeScript 开发,完善的类型推断
  • 与业务完全脱离,避免不同业务的组件混用产生错误
  • 提供完善的代码提示

# 组件

# 布局相关

# 表单相关

# 表格相关

# 其它

# 国际化

同 elememt-plus 一样可以通过 ElConfigProvider 注入国际化配置,暂未提供配置文件

# 自定义主题

TODO: 等待 elememt-plus 深色主题推出后会相关进行同步更新。目前可以直接通过 css-variables 修改

# 路由格式

由于布局相关的组件需要从 vue-router 中获取路由信息,我们规范了路由格式详细可以查看 路由和菜单 (opens new window)

# 贡献

组件库还处于开发阶段,部分功能还需要完善。如果你希望参与贡献,欢迎 Pull Request (opens new window)。如果只是简单的文档相关的错误修正,你可以直接 PR。但如果是 BUG、新功能、新组件等,最好优先提 issues (opens new window)

git 提交信息风格参考 vue commit-convention (opens new window)

# 链接

文档 (opens new window) 文档也是基于组件库开发的

源码 (opens new window)

components-helper

components-helper

components-helper 是一个通过解析 markdown 文档为 vue 组件库生成代码提示的工具

vuepress-plugin-last-reading

vuepress-plugin-last-reading

该插件在页面关闭时,记录当前浏览的位置信息。用来在下一次访问时,展示一个前往该位置的弹窗