This repository has been archived by the owner on Aug 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 [doc] add components chapter. (#12)
- Loading branch information
Showing
1 changed file
with
38 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,38 @@ | ||
# 介绍 | ||
封装组件 | ||
# 业务组件 | ||
|
||
`components` 目录创建的目的是存放一些与业务强关联的组件。或者官方没有提供的一些特殊组件。 | ||
|
||
## 🕸️目录组织 | ||
|
||
```ts | ||
📁components/ | ||
└── 📁src/ | ||
└── click-outside // 鼠标点击外部触发组件 | ||
└── count-to // 数字动画 | ||
└── countdown-input // 倒计时组件 | ||
└── cropper // 图片裁剪组件 | ||
└── description // 详情组件 | ||
└── icon // 图标库组件 | ||
└── icon-picker // 图标选择组件 | ||
└── qrcode // 二维码组件 | ||
└── scrollbar // 滚动组件 | ||
└── strength-meter // 密码强度组件 | ||
└── svg-icon // svg引用组件 | ||
└── time // 时间组件 | ||
└── transition // 动画组件 | ||
└── virtual-scroll // 虚拟滚动组件 | ||
``` | ||
|
||
## 🔥快速使用 | ||
|
||
在项目模块下导入 `@vben/components` 即可。 | ||
|
||
```js | ||
// 导入 | ||
import { CountTo } from "@vben/components" | ||
|
||
// 使用组件 | ||
<template> | ||
<CountTo ...></CountTo> | ||
</template> | ||
``` |