# vangle
**Repository Path**: vangleer/vangle
## Basic Information
- **Project Name**: vangle
- **Description**: Vue3 UI Components Library
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 20
- **Forks**: 11
- **Created**: 2022-08-24
- **Last Updated**: 2025-01-04
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Vange ⚡
Vue3 UI Components Library
> 注:该仓库主要记录从 0 搭建一个组件库的方法,包括组件文档的编写
[在线预览 github](https://vangleer.github.io/vangle)
[在线预览 gitee]( http://vangleer.gitee.io/vangle)
## 克隆代码到本地
```shell
# github
git clone https://github.com/vangleer/vangle.git
# gitee
git clone https://gitee.com/vangleer/vangle.git
```
## 安装依赖
```
pnpm install
```
## 命令介绍
```shell
# 本地开发环境
pnpm docs:dev
# 打包组件库
pnpm build
# 发布到 npm,tips: 需要将npm的registry切换到原始的(https://registry.npmjs.org/)并提前登录
pnpm release
# 工具命令: 创建要开发的组件,此命令回创建组件的基本文件和添加文档
pnpm gen ComponentName
# 工具命令: 删除组件,会删除与该组件相关的文件和文档
pnpm del ComponentName
```
## ⚡ 使用说明
#### 安装依赖
```
npm install vangle
```
### 全局注册
如果你对打包后的文件大小不是很在乎,那么使用完整导入会更方便。
```typescript
// main.ts
import { createApp } from 'vue'
import 'vangle/dist/style.css'
import Vangle from 'vangle'
import App from './App.vue'
createApp(App).use(Vangle).mount('#app')
```
- 使用
```html
Default
Primary
Success
Info
Warning
Danger
```
### 组件中直接使用
```html
Default
```
### 浏览器直接引入
直接通过浏览器的 HTML 标签导入 vangle,然后就可以使用全局变量 ESDrager 了。
```html
Document
Default
Primary
Success
Info
Warning
Danger
```