• 官网主页: vite-nice-ui使用文档

• 国内访问: vite-nice-ui使用文档

快速使用

npm install  vite-nice-ui
cnpm install  vite-nice-ui --save

全局引入 (不推荐)

import { createApp } from 'vue'
import App from '@/App.vue'
import NiceUI from 'vite-nice-ui'
import 'vite-nice-ui/dist/style.css'

const app = createApp(App)
app.use(NiceUI)
app.mount('#app')

按需引用 (推荐)

import { NButton, NInput } from 'vite-nice-ui'

愉快开始

<n-button>默认按钮</n-buttonn> 
<n-button type="primary">主要按钮</n-button>

开发环境

• 你需要 Node.js 14+，yarn 1.1+ 和 npm 6+及 vite 2+

• 如果您在使用yarn安装依赖的过程中出现esline检查不通过，请执行：

  yarn config set ignore-engines true

vue项目启动

npm run dev

vue项目打包

npm run build

vitepress项目启动

npm run doc:dev

vitepress项目打包

npm run doc:build

自动发布 npm 包

npm run pub

自动部署 github pages

npm run deploy

组件开发规范

• 通过在 packages 目录下创建组件目录结构，包含ts入口文件、组件源码文件。

• 组件入口文件必须以 index.ts 命名。

• 只需将组件导出，packages 目录下的index文件会自动引入所有组件并注册install方法，参考代码：

  export { default as NButton } from './NButton';

问题反馈

• 如果您在使用中存在 bug 或者有更超前的思想及解决方案，不限于新的组件、新的模式、新的思想、新的方案，您可以在 Issue 提交问题，我们会定时进行维护并回复。
• 或您可发送邮件至 [email protected] 来反馈或参与贡献。