景枫前端公共组件库-web

启动方法

yarn install

yarn dev # demo页面
yarn docs:dev # 文档页面

使用方法

yarn install jf-ui-web

import { createApp } from 'vue'
import App from './App.vue'

// 全量引用
import  JFUI from 'jf-ui-web'
import 'jf-ui-web/dist/style.css'

createApp(App).use(JFUI).mount('#app')

// 按需引用
import JfButton from 'jf-ui-web/dist/button/index.js'
import 'jf-ui-web/dist/button/style.css'

createApp(App).use(JfButton).mount('#app')

组件开发完成后先进行打包

# 仅仅打包全量文件
yarn build

# 分包打包并且全量打包
yarn build:all

# 打包demo页面
yarn build:app

# 打包文档
yarn docs:build

然后在 APP.vue 中进行测试使用 不进行测试用例编写

文档要求

建议在时间允许的情况下编写文档， 建议直接将 antdV (https://github.com/vueComponent/ant-design-vue/tree/main/components) 的对应文档直接拷贝修改放入 docs 目录中 组件文档取 组件源码目录下中文 MD 文档 工程使用 vitepress 进行文档编写

文档预览

yarn docs:dev