@wlydfe/pro-ui 0.2.19 → 0.2.21

package/README.zh-CN.md

@@ -0,0 +1,120 @@
+<p align="center">
+  <img width="180px" src="https://plus-pro-components.github.io/logo.png">
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/plus-pro-components">
+    <img src="https://img.shields.io/npm/v/plus-pro-components.svg?style=flat-square" />
+  </a>
+  <a href="https://vitepress.dev/">
+    <img src="https://img.shields.io/badge/docs%20by-vitepress-10b981" />
+  </a>
+  <a href="https://rollupjs.org/">
+    <img src="https://img.shields.io/badge/build%20with-rollup-646cff.svg" />
+  </a>
+  <a href="https://www.pnpm.cn/">
+    <img src="https://img.shields.io/badge/maintained%20with-pnpm-cc00ff.svg" />
+  </a>
+  <a href="https://element-plus.org/">
+    <img src="https://img.shields.io/badge/ui%20width-element%20plus-409eff.svg" />
+  </a>
+  <a href="https://npmcharts.com/compare/plus-pro-components?minimal=true">
+    <img src="https://img.shields.io/npm/dm/plus-pro-components" />
+  </a>
+  <br>
+</p>
+
+# plus-pro-components
+
+**页面级别的前端组件**
+
+**中文** | [English](https://github.com/plus-pro-components/plus-pro-components/blob/dev/README.md)
+
+## 文档
+
+[文档](https://plus-pro-components.github.io/)| [国内镜像文档](https://plus-pro-components.com)
+
+## 简介
+
+plus-pro-components 是一个基于 Vue 和 element-plus 的页面级别的组件库，它具有以下优点：
+
+- 功能强大：plus-pro-components 的组件不仅提供了基本的 UI 展示功能，还具备了复杂的数据操作和业务逻辑处理能力，能够快速构建出功能强大的企业应用。
+
+- 易于使用：plus-pro-components 提供了简单易用的 API 和完善的文档，使得开发者能够快速上手并使用其中的组件。
+
+- 高度可定制：plus-pro-components 的组件支持多种配置和样式自定义，能够满足不同项目的需求。
+
+- 兼容 element-plus：plus-pro-components 100%兼容和 element-plus 同名的组件，包括属性，事件，方法，插槽等。
+
+- 丰富的组件库：plus-pro-components 基于 element-plus 提供了大量的 UI 组件，包括表格、表单、布局等，能够满足大多数企业应用的需求。
+
+- 使用 TypeScript：plus-pro-components 全量使用 TypeScript 编写，和你的 TypeScript 项目无缝衔接。
+
+- 国际化： plus-pro-components 提供完备的国际化，与 element-plus 体系打通，无需多余配置。
+
+- 预设： plus-pro-components 预设基本的样式，与 element-plus 样式一脉相承。 plus-pro-components 预设基本的行为，更少的代码具备更多的功能。
+
+# 高级组件列表
+
+- [x] Table 表格 -- 完成
+- [x] Search 搜索 -- 完成
+- [x] Page 页面 -- 完成
+- [x] Form 表单 -- 完成
+- [x] DialogForm 弹窗表单 -- 完成
+- [x] DrawerForm 抽屉表单 -- 完成
+- [x] Descriptions 详情 -- 完成
+- [x] Layout 布局 -- 完成
+
+# 内置组件列表
+
+- [x] Dialog 弹窗 -- 完成
+- [x] Pagination 分页 -- 完成
+- [x] Radio 单选 -- 完成
+- [x] DatePicker 日期 -- 完成
+- [x] InputTag 输入标签 -- 完成
+- [x] DisplayItem 单项显示 -- 完成
+- [x] FormItem 表单单项 -- 完成
+- [x] Sidebar 侧边菜单 -- 完成
+- [x] Breadcrumb 面包屑 -- 完成
+- [x] Header 页头 -- 完成
+
+## 缺点
+
+plus-pro-components 是一个基于 Vue 和 element-plus 的组件库，它提供了很多常用的 UI 组件和业务组件，可以方便地帮助开发者快速搭建前端页面。虽然 plus-pro-components 具有很多优点，但是也有以下一些缺点：
+
+- 学习成本较高：plus-pro-components 的组件库比较复杂，学习所有组件可能需要花费较长时间。因此，对于新手开发者来说，学习成本可能会比较高。
+
+- 高度可定制有限：plus-pro-components 的组件支持高度可定制，但是任然不可能保证组件 100%完全自定义，定制需求非常高的项目谨慎使用。
+
+## 🖥 浏览器兼容性
+
+- 现代浏览器
+
+| [![edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png)](http://godban.github.io/browsers-support-badges/) |
+| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Edge                                                                                                                                              | last 2 versions                                                                                                                                         | last 2 versions                                                                                                                                         | last 2 versions                                                                                                                                         |
+
+## 贡献
+
+在贡献代码之前请阅读[贡献指南
+](https://plus-pro-components.com/guide/contribution.html) 和 [本地开发指南](https://plus-pro-components.com/guide/dev.html) 。
+
+感谢所有已经为 plus-pro-components 组件做出贡献的人！
+
+<a href="https://github.com/plus-pro-components/plus-pro-components/graphs/contributors"><img src="https://opencollective.com/plus-pro-components/contributors.svg?width=890" /></a>
+
+## 捐赠
+
+如果你觉得这个项目帮助到了你，你可以帮作者买一杯果汁表示鼓励 🍹
+
+| 微信                                                                                                           | 支付宝                                                                                                          |
+| -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| <img src="https://plus-pro-components-1252186245.cos.ap-chengdu.myqcloud.com/wx.jpg" height="188" width="188"> | <img src="https://plus-pro-components-1252186245.cos.ap-chengdu.myqcloud.com/ali.jpg" height="188" width="188"> |
+
+感谢所有已经为 plus-pro-components 组件做出捐赠的人！[捐赠列表](https://plus-pro-components.com/donate.html#%E6%8D%90%E8%B5%A0%E8%80%85%E5%90%8D%E5%8D%95)
+
+## LICENSE
+
+MIT
+
+Copyright (c) 2023-present, xiaofei

package/commitlint.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      ['feat', 'fix', 'build', 'docs', 'test', 'style', 'ci', 'refactor', 'perf', 'chore', 'revert']
+    ],
+    'subject-full-stop': [0, 'never'],
+    'subject-case': [0, 'never']
+  }
+}

package/docs/.vitepress/config.ts

@@ -0,0 +1,392 @@
+import { defineConfig, HeadConfig } from 'vitepress'
+import llmstxt from 'vitepress-plugin-llms'
+import { mdPlugin } from './plugins/mdPlugin'
+import pkg from '../../package.json'
+
+// 生产环境判断
+const isEnvProduction = process.env.NODE_ENV === 'production'
+
+const content = [
+  'vue 版本的 procomponents',
+  'vue procomponents',
+  'procomponents vue',
+  'PlusProComponents',
+  'plus-pro-components',
+  'element-plus',
+  'Page level components',
+  'component library',
+  'ui framework',
+  'ui',
+  'vue'
+].toString()
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  base: '/',
+  title: 'PlusProComponents',
+  description: content,
+  head: [
+    ['meta', { name: 'author', content: 'xiaofei' }],
+    [
+      'meta',
+      {
+        name: 'viewport',
+        content:
+          'width=device-width,initial-scale=1,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no'
+      }
+    ],
+    [
+      'meta',
+      {
+        name: 'description',
+        content
+      }
+    ],
+    ['meta', { name: 'keywords', content }],
+    ...((isEnvProduction ? [['script', { src: '/hmt.js' }]] : []) as unknown as HeadConfig[]),
+    ['script', { src: '/style.js' }],
+    ['script', { src: '/iconfont-symbol.js' }],
+    ['link', { rel: 'icon', href: '/logo.png' }]
+  ],
+  lang: 'zh-CN',
+  themeConfig: {
+    search: {
+      provider: 'local'
+    },
+    darkModeSwitchLabel: '主题',
+    sidebarMenuLabel: '菜单',
+    returnToTopLabel: '返回顶部',
+    outlineTitle: '本页导航',
+    lastUpdatedText: '上次更新时间',
+    docFooter: {
+      prev: '上一页',
+      next: '下一页'
+    },
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: '首页', link: '/' },
+      { text: '指南', link: '/guide/' },
+      {
+        text: '组件',
+        link: '/components/type'
+      },
+      {
+        text: '捐赠',
+        link: '/donate'
+      },
+      {
+        text: '常见问题',
+        link: '/components/QA.html'
+      },
+      {
+        text: '生态系统',
+        items: [
+          {
+            text: 'Utils',
+            link: '/api/utils/'
+          },
+          {
+            text: 'Hooks',
+            link: '/ecosystem/hooks'
+          },
+          {
+            text: 'Resolver',
+            link: '/ecosystem/resolver'
+          },
+          {
+            text: 'Eslint Config',
+            link: '/ecosystem/eslint-config'
+          }
+        ]
+      },
+      {
+        text: `v${pkg.version}`,
+        items: [
+          {
+            text: '版本升级',
+            link: '/guide/upgrade'
+          },
+          {
+            text: '推荐版本',
+            link: '/guide/changelog.html#推荐版本'
+          },
+          {
+            text: '历史版本',
+            link: 'https://github.com/plus-pro-components/plus-pro-components/releases'
+          },
+          {
+            text: '更新日志',
+            link: 'https://github.com/plus-pro-components/plus-pro-components/blob/dev/CHANGELOG.md'
+          }
+        ]
+      },
+      {
+        text: '演练场',
+        link: 'http://playground.plus-pro-components.com/'
+      }
+    ],
+    sidebar: {
+      '/guide/': [
+        {
+          text: '简介',
+          items: [
+            {
+              text: '简介',
+              link: '/guide/index'
+            }
+          ]
+        },
+        {
+          text: '基础',
+          items: [
+            {
+              text: '安装',
+              link: '/guide/installation'
+            },
+            {
+              text: '快速开始',
+              link: '/guide/quickstart'
+            }
+          ]
+        },
+        {
+          text: '进阶',
+          items: [
+            {
+              text: '国际化',
+              link: '/guide/i18n'
+            },
+            {
+              text: '版本升级',
+              link: '/guide/upgrade'
+            },
+            {
+              text: '命名空间',
+              link: '/guide/namespace'
+            },
+            {
+              text: '暗黑模式',
+              link: '/guide/dark-mode'
+            },
+            {
+              text: '更新日志',
+              link: '/guide/changelog'
+            },
+            {
+              text: '组件设计',
+              link: '/guide/design'
+            }
+          ]
+        },
+        {
+          text: '开发',
+          items: [
+            {
+              text: '开发指南',
+              link: '/guide/dev'
+            },
+            {
+              text: '贡献指南',
+              link: '/guide/contribution'
+            }
+          ]
+        }
+      ],
+      '/components/': [
+        {
+          text: '基础',
+          items: [
+            {
+              text: '基础Ts类型',
+              link: '/components/type'
+            },
+            {
+              text: '高级组件通用配置',
+              link: '/components/config'
+            },
+            {
+              text: '事件和样式透传',
+              link: '/components/attrs'
+            },
+            {
+              text: '组件自定义总则',
+              link: '/components/rule'
+            }
+          ]
+        },
+        {
+          text: '高级组件',
+          items: [
+            {
+              text: '布局',
+              link: '/components/layout'
+            },
+            {
+              text: '多选卡片组',
+              link: '/components/check-card-group'
+            },
+            {
+              text: '表格',
+              link: '/components/table'
+            },
+            {
+              text: '表单',
+              link: '/components/form',
+              items: [
+                {
+                  text: '基础表单',
+                  link: '/components/form'
+                },
+                {
+                  text: '弹窗表单',
+                  link: '/components/dialog-form'
+                },
+                {
+                  text: '抽屉表单',
+                  link: '/components/drawer-form'
+                },
+                {
+                  text: '分步表单',
+                  link: '/components/steps-form'
+                }
+              ]
+            },
+            {
+              text: '搜索',
+              link: '/components/search'
+            },
+            {
+              text: '描述列表',
+              link: '/components/descriptions'
+            },
+            {
+              text: '页面',
+              link: '/components/page'
+            }
+          ]
+        },
+        {
+          text: '常见问题',
+          link: '/components/QA'
+        },
+        {
+          text: '内置组件',
+          items: [
+            {
+              text: '弹窗',
+              link: '/components/dialog'
+            },
+            {
+              text: '弹出框',
+              link: '/components/popover'
+            },
+            {
+              text: '分页',
+              link: '/components/pagination'
+            },
+            {
+              text: '单选',
+              link: '/components/radio'
+            },
+            {
+              text: '日期时间',
+              link: '/components/date-picker'
+            },
+            {
+              text: '输入标签',
+              link: '/components/input-tag'
+            },
+            {
+              text: '显示单项组件',
+              link: '/components/display-item'
+            },
+            {
+              text: '表单单项组件',
+              link: '/components/form-item'
+            },
+            {
+              text: '面包屑',
+              link: '/components/breadcrumb'
+            },
+            {
+              text: '页头',
+              link: '/components/header'
+            },
+            {
+              text: '侧边栏',
+              link: '/components/sidebar'
+            },
+            {
+              text: '可选择卡片',
+              link: '/components/check-card'
+            }
+          ]
+        }
+      ],
+      '/api/': [
+        {
+          text: '工具utils',
+          link: '/api/utils/',
+          items: [
+            {
+              text: '时间',
+              link: '/api/utils/day'
+            },
+            {
+              text: '数字',
+              link: '/api/utils/number'
+            },
+            {
+              text: 'AES加密',
+              link: '/api/utils/encrypt'
+            },
+            {
+              text: '存储',
+              link: '/api/utils/storage'
+            },
+            {
+              text: 'cookie',
+              link: '/api/utils/cookie'
+            },
+            {
+              text: '文件',
+              link: '/api/utils/file'
+            },
+            {
+              text: '判断',
+              link: '/api/utils/is'
+            },
+            {
+              text: '校验',
+              link: '/api/utils/validate'
+            },
+            {
+              text: '其他',
+              link: '/api/utils/other'
+            }
+          ]
+        }
+      ]
+    },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/plus-pro-components/plus-pro-components' }
+    ],
+    footer: {
+      message: 'MIT Licensed.',
+      copyright:
+        'Copyright © 2023-present xiaofei <a class="miit-link" style="color: var(--vp-c-brand);" href="https://beian.miit.gov.cn" class="fake-link black-70 ph1">陕ICP备2021003270号-2</a>'
+    },
+    editLink: {
+      text: '在 GitHub 上编辑此页',
+      pattern: 'https://github.com/plus-pro-components/plus-pro-components/edit/dev/docs/:path'
+    }
+  },
+  lastUpdated: true,
+  markdown: {
+    lineNumbers: true,
+    config: md => mdPlugin(md)
+  },
+  vite: {
+    plugins: [llmstxt()]
+  }
+})

package/docs/.vitepress/plugins/mdPlugin.ts

@@ -0,0 +1,41 @@
+import path from 'path'
+import fs from 'fs'
+import MarkdownIt from 'markdown-it'
+import mdContainer from 'markdown-it-container'
+import type Token from 'markdown-it/lib/token'
+import type Renderer from 'markdown-it/lib/renderer'
+
+const docRoot = path.resolve(__dirname, '../../')
+
+interface ContainerOpts {
+  marker?: string | undefined
+  validate?(params: string): boolean
+  render?(tokens: Token[], index: number, options: any, env: any, self: Renderer): string
+}
+
+export const mdPlugin = (md: MarkdownIt) => {
+  md.use(mdContainer, 'demo', {
+    validate(params) {
+      return !!params.trim().match(/^demo\s*(.*)$/)
+    },
+
+    render(tokens, idx) {
+      if (tokens[idx].nesting === 1 /* means the tag is opening */) {
+        const sourceFileToken = tokens[idx + 2]
+        let source = ''
+        const sourceFile = sourceFileToken.children?.[0].content ?? ''
+
+        if (sourceFileToken.type === 'inline') {
+          source = fs.readFileSync(path.resolve(docRoot, 'examples', `${sourceFile}.vue`), 'utf-8')
+        }
+        if (!source) throw new Error(`Incorrect source file: ${sourceFile}`)
+
+        return `<DocsCodeDemo  source="${encodeURIComponent(
+          source
+        )}" path="${sourceFile}" raw-source="${encodeURIComponent(source)}" >`
+      } else {
+        return '</DocsCodeDemo>'
+      }
+    }
+  } as ContainerOpts)
+}

package/docs/.vitepress/theme/components/docs-changelog.vue

@@ -0,0 +1,105 @@
+<script setup lang="ts">
+import { onMounted, ref } from 'vue'
+import axios from 'axios'
+
+interface Release {
+  id: number
+  name: string
+}
+
+const loading = ref(true)
+const releases = ref<Release[]>([])
+const currentRelease = ref()
+
+const onVersionChange = (val: string) => {
+  const _releases = releases.value
+  currentRelease.value = _releases[_releases.findIndex(r => r.name === val)]
+}
+
+onMounted(async () => {
+  try {
+    const { data } = await axios.get<Release[]>(
+      'https://api.github.com/repos/plus-pro-components/plus-pro-components/releases'
+    )
+    releases.value = data
+    currentRelease.value = data[0]
+  } catch {
+    releases.value = []
+    currentRelease.value = undefined
+    // do something
+  } finally {
+    loading.value = false
+  }
+})
+</script>
+
+<template>
+  <div class="docs-changelog">
+    <ClientOnly>
+      <el-skeleton :loading="loading">
+        <div class="docs-changelog-versions">
+          <p class="docs-changelog-text">请选择版本:</p>
+          <el-select
+            :model-value="currentRelease.name"
+            placeholder="请选择版本"
+            style="min-width: 200px"
+            @change="onVersionChange"
+          >
+            <el-option v-for="release in releases" :key="release.id" :value="release.name">
+              {{ release.name }}
+            </el-option>
+          </el-select>
+        </div>
+        <el-card v-if="currentRelease">
+          <template #header>
+            <div class="docs-changelog-header">
+              <div class="docs-changelog-meta">
+                <p class="docs-changelog-by">
+                  发布者
+                  <strong>{{ currentRelease.author.login }}</strong>
+                </p>
+                <p class="docs-changelog-date">
+                  {{ new Date(currentRelease.published_at).toLocaleString() }}
+                </p>
+              </div>
+              <div class="docs-operators">
+                <a :href="currentRelease.html_url" style="color: #409eff"> 链接 </a>
+              </div>
+            </div>
+          </template>
+          <div>
+            <DocsMarkdown :content="currentRelease.body" />
+          </div>
+        </el-card>
+      </el-skeleton>
+    </ClientOnly>
+  </div>
+</template>
+
+<style lang="scss" scoped>
+.docs-changelog-versions {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  margin-bottom: 1rem;
+
+  .docs-changelog-text {
+    margin-right: 10px;
+    flex: 0 0 86px;
+  }
+}
+.docs-changelog-header {
+  display: flex;
+  align-items: flex-start;
+  justify-content: space-between;
+
+  .docs-changelog-meta {
+    display: flex;
+    flex: 1;
+    flex-direction: column;
+    p {
+      margin: 0;
+    }
+  }
+}
+</style>