pandora-lib 介绍

pandora 组件库

文档

• 文档示例

安装

yarn

开发模式

Benefited from vite-plugin-pages, the src/pages/index.vue is the entry page for development. You can visit /[component-name]/demo to check component, like http://localhost:3000/#/button/demo.

yarn dev

构建

yarn build

测试

yarn test

生成入口文件

入口文件是 rollup 的 input 选项。

yarn gen-entry

生成一个新的组件

您必须为此命令指定组件名称。

yarn gen [component\'s name]

生成 d.ts 文件

npx esno ./scripts/gen-dts.ts

发布你的组件库

This command will add git tag、generate changelog. You can test your lib with argument --dry

yarn release [--dry]

文档的构建

❗ Noted: you should run yarn build:lib before run this command. Because the docs need the build bundle.

开发文档

yarn docs:dev

构建文档

yarn docs:build

推荐编辑器配置

VSCode + Volar.

如果你使用 <script setup>

<script setup> is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).

此项目离不开以下开源项目

• unplugin-vue
• esbuild-plugin-vue
• vue-dts-gen
• vueuse
• vitepress-for-component
• unocss
• Element Plus