123 Star 454 Fork 322

DevUI / vue-devui

Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or Download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

DevUI Logo

Vue DevUI 是 Vue3 版本的 DevUI 组件库,基于 https://github.com/devcloudfe/ng-devui,倡导沉浸灵活至简的设计价值观。

DevUI 官方网站:https://devui.design

想了解DevUI开源的故事,可以阅读以下文章:

DevUI开源的故事

当前状态: Beta

该项目还处于孵化和演进阶段,欢迎大家参与到 Vue DevUI 项目的建设中来!🎉🎉

通过参与 Vue DevUI 项目,你可以:

  • 🔥 学习最新的 Vite+Vue3+TypeScript+JSX 技术
  • 🎁 学习如何设计和开发组件
  • ⭐ 参与到开源社区中来
  • 🎊 结识一群热爱学习、热爱开源的朋友

贡献指南

快速开始

1 安装依赖

yarn(推荐)

or

npm i

2 启动

yarn dev(推荐)

or

npm run dev

3 访问

http://localhost:3000/

4 生产打包

yarn build(推荐)

or

npm run build

使用 Vue DevUI

1. 安装

yarn add vue-devui

2. 全量引入

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

// Step 1: 引入 Vue DevUI 组件库
import DevUI from 'vue-devui'
// Step 2: 引入组件库样式
import 'vue-devui/style.css'

createApp(App)
.use(DevUI) // Step 3: 使用 Vue DevUI
.mount('#app')

3. 按需引入

除了全量引入,我们也支持单个组件按需引入。

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

// Step 1: 引入单个组件
import { Button } from 'vue-devui'
// or import Button from 'vue-devui/button'
// Step 2: 引入组件样式
import 'vue-devui/button/style.css'

createApp(App)
.use(Button) // Step 3: 使用组件
.mount('#app')

4. 使用

<template>
  <d-button>确定</d-button>
</template>

图标库

图标库可以使用DevUI图标库,也可以使用第三方图标库,比如:iconfont。

使用DevUI图标库

安装

yarn add @devui-design/icons(推荐)

or

npm i @devui-design/icons

引入

main.ts文件中,编写以下代码:

import '@devui-design/icons/icomoon/devui-icon.css'

使用

<d-icon name="love" color="red"></d-icon>

使用第三方图标库

如果有第三方图标库,可以用类似的方式引入。

引入

main.ts文件中,编写以下代码:

import 'your-folder/my-icon.css'

使用

<d-icon classPrefix="my-icon" name="love" color="red"></d-icon>

其中的classPrefix参数的值,应该和你的字体图标样式文件my-icon.css里定义的样式前缀保持一致。

比如my-icon.css里的图标样式:

.my-icon-branch-node:before {
	content: "\E001";
}

那么classPrefix就是my-icon

License

MIT

Repository Comments ( 298 )

Sign in to post a comment

About

一个基于 DevUI Design 设计体系的 Vue3 组件库,使用最新的 Vite + Vue3 + TypeScript + JSX 搭建,包含60多个简洁、易用、灵活的组件。 expand collapse
TypeScript and 5 more languages
MIT
Cancel

Releases (18)

All

vue-devui

Contributors

All

Activities

Load More
can not load any more
TypeScript
1
https://gitee.com/devui/vue-devui.git
git@gitee.com:devui/vue-devui.git
devui
vue-devui
vue-devui
dev

Search