From 785cda4112db74577e37be6c31143c917adbfbac Mon Sep 17 00:00:00 2001
From: xiaojiujiu <3507440900@qq.com>
Date: Sun, 31 Oct 2021 12:07:36 +0800
Subject: [PATCH 1/8] =?UTF-8?q?=E6=8F=90=E4=BA=A4=E7=BB=84=E4=BB=B6?=
=?UTF-8?q?=E5=9B=BD=E9=99=85=E5=8C=96=E6=96=87=E4=BB=B6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en-US/components/accordion/index.md | 4 +
docs/en-US/components/alert/index.md | 23 +
docs/en-US/components/anchor/demo.tsx | 35 +
docs/en-US/components/anchor/index.md | 80 +
docs/en-US/components/avatar/index.md | 23 +
docs/en-US/components/badge/index.md | 178 +++
docs/en-US/components/button/index.md | 27 +
docs/en-US/components/card/index.md | 220 +++
docs/en-US/components/carousel/index.md | 162 ++
docs/en-US/components/checkbox/index.md | 42 +
docs/en-US/components/date-picker/index.md | 121 ++
docs/en-US/components/icon/index.md | 71 +
docs/en-US/components/image-preview/index.md | 137 ++
docs/en-US/components/input/index.md | 96 ++
docs/en-US/components/loading/index.md | 298 ++++
docs/en-US/components/overlay/index.md | 198 +++
docs/en-US/components/pagination/index.md | 473 ++++++
docs/en-US/components/panel/index.md | 74 +
docs/en-US/components/popover/index.md | 386 +++++
docs/en-US/components/progress/index.md | 142 ++
.../components/quadrant-diagram/index.md | 44 +
docs/en-US/components/radio/index.md | 307 ++++
docs/en-US/components/rate/index.md | 138 ++
docs/en-US/components/search/index.md | 95 ++
docs/en-US/components/select/index.md | 175 +++
docs/en-US/components/slider/index.md | 128 ++
docs/en-US/components/status/index.md | 26 +
docs/en-US/components/sticky/index.md | 139 ++
docs/en-US/components/switch/index.md | 66 +
docs/en-US/components/tabs/index.md | 7 +
docs/en-US/components/tag-input/index.md | 44 +
docs/en-US/components/toast/index.md | 611 ++++++++
docs/en-US/components/tooltip/index.md | 100 ++
docs/en-US/components/transfer/index.md | 224 +++
docs/en-US/components/upload/index.md | 1297 +++++++++++++++++
docs/en-US/design.md | 1 +
docs/en-US/index.md | 43 +
docs/en-US/theme.md | 1 +
docs/en-US/version.md | 1 +
39 files changed, 6237 insertions(+)
create mode 100644 docs/en-US/components/accordion/index.md
create mode 100644 docs/en-US/components/alert/index.md
create mode 100644 docs/en-US/components/anchor/demo.tsx
create mode 100644 docs/en-US/components/anchor/index.md
create mode 100644 docs/en-US/components/avatar/index.md
create mode 100644 docs/en-US/components/badge/index.md
create mode 100644 docs/en-US/components/button/index.md
create mode 100644 docs/en-US/components/card/index.md
create mode 100644 docs/en-US/components/carousel/index.md
create mode 100644 docs/en-US/components/checkbox/index.md
create mode 100644 docs/en-US/components/date-picker/index.md
create mode 100644 docs/en-US/components/icon/index.md
create mode 100644 docs/en-US/components/image-preview/index.md
create mode 100644 docs/en-US/components/input/index.md
create mode 100644 docs/en-US/components/loading/index.md
create mode 100644 docs/en-US/components/overlay/index.md
create mode 100644 docs/en-US/components/pagination/index.md
create mode 100644 docs/en-US/components/panel/index.md
create mode 100644 docs/en-US/components/popover/index.md
create mode 100644 docs/en-US/components/progress/index.md
create mode 100644 docs/en-US/components/quadrant-diagram/index.md
create mode 100644 docs/en-US/components/radio/index.md
create mode 100644 docs/en-US/components/rate/index.md
create mode 100644 docs/en-US/components/search/index.md
create mode 100644 docs/en-US/components/select/index.md
create mode 100644 docs/en-US/components/slider/index.md
create mode 100644 docs/en-US/components/status/index.md
create mode 100644 docs/en-US/components/sticky/index.md
create mode 100644 docs/en-US/components/switch/index.md
create mode 100644 docs/en-US/components/tabs/index.md
create mode 100644 docs/en-US/components/tag-input/index.md
create mode 100644 docs/en-US/components/toast/index.md
create mode 100644 docs/en-US/components/tooltip/index.md
create mode 100644 docs/en-US/components/transfer/index.md
create mode 100644 docs/en-US/components/upload/index.md
create mode 100644 docs/en-US/design.md
create mode 100644 docs/en-US/index.md
create mode 100644 docs/en-US/theme.md
create mode 100644 docs/en-US/version.md
diff --git a/docs/en-US/components/accordion/index.md b/docs/en-US/components/accordion/index.md
new file mode 100644
index 00000000..5b42b165
--- /dev/null
+++ b/docs/en-US/components/accordion/index.md
@@ -0,0 +1,4 @@
+# Accordion
+A component that provides navigation for a page.
+### When to use
+Use when you need to organize the menu in groups.
\ No newline at end of file
diff --git a/docs/en-US/components/alert/index.md b/docs/en-US/components/alert/index.md
new file mode 100644
index 00000000..089868ec
--- /dev/null
+++ b/docs/en-US/components/alert/index.md
@@ -0,0 +1,23 @@
+# Alert
+
+A component that displays warning information, information that needs the user's attention。
+
+### When to use
+
+When the page needs to send a warning message to the user。
+
+### 基本用法
+
+ success
+ danger
+ warning
+ info
+ simple
+
+```html
+ success
+ danger
+ warning
+ info
+ simple
+```
\ No newline at end of file
diff --git a/docs/en-US/components/anchor/demo.tsx b/docs/en-US/components/anchor/demo.tsx
new file mode 100644
index 00000000..d87cc00c
--- /dev/null
+++ b/docs/en-US/components/anchor/demo.tsx
@@ -0,0 +1,35 @@
+import { defineComponent } from 'vue'
+
+export default defineComponent({
+ name: 'DAnchor',
+ props: {
+ },
+ setup() {
+ return () => {
+ return (
+
+
+ anchorlink-one
+ anchorlink-two
+ anchorlink-three
+ anchorlink-four
+
+
+
+ anchorlink-one
+
+
+ anchorlink-two
+
+
+ anchorlink-three
+
+
+ anchorlink-four
+
+
+
+ )
+ }
+ }
+})
\ No newline at end of file
diff --git a/docs/en-US/components/anchor/index.md b/docs/en-US/components/anchor/index.md
new file mode 100644
index 00000000..08f7664b
--- /dev/null
+++ b/docs/en-US/components/anchor/index.md
@@ -0,0 +1,80 @@
+# anchor
+
+
+
+# When to use
+
+
+Use in the page:
+
+```html
+
+
+
+ anchorlink-one
+ anchorlink-two
+ anchorlink-three
+ anchorlink-four
+
+
+
+ anchorlink-one1
+
+
+ anchorlink-two
+
+
+ anchorlink-three
+
+
+ anchorlink-four
+
+
+
+```
+
+# dAnchor
+
+Define an anchor point。
+### dAnchor parameter
+
+| parameter | type | default | illustrate | jump Demo |config|
+| :----------------: | :----------: | :------: | :--: | :---------------------------------------------------: | ---------------------------- |
+| dAnchor | `string` | -- | required, set an anchor name | [basic usage](demo#basic-usage) |
+| anchorActive | `string` | -- | Optional, when the anchor point is activated, the corresponding css class name for the module to take effect | [basic usage](demo#basic-usage) |
+
+### dAnchor activation event
+
+The following classes are automatically added to the anchor points to correspond to different activated objects。
+
+| css classname | Representative meaning |
+| :---------------------------: | :--------------------: |
+| anchor-active-by-anchor-link | Click on the anchor link to activate |
+| anchor-active-by-scroll | The container is scrolled to the anchor point to activate |
+| anchor-active-by-click-inside | Click on the content inside the anchor to activate |
+| anchor-active-by-initial | Initialize scroll bar position activation |
+
+# dAnchorLink
+
+Define a link with an anchor point. Clicking on the link will slide to the anchor point. When the anchor point is at the top of the page, the link class will be activated。
+
+### dAnchorLink parameter
+
+| parameter | type | default | illustrate | jump Demo |config|
+| :----------------: | :----------: | :------: | :--: | :---------------------------------------------------: | ---------------------------- |
+| dAnchorLink | `string` | -- | required, click the name of the target anchor point to slide | [basic usage](demo#basic-usage) |
+| anchorActive | `string` | -- | optional, when the anchor point is active, the css class name corresponding to the effective link | [basic usage](demo#basic-usage) |
+
+# dAnchorBox
+
+There must be a container, otherwise the function cannot be used。
+
+Define a container for scanning anchor points and place it on the common parent node of dAnchor and dAnchorLink for communication between anchor points and links。
diff --git a/docs/en-US/components/avatar/index.md b/docs/en-US/components/avatar/index.md
new file mode 100644
index 00000000..3ca64429
--- /dev/null
+++ b/docs/en-US/components/avatar/index.md
@@ -0,0 +1,23 @@
+# Avatar
+
+The component that displays the user's avatar。
+
+### When to use
+
+当需要显示用户头像时。
+
+### Basic rules of avatar display
+
+When the 'name' attribute is passed to the avatar component, the avatar field will be displayed according to certain rules. Please refer to the API for specific rules。
+
+
+
+
+
+
+```html
+
+
+
+
+```
\ No newline at end of file
diff --git a/docs/en-US/components/badge/index.md b/docs/en-US/components/badge/index.md
new file mode 100644
index 00000000..2eb62674
--- /dev/null
+++ b/docs/en-US/components/badge/index.md
@@ -0,0 +1,178 @@
+# Badge
+
+The round logo number in the upper right corner of the icon。
+
+### When to use
+
+Appears in the upper right corner of the icon or to the right of the list item, and prompts the user when there is a message to be processed through different status colors and numbers。
+
+### Basic Badge
+
+The basic badge type. When there is a package element, the badge and number will be displayed in the upper right corner。
+
+Unread message
+Unread message
+Unread message
+Unread message
+
+```html
+Unread message
+Unread message
+Unread message
+Unread message
+```
+
+### Dot Badge
+
+Dot badge type. When there is a package element and the showDot parameter is true, it is a dot badge. By default, small dots are displayed in the upper right corner and the number is not displayed。
+
+Unread message
+Unread message
+
+
+
+
+
+
+
+```html
+Unread message
+Unread message
+
+
+
+
+
+
+```
+
+### Count Badge
+
+When the badge is used independently and does not wrap any elements, only the badge status color and number are displayed。
+
+
+
+ Unread message
+
+
+
+ Personal message
+
+
+
+
+```html
+
+
+ System message
+
+
+
+ Personal message
+
+
+
+```
+
+### Status Badge
+
+When the badge is used independently, does not wrap any elements, and the showDot parameter is true, it is a state badge, and different states show different color points。
+
+   danger
+   warning
+   waiting
+   info
+   success
+
+```html
+   danger
+   warning
+   waiting
+   info
+   success
+```
+
+### Badge Position
+
+Set the badge position through the badgePos parameter。
+
+Unread message
+Unread message
+
+
+
+
+
+
+```html
+Unread message
+Unread message
+
+
+
+
+
+
+```
+
+### Define
+
+The badge display status color is set through the bgColor parameter (the badge status color set by the status parameter is invalid at this time), and the badge offset relative to the badgePos can be set through the offsetXY parameter. Customize text and background color through textColor and bgColor。
+
+
+
+
+
+
+
+Unread message
+Unread message
+
+
+```html
+
+
+
+
+
+
+Unread message
+Unread message
+
+```
+
+### API
+
+| parameter | type | default | illustrate |
+| :-------: | :-----------------: | :---------: | :--------------------------------------------------------------------------------------------------------------------------- |
+| count | `Number` | -- | Optionally, set the number displayed in the basic badge and count badge |
+| maxCount | `Number` | 99 | Optional, set the maximum number of basic badges and count badges that can be displayed, and display maxCount+ when count> maxCount |
+| showDot | `Boolean` | false | Optional, when true, it is a dot badge (with package) or status badge (without package); when it is false, it is a basic badge (with package) or counting badge (without package) |
+| status | `BadgeStatusType` | -- | Optional, status color danger\| warning \| waiting \| success \| info |
+| badgePos | `BadgePositionType` | 'top-right' | Optional, logo position top-left\| top-right \| bottom-left \| bottom-right |
+| bgColor | `String` | -- | Optional, customize the logo color, at this time the badge status color set by the status parameter is invalid |
+| textColor | `String` | -- | Optional, logo text color can be customized |
+| offsetXY | `[number, number] ` | -- | Optional, optional, the logo position offset when there is a package, the format is [x,y], and the unit is px. x is the offset relative to right or left, and y is the offset relative to top or bottom |
+
+
diff --git a/docs/en-US/components/button/index.md b/docs/en-US/components/button/index.md
new file mode 100644
index 00000000..4870da3b
--- /dev/null
+++ b/docs/en-US/components/button/index.md
@@ -0,0 +1,27 @@
+# Button
+
+The button is used to start an instant operation。
+
+### When to use
+
+An operation command (or a group of encapsulation) is marked, and the corresponding business logic is triggered in response to the user's click behavior。
+
+### Main button
+
+Primary
+Disabled
+
+```html
+Primary
+Disabled
+```
+
+### Secondary button
+
+Common
+Disabled
+
+```html
+Common
+Disabled
+```
\ No newline at end of file
diff --git a/docs/en-US/components/card/index.md b/docs/en-US/components/card/index.md
new file mode 100644
index 00000000..d81ada82
--- /dev/null
+++ b/docs/en-US/components/card/index.md
@@ -0,0 +1,220 @@
+# Card
+
+Universal card container。
+
+### When to use
+
+Basic card container, which can contain text, lists, pictures, paragraphs, used for overview display。
+
+
+### Basic usage
+
+
+
+
+
+
+ DEVUI Course
+
+
+ DevUI
+
+
+ DEVUI is a free open-source and common solution for the front end of enterprise mid- and back-end products. Its design values are basedon...
+
+
+
+ 12
+
+
+ 8
+
+
+ 8
+
+
+
+
+```html
+
+
+
+
+
+ DEVUI Course
+
+
+ DevUI
+
+
+ DEVUI is a free open-source and common solution for the front end of enterprise mid- and back-end products. Its design values are basedon...
+
+
+
+ 12
+
+
+ 8
+
+
+ 8
+
+
+
+```
+
+### Use image
+
+The alignment of the d-card-actions operation area can be set through align: initial alignment, tail alignment, stretch alignment。
+
+
+
+
+
+
+ DEVUI Course
+
+
+ DevUI
+
+
+ DEVUI is a free open-source and common solution for the front end of enterprise mid- and back-end products. Its design values are basedon...
+
+
+
+ 12
+
+
+ 8
+
+
+ 8
+
+
+
+
+```html
+
+
+
+
+
+ DEVUI Course
+
+
+ DevUI
+
+
+ DEVUI is a free open-source and common solution for the front end of enterprise mid- and back-end products. Its design values are basedon...
+
+
+
+ 12
+
+
+ 8
+
+
+ 8
+
+
+
+```
+
+### Custom Area
+
+
+
+
+ DEVUI Course
+
+
+ Updated at Dec 31 15:55
+
+
+
+
+
+
+
+```html
+
+
+
+ DEVUI Course
+
+
+ Updated at Dec 31 15:55
+
+
+
+
+
+
+```
+
\ No newline at end of file
diff --git a/docs/en-US/components/carousel/index.md b/docs/en-US/components/carousel/index.md
new file mode 100644
index 00000000..4fad5733
--- /dev/null
+++ b/docs/en-US/components/carousel/index.md
@@ -0,0 +1,162 @@
+# Carousel
+
+A set of carousel areas。
+
+### When to use
+
+1. Used to display pictures or cards。
+
+### Basic usage
+
+ {{ item }}
+
+
+```html
+
+ {{ item }}
+
+```
+```css
+.d-carousel-item {
+ text-align: center;
+ line-height: 200px;
+ background: var(--devui-global-bg, #f3f6f8);
+}
+```
+### 指示器&切换箭头
+arrowTrigger设为always可以使箭头永久显示,dotTrigger设为hover可以使hover到点上就切换。
+
+
+ {{ item }}
+
+
+```html
+
+ {{ item }}
+
+```
+### Automatic carousel
+
+ {{ item }}
+
+
+```html
+
+ {{ item }}
+
+```
+### Custom action
+
+ {{ item }}
+
+
+ 上一张
+ 下一张
+ 第一张
+
+
+```html
+
+ {{ item }}
+
+
+ 上一张
+ 下一张
+ 第一张
+
+```
+```css
+.carousel-demo-operate{
+ margin-top: 10px;
+
+ display: flex;
+ align-items: center;
+
+ > * {
+ margin-right: 20px;
+ }
+}
+```
+
+### API
+#### parameter
+
+| parameter | type | default | description | jump Demo |
+| :----------: | :--------------------------: | :------: | :---------------------------------------------- | ------------------------------------------------ |
+| arrowTrigger | `'hover'\|'never'\|'always'` | 'hover' | Optional, specify the switching arrow display mode | [Indicator-switch-arrow](#Indicator-switch-arrow) |
+| autoplay | `boolean` | false | Optional, whether to rotate automatically | [Automatic-carousel](#Automatic-carousel) |
+| autoplaySpeed | `number` | 3000 | Optional, used with `autoplay`, automatic rotation speed, unit: ms | [Automatic-carousel](#Automatic-carousel) |
+| height | `string` | '100%' | Optional, carousel container height | [Basic-usage](#Basic-usage) |
+| showDots | `boolean` | true | Optional, whether to display the panel indicator | [Automatic-carousel](#Automatic-carousel) |
+| dotPosition | `'top'\|'bottom'` | 'bottom' | Optional, panel indicator position | [Indicator-switch-arrow](#Indicator-switch-arrow) |
+| dotTrigger | `'click'\|'hover'` | 'click' | Optional, indicator triggers carousel mode | [Indicator-switch-arrow](#Indicator-switch-arrow) |
+| activeIndex | `number` | 0 | Optional, initialize the active card index, starting from 0, supporting `[(activeIndex)]` two-way binding | [Basic-usage](#Basic-usage) |
+
+#### Event
+
+| event | type | description | jump Demo |
+| :----------------: | :---------------------: | :-----------------------------------------: | ------------------------------------------------- |
+| activeIndexChange | `EventEmitter` | When the card is switched, return to the index of the current card, starting from 0 | [Basic-usage](#Basic-usage) |
+
+#### methods
+
+| methods | description | jump Demo |
+| :---------: | :---------------------------------- | :----------------------------- |
+| prev() | Switch to the previous card | [Custom-action](#Custom-action) |
+| next() | Switch to the next card | [Custom-action](#Custom-action) |
+| goTo(index) | Switch to the card with the specified index, the index starts from 0 | [Custom-action](#Custom-action) |
+
+
+
+
\ No newline at end of file
diff --git a/docs/en-US/components/checkbox/index.md b/docs/en-US/components/checkbox/index.md
new file mode 100644
index 00000000..1cd4822d
--- /dev/null
+++ b/docs/en-US/components/checkbox/index.md
@@ -0,0 +1,42 @@
+# CheckBox
+
+CheckBox。
+
+### When to use
+
+1. Make multiple choices in a set of options;
+2. Used alone can indicate switching between the two states, and can be combined with the submit operation。
+
+### Basic usage
+
+
+
+
+```html
+
+
+```
+
+#### use CheckboxGroup
+
+
+
+
+{{ checkedValues.reduce((prev, current) => `${current} ${prev}`, '') }}
+
+
\ No newline at end of file
diff --git a/docs/en-US/components/date-picker/index.md b/docs/en-US/components/date-picker/index.md
new file mode 100644
index 00000000..6ec80542
--- /dev/null
+++ b/docs/en-US/components/date-picker/index.md
@@ -0,0 +1,121 @@
+
+
+# DatePicker
+
+Date and time visual input。
+
+## Attributes auto-close
+
+|project|description|
+|----|----|
+|name|auto-close / autoClose|
+|type|boolean|
+|mustSelect|false|
+|default|false|
+|description|After selecting the date, whether to automatically close the date panel|
+
+```vue
+
+
+
+
+
+
+
+```
+
+
+
+
+## Attributes range
+
+|project|description|
+|----|----|
+|name|range|
+|type|boolean|
+|mustSelect|false|
+|default|false|
+|description|Whether to open interval selection|
+
+```vue
+
+
+
+
+
+
+
+```
+
+
+
+## Attributes format
+
+|project|type|
+|----|----|
+|name|format|
+|type|string|
+|mustSelect|false|
+|default|y/MM/dd|
+|description|Date value format|
+
+
+
+
+```vue
+
+
+```
+
+**Date formatting characters**
+
+|character|description|rule|
+|----|----|----|
+|y, yy, yyyy|year|When using `yy`, only the last 2 digits are displayed, otherwise 4 digits are displayed。for example:`yy/MM/dd -> 21/01/02`, `y/MM/dd -> 2021/01/02`|
+|M,MM|month|When using `MM`, the left side of a one-digit number will automatically add `0`。for example: `y/MM/dd -> 2021/01/02`,`y/M/d -> 2021/1/2`|
+|d,dd|date|rule reference`M`|
+|h,hh|hour|rule reference`M`;Use 24-hour representation。|
+|m,mm|minute|rule reference`M`|
+|s,ss|second|rule reference`M`|
+
+## Attributes range-spliter
+
+|project|type|
+|----|----|
+|name|range-spliter / rangeSpliter|
+|type|string|
+|mustSelect|false|
+|default|-|
+|description|In interval selection mode, the character that separates the start and end time。|
+
+```vue
+
+```
+
+
+
+## Event selectedDateChange
+
+```vue
+
+
+```
+
+
+
\ No newline at end of file
diff --git a/docs/en-US/components/icon/index.md b/docs/en-US/components/icon/index.md
new file mode 100644
index 00000000..45ba44f2
--- /dev/null
+++ b/docs/en-US/components/icon/index.md
@@ -0,0 +1,71 @@
+# Icon 图标
+
+用于显示图标。
+
+### 何时使用
+
+需要显示图标时。
+
+所有内置的图标可在DevUI官网进行查看:
+
+[https://devui.design/icon/ruleResource](https://devui.design/icon/ruleResource)
+
+### 基本用法
+
+
+
+
+
+
+```html
+
+
+
+
+```
+
+### 自定义字体图标
+
+Icon 组件默认引用 DevUI 图标库的图标,如果需要在现有 Icon 的基础上使用更多图标,可以引入第三方 iconfont 对应的字体文件和 CSS 文件,之后就可以在 Icon 组件中直接使用。
+
+```css
+@font-face {
+ font-family: "my-icon";
+ src: url("./my-icon.ttf") format("truetype");
+}
+
+.my-icon {
+ font-family: "my-icon";
+}
+
+.my-icon-right::before {
+ content: "\E03F";
+}
+```
+
+引入字体图标的 css
+
+```css
+@import "my-icon.css";
+```
+
+or
+
+```js
+import "my-icon.css";
+```
+
+使用
+
+```html
+
+```
+
+### API
+
+| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
+| :---------: | :------: | :-------: | :----------------------- | --------------------------------- |
+| name | `String` | -- | 必选,Icon 名称 | [基本用法](#基本用法) |
+| size | `String` | '16px' | 可选,图标大小 | [基本用法](#基本用法) |
+| color | `String` | '#252b3a' | 可选,图标颜色 | [基本用法](#基本用法) |
+| classPrefix | `String` | 'icon' | 可选,自定义字体图标前缀 | [自定义字体图标](#自定义字体图标) |
diff --git a/docs/en-US/components/image-preview/index.md b/docs/en-US/components/image-preview/index.md
new file mode 100644
index 00000000..481641d3
--- /dev/null
+++ b/docs/en-US/components/image-preview/index.md
@@ -0,0 +1,137 @@
+# ImagePreview
+
+Preview the components of one or more pictures。
+
+### When to use
+
+When you need to preview the image or preview the image in the container according to the user input。
+
+### Basic usage
+
+Use the v-d-image-preview command to preview the image in the container。
+
+
+
+
+
+```html
+
+
+
+
+
+```
+
+### Custom open preview window
+
+Pass in the custom parameter, the command will be automatically injected into the open method, and the preview window will be opened through custom.open
+
+
+
+
+自定义
+
+```html
+
+
+
+自定义
+
+
+```
+
+### Set zIndex
+
+Set zIndex to control the level of the pop-up effect, and set backDropZIndex to control the level of the background of the pop-up layer。
+You can see that when zIndex is set to be less than backDropZIndex, imagePreview will be displayed below the background。
+You can close imagePreview by Esc。
+
+```
+// 待嵌入 modal 组件即可
+```
+
+### API
+
+| parameter | type | default | description |
+| :------------: | :-------: | :---: | :------------------------------------------------------------ |
+| custom | `Object` | -- | Optional, the command will be automatically injected into the open method, and the preview window will be opened through custom.open |
+| disableDefault | `Boolean` | false | Optional, turn off the default click trigger image preview mode |
+| zIndex | `Number` | 1050 | Optional, optional, set the z-index value of the picture when previewing |
+| backDropZIndex | `Number` | 1040 | Optional, set the z-index value of the image background during preview |
+
+
+
+
diff --git a/docs/en-US/components/input/index.md b/docs/en-US/components/input/index.md
new file mode 100644
index 00000000..edc7f8fa
--- /dev/null
+++ b/docs/en-US/components/input/index.md
@@ -0,0 +1,96 @@
+# Input
+
+Text input。
+
+### When to use
+
+You need to manually enter text to use。
+
+### Basic usage
+
+:::demo
+
+```vue
+
+ Default
+
+
+
+ Disabled
+
+
+
+ Error
+
+
+
+
+```
+
+:::
+
+### Size
+
+:::demo
+
+```vue
+
+ Small
+
+
+
+ Middle
+
+
+
+ Large
+
+
+
+```
+
+:::
+
+
+### Password
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+### API
+
+| parameter | type | default | description | jump Demo |
+| :---------: | :------: | :-------: | :-----------------------: | :---------------------------------: |
+| id | `string` | -- | Optional, text box id | [Basic-usage](#Basic-usage) |
+| placeholder | `string` | -- | Optional,textarea placeholder | [Basic-usage](#Basic-usage) |
+| maxLength | `number` | Number.MAX_SAFE_INTEGER | Optional, the max-length of the input box | |
+| disabled | `boolean` | false | Optional,Whether the text box is disabled | [Basic-usage](#Basic-usage) |
+| error | `boolean` | false | Optional,Whether there is an input error in the text box | [Basic-usage](#Basic-usage) |
+| size | `'sm'\|''\|'lg'` | '' | Optional,There are three options for the size of the text box`'lg'`,`''`,`'sm'` | [Size](#Size) |
+| cssClass | `string` | '' | Optional,Support to pass in the class name to the input box | |
+| showPassword | `boolean` | false | Optional,password | [Password](#Password) |
+| autoFocus | `boolean` | false | Optional,Whether the input box is auto-focused | [Basic-usage](#Basic-usage) |
+
diff --git a/docs/en-US/components/loading/index.md b/docs/en-US/components/loading/index.md
new file mode 100644
index 00000000..5c0a61f5
--- /dev/null
+++ b/docs/en-US/components/loading/index.md
@@ -0,0 +1,298 @@
+# Loading
+
+Prompt the user that the page is executing instructions and needs to wait。
+
+### When to use
+
+When the execution time is long (it takes more than a few seconds), show the user the status of execution。
+
+
+### Basic usage
+Show the basic usage in the scene of loading table data。
+:::demo
+
+```vue
+
+ click me!
+
+
+
+ 序号 姓名 队伍 操作
+
+
+
+
+ {{index}} 张家齐 跳水 跳水队
+
+
+
+
+
+
+```
+:::
+
+
+### many promise
+support many promise。
+:::demo
+
+```vue
+
+ click me!
+
+ loading will show here2
+
+
+
+```
+:::
+
+### Custom Css Style
+Customize loading style through templateRef。
+:::demo
+
+```vue
+
+ Loading Style 1
+
+ Loading Style 2
+
+ Loading Style 3
+
+ loading will show here1
+
+
+
+
+
+```
+:::
+
+### Service method call
+Use the service method to load the loading component in full screen or load the loading component on the specified host。
+:::demo
+
+```vue
+
+ click me show full screen loading!
+
+ click me show loading in target!
+
+ click me close loading in target!
+
+ loading will show here3
+
+
+
+```
+:::
+
+### parameter
+The parameter of dLoading
+
+| **parameter** | **type** | **default** | **description** | **jump Demo** |
+| ------------------ | ------------------------------------------------------------ | ------------------------- | ------------------------------------------------------------ | ---------------------------- |
+| v-dLoading | `Promise \| Array> \| Boolean \| undefined` | -- | Optional, command mode, control loading status | [Basic-usage](#Basic-usage) |
+| target | `element` | document.body | Optional, service mode, DOM nodes that need to be covered by Loading | [Service-method-call](#Service-method-call) |
+| message | `string` | -- | Optional, prompt message during loading | [many-promise](#many-promise) |
+| loadingTemplateRef | `VNode` | -- | Optional, custom loading template | [Custom-css-style](#Custom-css-style) |
+| backdrop | `boolean` | true | Optional, whether to show the mask during loading | [Basic-usage](#Basic-usage) |
+| positionType | `string` | relative | Optional, specify the positioning type of the `dLoading` host element, the value is consistent with the css position attribute。 | [Basic-usage](#Basic-usage) |
+| view | `{top?:string,left?:string} ` | {top: '50%', left: '50%'} | Optional, adjust the display position of loading, relative to the top and left distances of the host element | [Basic-usage](#Basic-usage) |
+| zIndex | `number` | -- | Optional, z-index value of loading prompt | [Basic-usage](#Basic-usage) |
+
diff --git a/docs/en-US/components/overlay/index.md b/docs/en-US/components/overlay/index.md
new file mode 100644
index 00000000..6a7399ba
--- /dev/null
+++ b/docs/en-US/components/overlay/index.md
@@ -0,0 +1,198 @@
+## overlay
+The mask layer is a basic component and is used to build components independent of the current page layout。
+### When to use
+You can use this component when you need a global pop-up window, or when you need an element-following function。
+### Fixed overlay
+
+:::demo Use `sm`, `''`, `lg` to define the basic type of `Search`
+
+```vue
+
+ {{title}}
+
+ hello world
+
+
+
+```
+:::
+
+
+### Elastic overlay
+
+:::demo
+```vue
+
+
+
orgin
+
{{title}}
+
+
+ 依赖元素的 X 轴:
+
+
+
+ 依赖元素的 Y 轴:
+
+
+
+ Overlay X 轴:
+
+
+
+ Overlay Y 轴:
+
+
+
+
+
+
+ hello world
+
+
+
+```
+
+:::
+
+
+
+
+### API
+The parameter of d-fixed-overlay
+
+| parameter | type | default | description |
+| :--------------: | :------------------------: | :---: | :-------------------------------------------------------------------- |
+| visible | `boolean` | false | Optional, whether the mask layer is visible |
+| onUpdate:visible | `(value: boolean) => void` | -- | Optional, the mask layer cancels the visible event |
+| backgroundBlock | `boolean` | false | Optional, if true, the background cannot be scrolled |
+| backgroundClass | `string` | -- | Optional, the style class of the background |
+| hasBackdrop | `boolean` | true | Optional, if false, the content behind the background will be triggered |
+| backdropClick | `() => void` | -- | Optional, click on the event triggered by the background |
+| backdropClose | `boolean` | false | Optional, if true, clicking on the background will trigger `onUpdate:visible`, the default parameter is false |
+| overlayStyle | `CSSProperties` | -- | Optional, the style of the mask layer |
+
+The parameter of d-flexible-overlay
+
+| 参数 | 类型 | 默认 | 说明 |
+| :--------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---: | :---------------------------------------------------------------- |
+| visible | `boolean` | false | 可选,遮罩层是否可见 |
+| onUpdate:visible | `(value: boolean) => void` | -- | 可选,遮罩层取消可见事件 |
+| backgroundBlock | `boolean` | false | 可选,如果为 true,背景不能滚动 |
+| backgroundClass | `string` | -- | 可选,背景的样式类 |
+| hasBackdrop | `boolean` | true | 可选,如果为false,背景后下的内容将可以触发 |
+| backdropClick | `() => void` | -- | 可选,点击背景触发的事件 |
+| backdropClose | `boolean` | false | 可选,如果为true,点击背景将触发 `onUpdate:visible`,参数是 false |
+| origin | `Element \| ComponentPublicInstance \| { x: number, y: number, width?: number, height?: number }` | false | 必选,你必须指定起点元素才能让遮罩层与该元素连接在一起 |
+| position | `{originX: HorizontalPos, originY: VerticalPos, overlayX: HorizontalPos, overlayY: VerticalPos } (type HorizontalPos = 'left' \| 'center' \| 'right') ( type VerticalPos = 'top' \| 'center' \| 'bottom')` | false | 可选,指定遮罩层与原点的连接点 |
diff --git a/docs/en-US/components/pagination/index.md b/docs/en-US/components/pagination/index.md
new file mode 100644
index 00000000..6e85d151
--- /dev/null
+++ b/docs/en-US/components/pagination/index.md
@@ -0,0 +1,473 @@
+# Pagination
+
+Pagination。
+
+### When to use
+
+When loading/rendering all the data will take a lot of time, you can switch the page number to browse the data。
+
+
+### Basic usage
+
+:::demo
+
+```vue
+
+ size = 'sm'
+
+
+ size = 'md'
+
+
+ size = 'lg'
+
+
+ Custom Style
+
+
+
+```
+:::
+
+
+### Minimalist mode
+Minimalist mode is suitable for some pages with a lot of information, which can simplify the complexity of the page。
+:::demo
+
+
+```vue
+
+ Simple Mode
+
+
+ Super Simple Mode
+
+
+ haveConfigMenu = "true"
+
+
+
+
+
+
+
+
+```
+:::
+
+### Multiple configurations
+Support setting input jump, display jump button; setting pageSize and other functions。
+:::demo
+
+```vue
+
+
+
+
+
+
+
+
+
+
+
+```
+:::
+
+### Special cases
+The display of the pager in a special scene。
+:::demo
+
+
+```vue
+
+
+ When the value of pageIndex
exceeds the maximum page number, enable showTruePageIndex
to display the value of pageIndex
+
+
+
+
+ When the value of pageIndex
exceeds the maximum page number, the showTruePageIndex
function is disabled and only the maximum page number is displayed.
+
+
+
+ Default Mode
+
+
+ total = 0
+ total = 5
+ total = 15
+
+
+ Simple Mode
+
+
+ total = 0
+ total = 20
+ total = 30000
+ total = 100000
+ index = 2
+ index = 3
+
+
+
+```
+:::
+
+### 参数
+
+d-pagination 参数
+
+| parameter | type | default | description | jump Demo |
+| ----------------- | ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------ | --------------------- |
+| pageSize | `number` | 10 | Optional, display the maximum number of entries per page | [Basic-usage](#Basic-usage) |
+| total | `number` | 0 | Optional, total number of entries displayed | [Basic-usage](#Basic-usage) |
+| pageSizeOptions | `number[] ` | 10 | Optional, the data source of the drop-down box for the maximum number of entries per page for pagination, there are four options by default 5, 10, 20, 50 | [Multiple-configurations](#Multiple-configurations) |
+| pageSizeDirection | `Array<`[`AppendToBodyDirection`](#appendtobodydirection) `\|` [`ConnectedPosition`](#connectedposition)`>` | ['centerDown', 'centerUp'] | Optional, set the display direction of the drop-down box of each page entry | [Multiple-configurations](#Multiple-configurations) |
+| pageIndex | `number` | 1 | Optional, initialize page number | [Basic-usage](#Basic-usage) |
+| maxItems | `number` | 10 | Optional, display a few buttons at most for pagination | [Basic-usage](#Basic-usage) |
+| preLink | `string` | -- | Optional, the previous page button displays the icon, the default setting is the left arrow icon | [Basic-usage](#Basic-usage) |
+| nextLink | `string` | -- | Optional, the next page button displays the icon, the default setting is the right arrow icon | [Basic-usage](#Basic-usage) |
+| size | `number` | '' | 可Selection, paging component size, there are three options lg,``,sm, respectively representing large, medium and small | [Basic-usage](#Basic-usage) |
+| canJumpPage | `boolean` | false | Optional, whether to display the page input jump | [Basic-usage](#Basic-usage) |
+| canChangePageSize | `boolean` | false |Optional, whether to display the drop-down box for selecting the maximum number of entries per page for changing the pagination | [Basic-usage](#Basic-usage) |
+| canViewTotal | `boolean` | false | Optional, whether to display total entries | [Basic-usage](#Basic-usage) |
+| totalItemText | `string` | 'All entries' | Optional, total entry text | [Minimalist-mode](#Minimalist-mode) |
+| goToText | `string` | 'jump to' | Optional, total entry text | [Basic-usage](#Basic-usage) |
+| showJumpButton | `boolean` | false | Optional, whether to show the jump button | [Multiple-configurations](#Multiple-configurations) |
+| showTruePageIndex | `boolean` | false | Optional, the switch to display the current page number when the page number exceeds the paging range | [Multiple-configurations](#Multiple-configurations) |
+| lite | `boolean` | false | Optional, whether to switch to Minimalist-mode | [Minimalist-mode](#Minimalist-mode) |
+| showPageSelector | `boolean` | true | Optional, whether to show page number drop-down under `Minimalist-mode` | [Minimalist-mode](#Minimalist-mode) |
+| haveConfigMenu | `boolean` | false | Optional, whether to display the configuration under `Minimalist-mode` | [Minimalist-mode](#Minimalist-mode) |
+| autoFixPageIndex | `boolean` | true | Optional, whether to automatically correct the page number when changing the pageSize. If the `pageIndex` is handled in the `pageSizeChange` event, it is recommended to set it to `false` | [Minimalist-mode](#Minimalist-mode) |
+| autoHide | `boolean` | false | Optional, whether to hide automatically, autoHide is true and the minimum value of pageSizeOptions> total does not show pagination | [Minimalist-mode](#Minimalist-mode) |
+
+d-pagination Event
+
+| parameter | type | default | jump Demo |
+| --------------- | -------------------- | ---------------------------------------------------------- | --------------------- |
+| pageIndexChange | `EventEmitter` | Optional, callback of page number change, return current page number value | [Multiple-configurations](#Multiple-configurations) |
+| pageSizeChange | `EventEmitter` | Optional, callback when the maximum number of items per page is changed, return the current number of items displayed on each page | [Multiple-configurations](#Multiple-configurations) |
+
+**Tnterface & TypeDefine**
+
+##### AppendToBodyDirection
+
+```ts
+export type AppendToBodyDirection = 'rightDown' | 'rightUp' | 'leftUp' | 'leftDown' | 'centerDown' | 'centerUp';
+```
+
+##### ConnectedPosition
+
+```ts
+export interface ConnectedPosition {
+ originX: 'start' | 'center' | 'end';
+ originY: 'top' | 'center' | 'bottom';
+
+ overlayX: 'start' | 'center' | 'end';
+ overlayY: 'top' | 'center' | 'bottom';
+
+ weight?: number;
+ offsetX?: number;
+ offsetY?: number;
+ panelClass?: string | string[];
+}
+```
+
diff --git a/docs/en-US/components/panel/index.md b/docs/en-US/components/panel/index.md
new file mode 100644
index 00000000..da8c4438
--- /dev/null
+++ b/docs/en-US/components/panel/index.md
@@ -0,0 +1,74 @@
+# Panel
+
+Content panel for content grouping。
+
+### When to use
+
+Used when the page content needs to be displayed in groups, generally including three parts: header, content area, and bottom。
+
+### Basic usage
+
+
+
+
+ Panel with foldable
+
+
+ This is body
+
+
+
+
+ Panel has no left padding
+
+
+ This is body
+
+
+
+ Panel with header and footer
+ This is body
+ This is footer
+
+
+
+
+```html
+
+
+
+ Panel with foldable
+
+
+ This is body
+
+
+
+
+ Panel has no left padding
+
+
+ This is body
+
+
+
+ Panel with header and footer
+ This is body
+ This is footer
+
+
+```
+
+
diff --git a/docs/en-US/components/popover/index.md b/docs/en-US/components/popover/index.md
new file mode 100644
index 00000000..522495c9
--- /dev/null
+++ b/docs/en-US/components/popover/index.md
@@ -0,0 +1,386 @@
+# Popover
+Simple text prompt bubble box。
+
+### When to use
+Used to notify users of non-critical issues or to prompt a control in a special situation。
+
+### Basic usage
+When Popover pops up, it will be positioned based on the content of the `reference` slot。
+
+
+
+
+ default
+
+
+
+
+ info
+
+
+
+
+ error
+
+
+
+
+ success
+
+
+
+
+ warning
+
+
+
+
+ no-animation
+
+
+
+
+
+```html
+
+
+ default
+
+
+
+
+
+ info
+
+
+
+
+
+ error
+
+
+
+
+
+ success
+
+
+
+
+
+ warning
+
+
+
+
+ no-animation
+
+
+```
+
+### Custom content
+Customize the content of the `reference` slot and the content of the pop-up prompt。
+
+
+
+
+ Custom-content
+
+
+
+
+```html
+
+
+
+ Custom-content
+
+
+
+```
+
+### Pop-up position
+A total of 12 pop-up positions are supported。
+
+
+
+
+ left
+
+
+ left
+
+
+
+
+ left-top
+ left-top
+
+
+ left-top
+
+
+
+
+ left-bottom
+ left-bottom
+
+
+ left-bottom
+
+
+
+
+
+
+
+ top
+
+
+ top
+
+
+
+
+ top-left
+
+
+ top-left
+
+
+
+
+ top-right
+
+
+ top-right
+
+
+
+
+
+
+
+ right
+
+
+ right
+
+
+
+
+ right-top
+ right-top
+
+
+ right-top
+
+
+
+
+ right-bottom
+ right-bottom
+
+
+ right-bottom
+
+
+
+
+
+
+
+ bottom
+
+
+ bottom
+
+
+
+
+ bottom-left
+
+
+ bottom-left
+
+
+
+
+ bottom-right
+
+
+ bottom-right
+
+
+
+
+```html
+
+
+
+ left
+
+
+ left
+
+
+
+
+ left-top
+ left-top
+
+
+ left-top
+
+
+
+
+ left-bottom
+ left-bottom
+
+
+ left-bottom
+
+
+
+
+
+
+
+ top
+
+
+ top
+
+
+
+
+ top-left
+
+
+ top-left
+
+
+
+
+ top-right
+
+
+ top-right
+
+
+
+
+
+
+
+ right
+
+
+ right
+
+
+
+
+ right-top
+ right-top
+
+
+ right-top
+
+
+
+
+ right-bottom
+ right-bottom
+
+
+ right-bottom
+
+
+
+
+
+
+
+ bottom
+
+
+ bottom
+
+
+
+
+ bottom-left
+
+
+ bottom-left
+
+
+
+
+ bottom-right
+
+
+ bottom-right
+
+
+
+```
+
+### Delay trigger
+Only when the trigger is hover, the mouse moves in for more than [mouseEnterDelay] milliseconds to trigger to prevent flashing caused by the user inadvertently swiping. The default value is 150 milliseconds; after the mouse is moved out, it will be triggered after [mouseLeaveDelay] milliseconds. , The Popover component will be hidden, the default value is 100 milliseconds。
+
+
+
+
+ Mouse enter 500ms later.
+ show Me
+
+
+ MouseEnter delay 500ms
+
+
+
+
+ Mouse leave 2000ms later.
+
+
+ MouseLeave delay 2000ms
+
+
+
+
+```html
+
+
+ bottom-right
+
+
+ bottom-right
+
+
+
+
+ bottom-right
+
+
+ bottom-right
+
+
+```
+
+### dPopover parameter
+
+| parameter | type | default | description | jump Demo |
+| ---- | ---- | ---- | ---- | ---- |
+| content | `string` | defalut |Optional, the display content of the pop-up box | [Custom-content](#Custom-content) |
+| visible | `boolean` | false | Optional, the initial pop-up state of the bullet box | [Basic-usage](#Basic-usage) |
+| trigger | `string` | click | Optional, trigger mode of the bullet frame | [Basic-usage](#Basic-usage) |
+| popType | `string` | default | Optional, pop-up box type, different styles | [Basic-usage](#Basic-usage) |
+| zIndex | `number` | 1060 | Optional, z-index value is used to manually control the layer height | [Basic-usage](#Basic-usage) |
+| positionType | `string` | bottom | Optionally, control the direction in which the bullet frame appears | [Pop-up-position](#Pop-up-position) |
+| showAnimation | `boolean` | true | Optional, whether to show animation | [Basic-usage](#Basic-usage) |
+| mouseEnterDelay | `number` | 150 | Optional, only when the trigger is hover, set the delay after the mouse moves in to display Popover, the unit is `ms`| [Delay-trigger](#Delay-trigger) |
+| mouseLeaveDelay | `number` | 100 | Optional, only need to set the delay after the mouse is moved out to hide the popover only when the trigger is hover, the unit is `ms` | [Delay-trigger](#Delay-trigger) |
+
diff --git a/docs/en-US/components/progress/index.md b/docs/en-US/components/progress/index.md
new file mode 100644
index 00000000..402090d5
--- /dev/null
+++ b/docs/en-US/components/progress/index.md
@@ -0,0 +1,142 @@
+# Progress
+
+progress bar。
+
+### When to use
+1. When the operation takes a long time, show the user the progress of the operation。
+2. When the operation needs to interrupt the existing interface or background operation, it takes a long time。
+3. When it is necessary to display the percentage of an operation completed or the completed steps/total steps。
+
+### Basic usage
+Basic progress and text configuration。
+
+
+
+
+```html
+
+
+
+
+
+
+```
+
+```css
+.progress-container {
+ margin-bottom: 20px;
+}
+```
+
+### Ring usage
+Basic progress and text configuration。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+```html
+
+
+
+
+
+
+
+
+
+
+
+```
+
+```css
+.progress-container-circle {
+ height: 130px;
+ width: 130px;
+ font-size: 20px;
+ display: inline-block;
+ margin-right: 10px;
+}
+
+.icon-position {
+ position: absolute;
+ top: 50%;
+ left: 50%;
+ width: 100%;
+ margin: 0;
+ padding: 0;
+ line-height: 1;
+ white-space: normal;
+ text-align: center;
+ transform: translate(-50%, -50%);
+ color: #50d4ab;
+ font-size: 24px;
+}
+```
+
+### API
+#### d-progress parameter
+| parameter | type | default | description | jump Demo |
+| :---: | :---: | :---: | :---: | :---: |
+| percentage | `number` | 0 | Optional, the maximum value of the progress bar is 100 | [基本用法](#基本用法) |
+| percentageText | `string` | -- | Optional, the text description of the current value of the progress bar, such as: '30%' \| '4/5' | [基本用法](#基本用法) |
+| barBgColor | `string` | #5170ff | Optional, the color of the progress bar is displayed, the default is sky blue | [基本用法](#基本用法) |
+| height | `string` | 20px | Optional, the height of the progress bar, the default value is 20px | [基本用法](#基本用法) |
+| isCircle | `boolean` | false | Optional, show whether the progress bar is a circle | [圆环用法](#圆环用法) |
+| strokeWidth | `number` | 6 | Optional, set the width of the circular progress bar, the unit is the percentage of the width of the progress bar and the canvas | [圆环用法](#圆环用法) |
+| showContent | `boolean` | true | Optional, set whether to display content in the circle-shaped progress bar | [圆环用法](#圆环用法) |
+
+
+
diff --git a/docs/en-US/components/quadrant-diagram/index.md b/docs/en-US/components/quadrant-diagram/index.md
new file mode 100644
index 00000000..e212464c
--- /dev/null
+++ b/docs/en-US/components/quadrant-diagram/index.md
@@ -0,0 +1,44 @@
+# ProQuadrantDiagramgress
+
+Quadrant diagram。
+
+### When to use
+
+Regional division and value sorting of affairs according to needs, which can be used to manage the priority of affairs。
+
+### Basic usage
+
+Basic Usage
+
+:::demo
+
+```vue
+
+
+
+
+
+
+
+```
+
+:::
diff --git a/docs/en-US/components/radio/index.md b/docs/en-US/components/radio/index.md
new file mode 100644
index 00000000..3ab37dd6
--- /dev/null
+++ b/docs/en-US/components/radio/index.md
@@ -0,0 +1,307 @@
+# Radio 单选框
+
+单选框。
+
+### 何时使用
+
+用户要从一个数据集中选择单个选项,且能并排查看所有可选项,选项数量在 2~7 之间时,建议使用单选按钮。
+
+### 相互独立的单选项
+
+:::demo
+
+```vue
+
+
+ The Radio value is: {{ item }}
+
+
+
+
+```
+
+:::
+
+### radio 根据条件终止切换操作
+
+:::demo 根据条件判断,第二项禁止跳转。
+
+```vue
+
+
+ The Radio value is: {{ item }}
+
+
+
+
+```
+
+:::
+
+### radio-group 根据条件终止切换操作
+
+:::demo
+
+```vue
+
+
+
+ {{ item }}
+
+
+
+
+ {{ item }}
+
+
+
+
+
+```
+
+:::
+
+### 禁用
+
+:::demo
+
+```vue
+
+
+ The Radio value is: {{ item }}
+
+
+
+
+```
+
+:::
+
+### 横向排列
+
+:::demo
+
+```vue
+
+
+
+ The Radio value is: {{ item }}
+
+
+
+
+
+```
+
+:::
+
+### 竖向排列
+
+:::demo
+
+```vue
+
+
+
+
+
+```
+
+:::
+
+### 自定义单选项
+
+:::demo 数组源可为普通数组、对象数组等。
+
+```vue
+
+
+
+ The Radio value is: {{ item }}
+
+
+
+
+ The Radio value is: {{ item.name }}
+
+
+
+
+
+```
+
+:::
+
+### API
+
+d-radio 参数
+
+| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
+| :----------: | :------------------: | :---: | :------------------------------------------------------------------------------ | --------------------------------------- |
+| name | `string` | -- | 可选,单选项名称 | [互相独立的单选项](#相互独立的单选项) |
+| value | `string` | -- | 必选,单选项值 | [互相独立的单选项](#相互独立的单选项) |
+| disabled | `boolean` | false | 可选,是否禁用该单选项 | [禁用](#禁用) |
+| beforeChange | `Function / Promise` | -- | 可选,radio 切换前的回调函数,返回 boolean 类型,返回 false 可以阻止 radio 切换 | [回调切换](#radio-根据条件终止切换操作) |
+
+d-radio 事件
+
+| 参数 | 类型 | 说明 | 跳转 Demo |
+| :----: | :--------------------: | :------------------------------- | ------------------------------------- |
+| change | `EventEmitter` | 单选项值改变时触发,返回选中的值 | [互相独立的单选项](#相互独立的单选项) |
+
+d-radio-group 参数
+
+| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
+| :----------: | :------------------: | :------: | :-------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| name | `string` | -- | 可选,单选框的名称 | [竖向排列](#竖向排列) |
+| values | `array` | -- | 可选,单选数据组 | [竖向排列](#竖向排列) |
+| disabled | `boolean` | false | 可选,是否禁用该选项组 | [radio-group 根据条件终止切换操作](#radio-group-根据条件终止切换操作) |
+| cssStyle | `'row' / 'column'` | 'column' | 可选,设置横向或纵向排列 | [横向排列](#横向排列) |
+| beforeChange | `Function / Promise` | -- | 可选,radio-group 切换前的回调函数,返回 boolean 类型,返回 false 可以阻止 radio-group 的切换 | [回调切换](#radio-group-根据条件终止切换操作) |
+
+d-radio-group 事件
+
+| 参数 | 类型 | 说明 | 跳转 Demo |
+| :----: | :--------------------: | :------------------------------- | --------------------- |
+| change | `EventEmitter` | 单选项值改变时触发,返回选中的值 | [竖向排列](#竖向排列) |
diff --git a/docs/en-US/components/rate/index.md b/docs/en-US/components/rate/index.md
new file mode 100644
index 00000000..4ffde650
--- /dev/null
+++ b/docs/en-US/components/rate/index.md
@@ -0,0 +1,138 @@
+# Rate
+
+Grade evaluation。
+
+When to sue
+It can be used when users rate a product。
+
+### Demo
+
+### Read-only mode
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+### Dynamic mode
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+### Dynamic mode-custom
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+### Use the type parameter
+
+:::demo
+
+```vue
+
+
+
+
+
+
+
+
+
+
+
+
+```
+
+:::
+
+### API
+
+d-rate parameter
+
+| parameter | type | default | description | jump Demo |
+| :-------: | :-----------------------------: | :----: | :------------------------------------------------------- | ----------------------------------- |
+| read | `boolean` | false | Optional, set whether to read-only mode, read-only mode cannot be interactive | [只读模式](#只读模式) |
+| count | `number` | 5 | Optional, set the total number of levels | [只读模式](#只读模式) |
+| type | `'success'\|'warning'\|'error'` | -- | Optional, set the current rating type, different types correspond to different colors | [使用 type 参数](#使用-type-参数) |
+| color | `string` | -- | Optional, star color | [动态模式-自定义](#动态模式-自定义) |
+| icon | `string` | -- | Optional, the style of the rating icon, only supports all icons in the devUI icon library | [动态模式](#动态模式) |
+| character | `string` | -- | Optional, the style of the rating icon, only one of icon and character can be set | [动态模式-自定义](#动态模式-自定义) |
diff --git a/docs/en-US/components/search/index.md b/docs/en-US/components/search/index.md
new file mode 100644
index 00000000..a47a8355
--- /dev/null
+++ b/docs/en-US/components/search/index.md
@@ -0,0 +1,95 @@
+# Search 搜索框
+
+### 基本用法
+
+:::demo 使用`sm`,`''`,`lg`来定义`Search`基本类型
+
+```vue
+
+
+ Small
+
+ Middle
+
+ Large
+
+ Disabled
+
+
+
+```
+:::
+
+### 搜索图标左置
+
+:::demo 使用`left`,`right`来定义`Search`搜索图标位置, 默认`right`
+
+```vue
+
+
+
+
+
+```
+:::
+
+### 无边框
+
+:::demo 使用`noBorder`来定义`Search`无边框
+
+```vue
+
+
+
+
+
+```
+:::
+
+### 双向绑定
+
+:::demo 使用`v-model`双向绑定
+
+```vue
+
+
+
+
+
+
+```
+
+:::
+
+### API
+
+| 参数 | 类型 | 默认 | 说明 | 跳转 Demo | 全局配置项 |
+| :---------: | :------: | :-------: | :----------------------- | --------------------------------- | --------- |
+| size | `'sm'\|''\|'lg'` | '' | 可选,搜索框尺寸,有三种选择 lg、''、sm | [基本用法](#基本用法) ||
+| placeholder | `string` | -- | 可选,输入框 placeholder | [搜索图标左置](#搜索图标左置) ||
+| maxLength | `number` | -- | 可选,输入框的 max-length | [双向绑定](#双向绑定) ||
+| delay | `number` | 300 | 可选,debounceTime 的延迟 | [基本用法](#基本用法) ||
+| disabled | `boolean` | false | 可选,输入框是否被禁用 | [基本用法](#基本用法) ||
+| autoFocus | `boolean` | false | 可选,输入框是否自动对焦 | [基本用法](#基本用法) ||
+| isKeyupSearch | `boolean` | false | 可选,是否支持输入值立即触发 searchFn | [基本用法](#基本用法) ||
+| iconPosition | `string` | 'right' | 可选,搜索图标位置,有两种选择'left' / 'right' | [搜索图标左置](#搜索图标左置) ||
+| noBorder | `boolean` | false | 可选,是否显示边框 | [无边框](#无边框) ||
+| cssClass | `string` | '' | 可选,支持传入类名到输入框上 | [双向绑定](#双向绑定) ||
+
+### d-search 事件
+
+| 事件 | 类型 | 说明 | 跳转 Demo |
+| :---------: | :------: | :--------------------: | :---------: |
+| searchFn | `string` | 回车或点击搜索按钮触发的回调函数,返回文本框输入的值 | [基本用法](#基本用法) |
+
diff --git a/docs/en-US/components/select/index.md b/docs/en-US/components/select/index.md
new file mode 100644
index 00000000..5440b1c7
--- /dev/null
+++ b/docs/en-US/components/select/index.md
@@ -0,0 +1,175 @@
+# Select 下拉选择框
+
+用于从列表中选择单个或者多个数据
+
+### 基本用法
+
+:::demo 通过`size`:`sm`,`md(默认)`,`lg`来设置`Select`大小,通过`overview`:`underlined`设置只有下边框样式
+
+```vue
+
+
+ Small
+
+
+ Middle
+
+
+ Large
+
+
+ Underlined
+
+
+
+
+
+```
+:::
+
+#### 多选
+
+:::demo 通过`multiple`:`true`来开启多选
+
+```vue
+
+
+
+
+
+```
+:::
+
+#### 禁用
+
+:::demo 通过`disabled`:`true`来禁用`Select`,通过`option-disabled-key`来设置单个选项禁用,比如设置`disabled`字段,则对象上disabled为`true`时不可选择
+
+```vue
+
+
+
+
+
+
+
+
+
+
+```
+:::
+
+#### 可清空
+
+:::demo 通过`allow-clear`:`true`来设置`Select`可清空
+
+```vue
+
+
+
+
+
+
+
+
+```
+:::
diff --git a/docs/en-US/components/slider/index.md b/docs/en-US/components/slider/index.md
new file mode 100644
index 00000000..171e2e5b
--- /dev/null
+++ b/docs/en-US/components/slider/index.md
@@ -0,0 +1,128 @@
+# Slider 滑动输入条
+
+滑动输入条
+
+### 何时使用
+
+当用户需要在数值区间内进行选择时使用
+
+### 基本用法
+
+
+
+
+
+### 带有输入框的滑动组件
+
+
+
+
+
+### 可设置 Step 的滑动组件
+
+
+
+
+
+```html
+
+
+
+
+
+
+
+
+
+
+```
+
+### 禁止输入态
+
+
+
+
+
+```html
+
+
+
+
+```
+
+
+
+### API
+
+d-slider 参数
+
+| 参数 | 类型 | 默认 | 说明 | 跳转 |
+| --------- | ------- | ----- | ------------------------------------------------------------------- | ---- |
+| max | number | 100 | 可选,滑动输入条的最大值 |[基本用法](#基本用法) |
+| min | number | 0 | 可选,滑动输入条的最小值 |[基本用法](#基本用法) |
+| step | number | 1 | 可选,滑动输入条的步长,取值必须大于等于1,且必须可被(max-min)整除 |[基本用法](#可设置Step的滑动组件) |
+| disabled | boolean | false | 可选,值为 true 时禁止用户输入 |[基本用法](#禁止输入态) |
+| showInput | boolean | false | 可选,值为 true 显示输入框 |[基本用法](#带有输入框的滑动组件) |
+
diff --git a/docs/en-US/components/status/index.md b/docs/en-US/components/status/index.md
new file mode 100644
index 00000000..4f0996af
--- /dev/null
+++ b/docs/en-US/components/status/index.md
@@ -0,0 +1,26 @@
+# Status 状态
+
+传达交互结果的组件。
+
+### 何时使用
+
+表示一个任务的执行结果时使用。
+
+### 基本用法
+Success
+Error
+Warning
+Initial
+Waiting
+Running
+Invalid
+
+```html
+Success
+Error
+Warning
+Initial
+Waiting
+Running
+Invalid
+```
\ No newline at end of file
diff --git a/docs/en-US/components/sticky/index.md b/docs/en-US/components/sticky/index.md
new file mode 100644
index 00000000..e3acf7c0
--- /dev/null
+++ b/docs/en-US/components/sticky/index.md
@@ -0,0 +1,139 @@
+# sticky 便贴
+
+### 何时使用
+当用户在滚动屏幕时,需要某个区域内容在段落或者浏览器可视区域可见时。
+
+### 基本用法
+
+:::demo 默认容器为父元素
+
+```vue
+
+
+
+
+
+
+```
+:::
+
+### 指定容器
+
+:::demo
+
+```vue
+
+
+
+
+
+```
+:::
+
+
+### 指定滚动容器
+
+:::demo
+
+```vue
+
+
+
+
+
+
+```
+:::
+
+
+### API
+
+| 参数 | 类型 | 默认 | 说明 | 跳转 Demo | 全局配置项 |
+| :---------: | :------: | :-------: | :----------------------- | --------------------------------- | --------- |
+| zIndex | `number` | -- | 可选,指定包裹层的 z-index,用于浮动的时候控制 z 轴的叠放 | [基本用法](#基本用法) ||
+| container | `Element` | 父容器 | 可选,触发的容器,可不同于父容器 | [指定容器](#指定容器) ||
+| view | `{top?:number,bottom?:number}` | {top:0,bottom:0} | 可选,用于可视区域的调整,比如顶部有固定位置的头部等,数值对应被遮挡的顶部或底部的高度 | [基本用法](#基本用法) ||
+| scrollTarget | `Element` | document.documentElement | 可选,设置要发生滚动的容器,一般为滚动条所在容器,为主页面的滚动条时候可以不设置 | [指定滚动容器](#指定滚动容器) ||
+
+
+### d-sticky 事件
+
+| 事件 | 类型 | 说明 | 跳转 Demo |
+| :---------: | :------: | :--------------------: | :---------: |
+| statusChange | `string` | 可选,状态变化的时候触发,值为变化后的状态值 | [基本用法](#基本用法) |
+
diff --git a/docs/en-US/components/switch/index.md b/docs/en-US/components/switch/index.md
new file mode 100644
index 00000000..5845385f
--- /dev/null
+++ b/docs/en-US/components/switch/index.md
@@ -0,0 +1,66 @@
+# Switch 开关
+
+开/关切换组件。
+
+### 何时使用
+
+当两种状态需要来回切换控制时,比如启用/禁用。
+
+### 基本用法
+
+
+
+#### Small
+
+
+
+
+
+
+
+
+#### Middle
+
+
+
+
+
+
+
+
+
+
+
+
+#### Large
+
+
+
+
+
+```html
+
+
+
+
+```
+
+
diff --git a/docs/en-US/components/tabs/index.md b/docs/en-US/components/tabs/index.md
new file mode 100644
index 00000000..1fe14767
--- /dev/null
+++ b/docs/en-US/components/tabs/index.md
@@ -0,0 +1,7 @@
+# Tabs 选项卡切换
+
+选项卡切换组件。
+
+### 何时使用
+
+用户需要通过平级的区域将大块内容进行收纳和展现,保持界面整洁。
diff --git a/docs/en-US/components/tag-input/index.md b/docs/en-US/components/tag-input/index.md
new file mode 100644
index 00000000..80bd047c
--- /dev/null
+++ b/docs/en-US/components/tag-input/index.md
@@ -0,0 +1,44 @@
+# TagInput 标签输入框
+
+输入标签组件。
+
+### 何时使用
+
+当用户需要输入多个标签时。
+
+### 基本用法
+
+
+
+```html
+
+```
+
+
\ No newline at end of file
diff --git a/docs/en-US/components/toast/index.md b/docs/en-US/components/toast/index.md
new file mode 100644
index 00000000..2218666a
--- /dev/null
+++ b/docs/en-US/components/toast/index.md
@@ -0,0 +1,611 @@
+# Toast 全局通知
+
+全局信息提示组件。
+
+### 何时使用
+
+当需要向用户全局展示提示信息时使用,显示数秒后消失。
+
+### 基本用法
+
+common 时不展示图标。
+
+
+
+```html
+
+```
+
+```ts
+import { defineComponent, ref } from 'vue'
+
+export default defineComponent({
+ setup() {
+ const msgs = ref([])
+
+ function showToast(type: any) {
+ switch (type) {
+ case 'link':
+ msgs.value = [
+ { severity: 'info', summary: 'Relative', detail: `Back to Home Page ` },
+ { severity: 'info', summary: 'Absolute', content: 'slot:customTemplate', myInfo: 'Devui' }
+ ]
+ break
+ case 'multiple':
+ msgs.value = [
+ {
+ severity: 'info',
+ summary: 'Summary',
+ content: 'This is a test text. This is a test text. This is a test text.'
+ },
+ {
+ severity: 'info',
+ summary: 'Summary',
+ content: 'This is a test text. This is a test text. This is a test text.'
+ }
+ ]
+ break
+ case 'noTitle':
+ msgs.value = [{ severity: 'warn', content: 'This is a test text. This is a test text. This is a test text.' }]
+ break
+ case 'plainText':
+ msgs.value = [{ severity: 'info', content: 'data:' }]
+ break
+ default:
+ msgs.value = [
+ {
+ severity: type,
+ summary: 'Summary',
+ content: 'This is a test text. This is a test text. This is a test text.'
+ }
+ ]
+ }
+ }
+
+ return {
+ msgs,
+ showToast
+ }
+ }
+})
+```
+
+### 超时时间
+
+当设置超时时间、没有标题时,则不展示标题和关闭按钮。
+
+
+
+ Success
+ Warn
+ Error
+ common
+
+
+```html
+
+
+ Success
+ Warn
+ Error
+ common
+
+```
+
+```ts
+import { defineComponent, ref } from 'vue'
+
+export default defineComponent({
+ setup() {
+ const msgs = ref([])
+
+ function showToast(type: any) {
+ switch (type) {
+ case 'error':
+ msgs.value = [{ severity: type, content: 'This is a test text. This is a test text. This is a test text.' }]
+ break
+ case 'common':
+ msgs.value = [{ severity: type, content: 'This is a test text. This is a test text. This is a test text.' }]
+ break
+ default:
+ msgs.value = [
+ {
+ severity: type,
+ summary: 'Summary',
+ content: 'This is a test text. This is a test text. This is a test text.'
+ }
+ ]
+ }
+ }
+
+ return {
+ msgs,
+ showToast
+ }
+ }
+})
+```
+
+### 自定义样式
+
+
+
+
+
+```html
+
+```
+
+```scss
+.custom-class {
+ .devui-toast-item-container {
+ color: #252b3a;
+ background-color: #ffffff;
+
+ .devui-toast-icon-close {
+ top: 10px;
+ right: 13px;
+
+ & i.icon {
+ color: #252b3a !important;
+ }
+ }
+
+ .devui-toast-image {
+ top: 15px;
+ }
+
+ .devui-toast-message {
+ line-height: 23px;
+
+ .devui-toast-title {
+ font-size: 16px;
+ }
+
+ p {
+ font-size: 14px;
+ }
+ }
+ }
+}
+```
+
+```ts
+import { defineComponent, ref } from 'vue'
+
+export default defineComponent({
+ setup() {
+ const msgs = ref([])
+
+ function showToast() {
+ msgs.value = [
+ {
+ severity: 'success',
+ summary: 'Success',
+ content: 'This is a test text. This is a test text. This is a test text.'
+ }
+ ]
+ }
+
+ return {
+ msgs,
+ showToast
+ }
+ }
+})
+```
+
+### 每个消息使用单独的超时时间
+
+当设置超时时间模式为 single 时,每个消息使用自身的 life 作为超时时间,如果未设置则按 severity 判断,severity 也未设置时默认超时时间为 5000 毫秒。
+
+
+
+```html
+
+```
+
+```ts
+import { defineComponent, ref } from 'vue'
+
+export default defineComponent({
+ setup() {
+ const msgs = ref([])
+
+ function showToast() {
+ msgs.value = [
+ { life: 3000, summary: 'Summary', content: 'This is a test text. This is a test text. This is a test text.' },
+ {
+ life: 6000,
+ severity: 'info',
+ summary: 'Summary',
+ content: 'This is a test text. This is a test text. This is a test text.'
+ },
+ {
+ severity: 'success',
+ summary: 'Success',
+ content: 'This is a test text. This is a test text. This is a test text.'
+ },
+ { severity: 'warn', summary: 'Warn', content: 'This is a test text. This is a test text. This is a test text.' }
+ ]
+ }
+
+ return {
+ msgs,
+ showToast
+ }
+ }
+})
+```
+
+### 服务方式调用
+
+使用服务的方式创建 toast 全局通知。
+
+click me show simplest toast!
+click me show customer toast!
+click me close customer toast!
+only close first customer toast!
+
+```html
+click me show simplest toast!
+click me show customer toast!
+click me close customer toast!
+only close first customer toast!
+```
+
+```ts
+import { defineComponent, ref } from 'vue'
+import { ToastService } from 'devui/toast'
+
+export default defineComponent({
+ setup() {
+ const results = ref()
+
+ function openToast2() {
+ results.value = ToastService.open({
+ value: [
+ { severity: 'info', summary: 'summary', content: '1. I am content' },
+ { severity: 'error', summary: 'summary', content: '2. I am content' },
+ { severity: 'error', summary: 'summary', content: '3. I am content' }
+ ],
+ sticky: true,
+ style: { width: '600px', color: 'red' },
+ styleClass: 'myCustom-toast',
+ life: 5000,
+ lifeMode: 'global',
+ /*
+ 接收发射过来的数据
+ */
+ onCloseEvent(value: any) {
+ console.log('closeEvent', value)
+ },
+ onValueChange(value: any) {
+ console.log('valueChange', value)
+ }
+ })
+
+ console.log('results', results.value)
+
+ isShow.value = true
+ }
+
+ function closeToast2() {
+ results.value.toastInstance.close()
+ isShow.value = false
+ }
+
+ function closeToast3() {
+ /*
+ 1.可以根据指定下标关闭 results.value.toastInstance.close(0);
+ 2.可以根据value对象去关闭,作用跟1是等同的,如下所示:
+ */
+ results.value.toastInstance.close({ severity: 'info', summary: 'summary', content: '1. I am content' })
+ }
+
+ return {
+ isShow,
+ openToast,
+ openToast2,
+ closeToast2,
+ closeToast3
+ }
+ }
+})
+```
+
+### Toast Api
+
+
+
+### Toast Event
+
+
+
+### 接口 & 类型定义
+
+Message
+
+```ts
+export interface Message {
+ severity?: string // 预设值有 common、success、error、warn、info,超时时间参见 life 说明,未设置或非预设值时超时时间为 5000 毫秒,warn 和 error 为 10000 毫秒
+ summary?: string // 消息标题。当设置超时时间,未设置标题时,不展示标题和关闭按钮
+ detail?: string // 消息内容,推荐使用content替换
+ content?: string | `slot:${string}` | (message: Message) => ReturnType // 消息内容,支持纯文本和插槽,推荐使用
+ life?: number // 单个消息超时时间,需设置 lifeMode 为 single 。每个消息使用自己的超时时间,开启该模式却未设置时按 severity 判断超时时间
+ id?: any // 消息ID
+}
+```
+
+### Service 引入方式
+
+```ts
+import { ToastService } from 'devui'
+```
+
+### Service 使用
+
+```ts
+// 方式 1,局部引入 ToastService
+ToastService.open({ xxx })
+
+// 方式2,全局属性
+app.config.globalProperties.$toastService.open({ xxx })
+```
+
+### Service Api
+
+
+
+
+
+
diff --git a/docs/en-US/components/tooltip/index.md b/docs/en-US/components/tooltip/index.md
new file mode 100644
index 00000000..3faa69f2
--- /dev/null
+++ b/docs/en-US/components/tooltip/index.md
@@ -0,0 +1,100 @@
+# Tooltip
+
+Text prompt component。
+
+### When to use
+
+The user moves the mouse to the text, and it is used when further prompts are needed。
+
+### Basic usage
+
+:::demo We can control the display position of the tooltip by controlling the attribute `position`. There are 4 values for `position`, which are `top`, `right`, `bottom`, and `left`. Control the content of the tooltip prompt box through the attribute `content`。
+
+上面
+
+右面
+
+下面
+
+左面
+
+```vue
+
+
+ 上面
+
+
+ 下面
+
+
+ 左面
+
+
+ 右面
+
+
+```
+
+```css
+.example {
+ height: 50px;
+ width: 60px;
+ background: cornflowerblue;
+ margin-top: 30px;
+}
+```
+:::
+
+### Delay trigger
+
+The mouse will be triggered after moving in for more than [mouseEnterDelay] milliseconds to prevent flashing caused by the user accidentally swiping. The default value is 150 milliseconds; after the mouse is moved out, the toolTip component will be hidden after [mouseLeaveDelay] milliseconds. The default value Is 100 milliseconds。
+
+:::demo Use the `mouseEnterDelay` property to control the `delay display` of the tooltip prompt box (the default is 100ms), and the `mouseLeaveDelay` property to control the `delay disappearing` of the tooltip prompt box (the default is 150ms)
+MouseEnter delay 500ms
+
+MouseLeave delay 1000ms
+```vue
+
+
+ MouseEnter delay 500ms
+
+
+
+ MouseLeave delay 1000ms
+
+
+```
+
+```css
+.customCss {
+ width: fit-content;
+ height: 30px;
+ padding: 10px;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ color: #fff;
+ background: cornflowerblue;
+}
+.customCss-leave {
+ width: fit-content;
+ height: 30px;
+ padding: 10px;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ color: #252b3a;
+ background: #fff;
+}
+```
+:::
+
+### Tooltip Api
+
+| parameter | type | default | description | jump Demo | Global configuration items |
+| :---------: | :------: | :-------: | :----------------------- | --------------------------------- | --------- |
+| content | `string|DOMString` | -- | Required, tooltip displays content | [基本用法](#基本用法) ||
+| position | `PositionType | PositionType[]` | ['top', 'right', 'bottom', 'left'] | Optional, tooltip display position | [基本用法](#基本用法) ||
+| showAnimation | `boolean` | true | Optional, whether to show the wipe out animation | |✔|
+| mouseEnterDelay | `number` | 150 | Optional, how long is the delay before the Tooltip is displayed after the mouse moves in, the unit is ms | [基本用法](#延时触发) ||
+| mouseLeaveDelay | `number` | 100 | Optional, after the mouse is moved out, how long is the delay before the Tooltip is hidden, the unit is ms | [基本用法](#延时触发) ||
diff --git a/docs/en-US/components/transfer/index.md b/docs/en-US/components/transfer/index.md
new file mode 100644
index 00000000..988204fe
--- /dev/null
+++ b/docs/en-US/components/transfer/index.md
@@ -0,0 +1,224 @@
+# Transfer 穿梭框
+
+双栏穿梭选择框。
+
+### 何时使用
+
+需要在多个可选项中进行多选时。穿梭选择框可用只管的方式在两栏中移动数据,完成选择行为。其中左边一栏为source,右边一栏为target。最终返回两栏的数据,提供给开发者使用。
+
+### 基本用法
+
+穿梭框基本用法。
+
+
+
+
+
+```html
+
+
+```
+
+```ts
+import {defineComponent, reactive} from 'vue'
+ type TData = {
+ id: number
+ age: number
+ value: string
+ disabled?: boolean
+ }
+ export default defineComponent({
+ setup() {
+ const options = reactive({
+ titles: ['sourceHeader', 'targetHeader'],
+ source: [
+ {
+ key: '北京',
+ value: '北京',
+ disabled: false
+ },
+ {
+ key: '上海',
+ value: '上海',
+ disabled: true
+ },
+ {
+ key: '广州',
+ value: '广州',
+ disabled: false
+ },
+ {
+ key: '深圳',
+ value: '深圳',
+ disabled: false
+ },
+ {
+ key: '成都',
+ value: '成都',
+ disabled: false
+ },
+ {
+ key: '武汉',
+ value: '武汉',
+ disabled: false
+ },
+ {
+ key: '西安',
+ value: '西安',
+ disabled: false
+ },
+ {
+ key: '福建',
+ value: '福建',
+ disabled: false
+ },
+ {
+ key: '大连',
+ value: '大连',
+ disabled: false
+ },
+ {
+ key: '重庆',
+ value: '重庆',
+ disabled: false
+ }
+ ],
+ target: [
+ {
+ key: '南充',
+ value: '南充',
+ disabled: false
+ },
+ {
+ key: '广元',
+ value: '广元',
+ disabled: true
+ },
+ {
+ key: '绵阳',
+ value: '绵阳',
+ disabled: false
+ }
+ ],
+ isSearch: true,
+ modelValues: ['深圳', '成都', '绵阳']
+ })
+ return {
+ options
+ }
+ }
+ })
+```
+
+### 参数
+
+| **参数** | **类型** | **默认** | **说明** | **跳转 Demo** |
+| ------------------ | ------------------------------------------------------------ | ------------------------- | ------------------------------------------------------------ | ---------------------------- |
+| sourceOption | Array | [] | 可选参数,穿梭框源数据 | [基本用法](#基本用法) |
+| targetOption | Array | [] | 可选参数,穿梭框目标数据 | [基本用法](#基本用法) |
+| titles | Array | [] | 可选参数,穿梭框标题 | [基本用法](#基本用法) |
+| height | string | 320px | 可选参数,穿梭框高度 | [基本用法](#基本用法) |
+| isSearch | boolean | true | 可选参数,是否可以搜索 | [基本用法](#基本用法) |
+| disabled | boolean | false | 可选参数 穿梭框禁止使用 | [基本用法](#基本用法) |
diff --git a/docs/en-US/components/upload/index.md b/docs/en-US/components/upload/index.md
new file mode 100644
index 00000000..b2f8d8c2
--- /dev/null
+++ b/docs/en-US/components/upload/index.md
@@ -0,0 +1,1297 @@
+# Upload
+
+File upload component。
+
+### When to use
+
+When you need to upload files to the back-end server。
+
+### Basic usage
+
+Single file upload, drag file upload, prohibit upload。
+
+Basic Usage
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+Dragdrop
+
+:::demo
+
+```vue
+
+
+
+ Upload
+
+
+
+```
+
+:::
+
+Disabled
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+### Multiple file upload
+
+Multi-file upload, support drag file upload, prohibit upload。
+
+Basic Usage
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+Upload Directory
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+Dragdrop
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+Disabled
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+### Auto upload
+
+Set up automatic upload via autoUpload。
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+### customize
+
+Customize the upload button, set the selected file list template through slot preloadFiles, and set the uploaded file list template through slot uploadedFiles。
+
+:::demo
+
+```vue
+
+
+
+
+
+
+
+
+ {{ fileUploader.file.name }}
+
+
+
+ preLoad
+ Uploading}
+ Uploaded
+ Upload Failed
+
+
+
+ slotProps.deleteFile(fileUploader.filePath)
+ "
+ >
+ Delete
+
+
+
+
+
+
+
+
+
+
+ {{ uploadedFile.name }}
+
+
+ Uploaded
+
+
+ slotProps.deleteFile(uploadedFile)"
+ >
+ Delete
+
+
+
+
+
+
+
+
+
+ 自定义上传
+
+
+
+
+
+```
+
+:::
+
+### Dynamic upload parameters
+
+Users can dynamically modify upload parameters through beforeUpload。
+
+:::demo
+
+```vue
+
+
+
+
+```
+
+:::
+
+### Upload from any area
+
+Users can upload files in any area through the default slot。
+:::demo
+
+```vue
+
+
+ 选取文件
+
+
+
+
+ {{ fileUploader.file.name }}
+
+
+
+ preLoad
+ Uploading}
+ Uploaded
+ Upload Failed
+
+
+
+ slotProps.deleteFile(event)"
+ >
+ Delete
+
+
+
+
+
+
+
+
+
+
+ {{ uploadedFile.name }}
+
+
+ Uploaded
+
+
+ slotProps.deleteFile(uploadedFile)"
+ >
+ Delete
+
+
+
+
+
+
+
+
+
+```
+
+:::
+
+自定义默认 slot,初始显示已上传文件。
+
+:::demo
+
+```vue
+
+
+
+
+
+
+
+ 将文件拖到此处,或
+ 点击上传
+
+
+
+
+
+
+ {{ fileUploader.file.name }}
+
+
+
+ preLoad
+ Uploading
+ Uploaded
+ Upload Failed
+
+
+
+ slotProps.deleteFile(event)"
+ >
+ Delete
+
+
+
+
+
+
+
+
+
+
+ {{ uploadedFile.name }}
+
+
+ Uploaded
+
+
+ slotProps.deleteFile(uploadedFile)"
+ >
+ Delete
+
+
+
+
+
+
+
+
+
+
+```
+
+:::
+
+### API
+
+d-single-upload 参数
+
+| **参数** | **类型** | **默认** | 说明 | **跳转 Demo** |
+| ---------------------- | --------------------------------- | ---------- | ---------------------------------------------------------------------------------------- | --------------------- |
+| fileOptions | [IFileOptions](#ifileoptions) | -- | 必选,待上传文件配置 | [基本用法](#基本用法) |
+| filePath | `string` | -- | 文件路径 | [基本用法](#基本用法) |
+| uploadOptions | [IUploadOptions](#iuploadoptions) | \-- | 必选,上传配置 | [基本用法](#基本用法) |
+| autoUpload | `boolean` | false | 可选,是否自动上传 | [基本用法](#基本用法) |
+| placeholderText | `string` | '选择文件' | 可选,上传输入框中的 Placeholder 文字 | [基本用法](#基本用法) |
+| uploadText | `string` | '上传' | 可选,上传按钮文字 | [基本用法](#基本用法) |
+| uploadedFiles | `Array` | [] | 可选,获取已上传的文件列表 | [基本用法](#基本用法) |
+| withoutBtn | `boolean` | false | 可选,是否舍弃按钮 | [基本用法](#基本用法) |
+| enableDrop | `boolean` | false | 可选,是否支持拖拽 | [基本用法](#基本用法) |
+| beforeUpload | `boolean Promise ` | \-- | 可选,上传前的回调,通过返回`true` or `false` ,控制文件是否上传,参数为文件信息及上传配置 | [基本用法](#基本用法) |
+| dynamicUploadOptionsFn | [IUploadOptions](#iuploadoptions) | \-- | 为文件动态设置自定义的上传参数, 参数为当前选中文件及`uploadOptions`的值 | [基本用法](#基本用法) |
+| disabled | `boolean` | false | 可选,是否禁用上传组件 | [基本用法](#基本用法) |
+| showTip | `boolean` | false | 可选,是否显示上传提示信息 | [自动上传](#自动上传) |
+
+d-single-upload 事件
+
+| 参数 | 类型 | 说明 | 跳转 Demo |
+| ----------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------- |
+| fileOver | `EventEmitter` | 支持拖拽上传时,文件移动到可拖放区域触发事件,可拖动的元素移出放置目标时返回`false`,元素正在拖动到放置目标时返回`true` | [基本用法](#基本用法) |
+| fileDrop | `EventEmitter` | 支持拖拽上传时,当前拖拽的文件列表回调,单文件上传默认返回第一个文件 | [基本用法](#基本用法) |
+| successEvent | `EventEmitter>` | 上传成功时的回调函数,返回文件及 xhr 的响应信息 | [基本用法](#基本用法) |
+| errorEvent | `EventEmitter<{file: File; response: any}>` | 上传错误时的回调函数,返回上传失败的错误信息 | [基本用法](#基本用法) |
+| deleteUploadedFileEvent | `EventEmitter` | 删除上传文件的回调函数,返回删除文件的路径信息 | [基本用法](#基本用法) |
+| fileSelect | `EventEmitter` | 文件选择后的回调函数,返回已选择文件信息 | [基本用法](#基本用法) |
+
+d-multiple-upload 参数
+
+| **参数** | **类型** | **默认** | 说明 | **跳转 Demo** |
+| ---------------------- | --------------------------------- | -------------- | ---------------------------------------------------------------------------------------- | ------------------------- |
+| fileOptions | [IFileOptions](#ifileoptions) | -- | 必选,待上传文件配置 | [多文件上传](#多文件上传) |
+| filePath | `string` | -- | 文件路径 | [多文件上传](#多文件上传) |
+| uploadOptions | [IUploadOptions](#iuploadoptions) | \-- | 必选,上传配置 | [多文件上传](#多文件上传) |
+| autoUpload | `boolean` | false | 可选,是否自动上传 | [自动上传](#自动上传) |
+| placeholderText | `string` | '选择多个文件' | 可选,上传输入框中的 Placeholder 文字 | [基本用法](#基本用法) |
+| uploadText | `string` | '上传' | 可选,上传按钮文字 | [基本用法](#基本用法) |
+| uploadedFiles | `Array` | [] | 可选,获取已上传的文件列表 | [多文件上传](#多文件上传) |
+| withoutBtn | `boolean` | false | 可选,是否舍弃按钮 | [自定义](#自定义) |
+| enableDrop | `boolean` | false | 可选,是否支持拖拽 | [多文件上传](#多文件上传) |
+| beforeUpload | `boolean Promise` | \-- | 可选,上传前的回调,通过返回`true` or `false` ,控制文件是否上传,参数为文件信息及上传配置 | [多文件上传](#多文件上传) |
+| dynamicUploadOptionsFn | [IUploadOptions](#iuploadoptions) | \-- | 为文件动态设置自定义的上传参数, 参数为当前选中文件及`uploadOptions`的值 | [多文件上传](#多文件上传) |
+| disabled | `boolean` | false | 可选,是否禁用上传组件 | [多文件上传](#多文件上传) |
+| showTip | `boolean` | false | 可选,是否显示上传提示信息 | [多文件上传](#多文件上传) |
+| setCustomUploadOptions | [IUploadOptions](#iuploadoptions) | -- | 为每个文件设置自定义的上传参数, 参数为当前选中文件及`uploadOptions`的值 | [自定义](#自定义) |
+
+d-multiple-upload 事件
+
+| 参数 | 类型 | 说明 | 跳转 Demo |
+| ----------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------- |
+| fileOver | `EventEmitter` | 支持拖拽上传时,文件移动到可拖放区域触发事件,可拖动的元素移出放置目标时返回`false`,元素正在拖动到放置目标时返回`true` | [多文件上传](#多文件上传) |
+| fileDrop | `EventEmitter` | 支持拖拽上传时,当前拖拽的文件列表回调,单文件上传默认返回第一个文件 | [多文件上传](#多文件上传) |
+| successEvent | `EventEmitter>` | 上传成功时的回调函数,返回文件及 xhr 的响应信息 | [多文件上传](#多文件上传) |
+| errorEvent | `EventEmitter<{file: File; response: any}>` | 上传错误时的回调函数,返回上传失败的错误信息 | [多文件上传](#多文件上传) |
+| deleteUploadedFileEvent | `EventEmitter` | 删除上传文件的回调函数,返回删除文件的路径信息 | [多文件上传](#多文件上传) |
+| fileSelect | `EventEmitter` | 文件选择后的回调函数,返回已选择文件信息 | [多文件上传](#多文件上传) |
+
+### slot
+
+| name | 默认 | 说明 | 跳转 Demo |
+| ------------- | ---- | ----------------------------------------------------------------------------- | ----------------- |
+| preloadFiles | -- | 可选,用于创建自定义 已选择文件列表模板,参数为 `{fileUploaders, deleteFile}` | [自定义](#自定义) |
+| uploadedFiles | -- | 可选,用于创建自定义 已上传文件列表模板,参数为 `{uploadedFiles, deleteFile}` | [自定义](#自定义) |
+
+### 接口 & 类型定义
+
+### IUploadOptions
+
+```typescript
+export class IUploadOptions {
+ // 上传接口地址
+ uri: string
+ // http 请求方法
+ method?: string
+ // 上传文件大小限制
+ maximumSize?: number
+ // 自定义请求headers
+ headers?: { [key: string]: any }
+ // 认证token
+ authToken?: string
+ // 认证token header标示
+ authTokenHeader?: string
+ // 上传额外自定义参数
+ additionalParameter?: { [key: string]: any }
+ // 上传文件字段名称,默认file
+ fileFieldName?: string
+ // 多文件上传,是否检查文件重名,设置为true,重名文件不会覆盖,否则会覆盖上传
+ checkSameName?: boolean
+ // 指示了是否该使用类似cookies,authorization headers(头部授权)或者TLS客户端证书这一类资格证书来创建一个跨站点访问控制(cross-site Access-Control)请求
+ withCredentials?: boolean
+ // 手动设置返回数据类型
+ responseType?: 'arraybuffer' | 'blob' | 'json' | 'text'
+}
+```
+
+### IFileOptions
+
+```typescript
+export class IFileOptions {
+ // 规定能够通过文件上传进行提交的文件类型,例如 accept: '.xls,.xlsx,.pages,.mp3,.png'
+ accept?: string
+ // 输入字段可选择多个值
+ multiple?: boolean
+ // 是否允许用户选择文件目录,而不是文件
+ webkitdirectory?: boolean
+}
+```
diff --git a/docs/en-US/design.md b/docs/en-US/design.md
new file mode 100644
index 00000000..f936956a
--- /dev/null
+++ b/docs/en-US/design.md
@@ -0,0 +1 @@
+# Design
\ No newline at end of file
diff --git a/docs/en-US/index.md b/docs/en-US/index.md
new file mode 100644
index 00000000..4194e11d
--- /dev/null
+++ b/docs/en-US/index.md
@@ -0,0 +1,43 @@
+# Quick Start
+
+Guide you how to use DevUI in your project
+
+### Vue version
+
+Vue version currently supported ^3.0.0
+
+### 1. Create a project
+
+It is recommended to use @vite/cli to create your project
+
+```shell
+yarn create vite my-vue-app --template vue-ts
+```
+
+### 2. Install
+
+Go to your project folder and use yarn to install DevUI
+
+```shell
+yarn add vue-devui
+
+# 可选,字体图标库, 部分Demo依赖此字体库
+# yarn add @devui-design/icons
+```
+
+### 3. Introduce modules and styles
+
+main.ts
+
+```js
+import DevUI from 'vue-devui'
+import 'vue-devui/style.css'
+
+createApp(App).use(DevUI).mount('#app')
+```
+
+### 4. Start development and debugging
+
+```shell
+yarn dev
+```
\ No newline at end of file
diff --git a/docs/en-US/theme.md b/docs/en-US/theme.md
new file mode 100644
index 00000000..b29f0a86
--- /dev/null
+++ b/docs/en-US/theme.md
@@ -0,0 +1 @@
+# Theme
\ No newline at end of file
diff --git a/docs/en-US/version.md b/docs/en-US/version.md
new file mode 100644
index 00000000..e04a043b
--- /dev/null
+++ b/docs/en-US/version.md
@@ -0,0 +1 @@
+# Version
\ No newline at end of file
--
Gitee
From 65c412dffa532790dbfa4d7d37d9701e673f2b1e Mon Sep 17 00:00:00 2001
From: xiaojiujiu <3507440900@qq.com>
Date: Mon, 8 Nov 2021 00:03:58 +0800
Subject: [PATCH 2/8] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E9=83=A8=E5=88=86?=
=?UTF-8?q?=E7=BB=84=E4=BB=B6=E8=8B=B1=E6=96=87=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../en-US/components/accordion/accordion.md | 189 ++++++++++++++++++
.../docs/en-US/components/alert/alert.md | 38 ++++
.../docs/en-US/components/anchor/anchor.md | 126 ++++++++++++
.../docs/en-US/components/avatar/avatar.md | 42 ++++
.../docs/en-US/components/button/button.md | 82 ++++++++
5 files changed, 477 insertions(+)
create mode 100644 packages/devui-vue/docs/en-US/components/accordion/accordion.md
create mode 100644 packages/devui-vue/docs/en-US/components/alert/alert.md
create mode 100644 packages/devui-vue/docs/en-US/components/anchor/anchor.md
create mode 100644 packages/devui-vue/docs/en-US/components/avatar/avatar.md
create mode 100644 packages/devui-vue/docs/en-US/components/button/button.md
diff --git a/packages/devui-vue/docs/en-US/components/accordion/accordion.md b/packages/devui-vue/docs/en-US/components/accordion/accordion.md
new file mode 100644
index 00000000..dba8ce67
--- /dev/null
+++ b/packages/devui-vue/docs/en-US/components/accordion/accordion.md
@@ -0,0 +1,189 @@
+# How to use
+
+Import into module:
+
+```typescript
+import { AccordionModule } from ' ng-devui/accordion';
+```
+
+On the page:
+
+```html
+
+```
+
+## Accordion
+
+### d-accordion parameter
+
+| Parameter | Type | Default | Description | Jump to Demo |Global Config|
+| :----------------: | :----------------: | :----------------------------------------------------: | :--------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -------------------------------------------------------------------------- |
+| data | `Array \| AccordionMenuType` | -- | Required. Data source. You can customize an array or use the preset `AccordionMenuType` | [Basic usage](demo#basic-usage) |
+| titleKey | `string` | 'title' | Optional. Title attribute name. The type of item[titleKey] is `string`, indicating the title content. | [Change key value](demo#change-values) |
+| loadingKey | `string` | 'loading' | Optional. attribute name for determining whether a submenu is loaded. The type of item[loadingKey] is `boolean` | [Change key value](demo#change-values) |
+| childrenKey | `string` | 'children' | Optional. Submenu attribute name. The type of item[childrenKey] is `Array` | [Change key value](demo#change-values) |
+| disabledKey | `string` | 'disabled' | Optional. indicating whether to disable the attribute. The type of item[disabledKey] is `boolean` | [Change key value](demo#change-values) |
+| activeKey | `string` | 'active' | Optional. indicating whether a submenu is activated. The type of item[activeKey] is `boolean` | [Change key value](demo#change-values) |
+| openKey | `string` | 'open' | Optional. indicating whether a menu is expanded. The type of item[openKey] is `boolean` | [Change key value](demo#change-values) |
+| restrictOneOpen | `boolean` | false | Optional. Only one level-1 menu can be opened at a time. By default, there is no restriction. | [Basic usage](demo#basic-usage) |
+| menuItemTemplate | `TemplateRef` | Built-in | Optional. It can expand the menu content bar template. The available variable values are as follows. | [Using a Template](demo#using-templates) |
+| itemTemplate | `TemplateRef` | Built-in | Optional. The menu content bar template can be clicked. The available variable values are as follows: | [Using a Template](demo#using-templates) |
+| noContentTemplate | `TemplateRef` | Built-in | Optional. If there is no content, use a customized template. The available variable values are as follows: | [Using a Template](demo#using-templates) |
+| loadingTemplate | `TemplateRef` | Built-in | Optional. A customized template is used for loading. The available variable values are as follows | [Using a Template](demo#using-templates) |
+| innerListTemplate | `TemplateRef` | Built-in | Optional. The sublist content is customized and used as a folding panel. The available variable values are as follows. | [Using a Template](demo#using-templates) |
+| linkType | `'routerLink'\|'hrefLink'\|'dependOnLinkTypeKey'\|'''` | '' | Optional. `routerLink'` indicates the routing scenario. `hrefLink'` indicates the external link scenario. `dependOnLinkTypeKey'` indicates the dynamic routing or external link scenario. `''` is the default non-link type (you cannot right-click to open a new tab page) | [Built-in route and link type](demo#use-built-in-routing-and-link-types) |
+| linkTypeKey | `string` | 'linkType' | Optional. Key value of the link type, which is used to specify the object link type attribute name when linkType is set to `'dependOnLinkTypeKey'`. The value of item[linkTypeKey] is `'routerLink'\|'hrefLink'\| string`, in the preceding information, `routerLink'` indicates a route link, `hrefLink'` indicates an external link, and other values are default non-link types. |
+| linkKey | `string` | 'link' | Optional. Key of the link content, which is used to set the value of the link value when linkType is not set to ````. item[linkKey] indicates the route address or hyperlink address. |
+| linkTargetKey | `string` | 'target' | Optional. Key of the target window to be linked, which is used for the link type. item[linkTargetKey] indicates the target window of a single link. |
+| linkDefaultTarget | `string` | '\_self' | Optional. If target is not set, the default value of target is `'\_self'`, which is used for the link type and its value is the same as that of target attribute of link a. | [Built-in route and link type](demo#use-built-in-routing-and-link-types) |
+| autoOpenActiveMenu | `boolean` | false | Optional. Whether to automatically expand menus with active subitems | [Composite Hierarchy and Auto Expand](demo#compound-level-and-auto-expand) |
+| accordionType | `normal ' \| 'embed'` | 'normal' | Optional. The menu format is common (with shadow) or embedded (without shadow). | [Basic usage](demo#basic-usage) |
+| showAnimation | `boolean` | true | Optional. Indicating whether to display animations. | [Built-in route and link type](demo#use-built-in-routing-and-link-types) | ✔ |
+
+### d-accordion event
+
+| Event | Type | Description | Jump to Demo |
+| :--------------: | :-----------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------- |
+| menuToggle | `EventEmitter<`[`AccordionMenuToggleEvent`](#accordionmenutoggleevent)`>` | Optional. The menu can be expanded. In the returned object, the attribute item is the object data clicked. If open is true, the object will be expanded. If open is false, the object will be closed. If parent is the parent object data. Event is the native event of the click event. | [Basic usage](demo#basic-usage) |
+| itemClick | `EventEmitter<`[`AccordionItemClickEvent`](#accordionitemclickevent)`>` | Optional. It can click a menu event. In the returned object, the attribute item is the object data of the clicked object, the preActive object is the object expanded last time, the parent object is the data of the parent object, and the event is the native event of the click event. | [Basic usage](demo#basic-usage) |
+| activeItemChange | `EventEmitter` | Optional. Data of the newly activated sub-item is sent when the sub-item is switched. | [Basic usage](demo#basic-usage) |
+
+### AccordionMenuType Definition
+
+```typescript
+/* Basic data type */
+type AccordionMenuItemLinkType = 'routerLink' | 'hrefLink' | string;
+export interface AccordionBase {
+ title: string;
+ disabled?: boolean;
+ [prop: string]: any;
+}
+interface IAccordionActiveable {
+ active?: boolean;
+}
+interface IAccordionFoldable {
+ open?: boolean;
+ loading?: boolean;
+ children?: Array;
+}
+interface IAccordionLinkable {
+ link?: string;
+ target?: boolean;
+ linkType?: AccordionMenuItemLinkType;
+}
+export interface AccordionBaseItem extends AccordionBase, IAccordionActiveable {}
+export interface AccordionBaseMenu extends AccordionBase, IAccordionFoldable {}
+export interface AccordionLinkableItem extends AccordionBase, IAccordionActiveable, IAccordionLinkable {}
+export interface AccordionMenuItem extends AccordionBase, IAccordionActiveable, IAccordionFoldable, IAccordionLinkable {}
+export type AccordionMenuType = Array;
+
+/* Common configuration data type */
+interface AccordionMenuKeyGroup {
+ titleKey?: string;
+ activeKey?: string;
+ disabledKey?: string;
+ openKey?: string;
+ loadingKey?: string;
+ childrenKey?: string;
+ linkKey?: string;
+ linkTargetKey?: string;
+ linkTypeKey?: string;
+}
+type AccordionTemplateRefArray = 'itemTemplate' | 'menuItemTemplate' | 'noContentTemplate' | 'loadingTemplate' | 'innerListTemplate';
+type AccordionTemplateRefGroup = {
+ [p in AccordionTemplateRefArray]: TemplateRef;
+};
+interface AccordionConfigOptions {
+ restrictOneOpen?: boolean;
+ autoOpenActiveMenu?: boolean;
+ showNoContent?: boolean;
+ linkDefaultTarget?: string;
+ i18nText: any;
+ linkType: 'routerLink' | 'hrefLink' | 'dependOnLinkTypeKey' | '';
+}
+export interface AccordionOptions extends AccordionConfigOptions, AccordionMenuKeyGroup, AccordionTemplateRefGroup {}
+```
+
+## AccordionMenuToggleEvent
+
+```typescript
+export type AccordionMenuToggleEvent = {
+ item: any;
+ open: boolean;
+ parent: any;
+ event: MouseEvent;
+};
+```
+
+## AccordionItemClickEvent
+
+```typescript
+export type AccordionItemClickEvent = {
+ item: any;
+ prevActiveItem?: any;
+ parent: any;
+ event: MouseEvent;
+};
+```
+
+### Templates can use variable values.
+
+#### Variable Usage
+
+```html
+{{myitem}}
+```
+
+#### menuItemTemplate Available variable values
+
+| Variable | Type | Variable Description |
+| :----------------: | :--------: | :------------------------------------------------------------------------------------------: |
+| item | `any` | Expandable menu data |
+| deepth | `number` | Indicates the nested structure level. |
+| parent | `any` | Parent menu data |
+| ~~~titleKey~~~ | `string` | Deprecated.~~~ The titleKey value of the component. ~~~ |
+| ~~~disabledKey~~~ | `string` | Deprecated. ~~~ The value of the disabledKey of the component. ~~~ |
+| ~~~openKey~~~ | `string` | Deprecated. ~~~ The openKey value of the component. ~~~ |
+| ~~~menuToggleFn~~~ | `Function` | Deprecated.~~~ The parameter should be item, indicating that the level-1 menu is clicked.~~~ |
+
+#### itemTemplate Available variable values
+
+| Variable | Type | Variable Description |
+| :---------------: | :--------: | :------------------------------------------------------------------------------------------: |
+| item | `any` | Clickable menu data |
+| deepth | `number` | The value indicates the nested structure level. |
+| parent | `any` | Parent menu data |
+| ~~~titleKey~~~ | `string` | Deprecated.~~~ The titleKey value of the component ~~~ |
+| ~~~disabledKey~~~ | `string` | Deprecated.~~~ The value of the disabledKey of the component ~~~ |
+| ~~~activeKey~~~ | `string` | Deprecated.~~~ The activeKey value of the component ~~~ |
+| ~~~itemClickFn~~~ | `Function` | Deprecated. ~~~The parameter should be item, indicating that the level-2 menu is clicked.~~~ |
+
+#### noContentTemplate Available variable value
+
+| Variable | Type | Variable Description |
+| :------: | :------: | :---------------------------------------------: |
+| item | `any` | Parent menu single data |
+| deepth | `number` | The value indicates the nested structure level. |
+
+#### loadingTemplate Available variable values
+
+| Variable | Type | Variable Description |
+| :---------------------: | :--------------: | :---------------------------------------------: |
+| item | `any` | Parent menu single data |
+| deepth | `number` | The value indicates the nested structure level. |
+| LoadingKey value of the | ~~~loadingKey~~~ | `string` | ~~~ component ~~~ |
+
+#### InnerListTemplate Available Variable Values
+
+| Variable | Type | Variable Description |
+| :---------------: | :--------: | :------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| item | `any` | Parent menu single data |
+| deepth | `number` | The value indicates the nested structure level. |
+| ~~~titleKey~~~ | `string` | Deprecated.~~~The titleKey value of the component ~~~ |
+| ~~~loadingKey~~~ | `string` | Deprecated.~~~ The loading key value of the component ~~~ |
+| ~~~childrenKey~~~ | `string` | Deprecated.~~~ The value of childrenKey of the component ~~~ |
+| ~~~disabledKey~~~ | `string` | Deprecated.~~~ The value of the disabledKey of the component ~~~ |
+| ~~~openKey~~~ | `string` | Deprecated.~~~ The openKey value of the component ~~~ |
+| ~~~activeKey~~~ | `string` | Deprecated. ~~~ The activeKey value of the component Use the level-2 menu ~~~ |
+| menuToggleFn | `Function` | The parameter should be item, indicating that the menu is expanded. The optional parameter event, original event, is used. |
+| itemClickFn | `Function` | The parameter must be an item of a menu that can be clicked, indicating that the menu is clicked. The optional parameter event, original event, is used. |
diff --git a/packages/devui-vue/docs/en-US/components/alert/alert.md b/packages/devui-vue/docs/en-US/components/alert/alert.md
new file mode 100644
index 00000000..a3af2132
--- /dev/null
+++ b/packages/devui-vue/docs/en-US/components/alert/alert.md
@@ -0,0 +1,38 @@
+# How to use
+
+Import into module:
+
+```ts
+import { AlertModule } from 'ng-devui/alert';
+```
+
+In the page:
+
+```xml
+
+```
+# d-alert
+## d-alert Parameter
+
+| Attributes | Type | Default | Description | Jump to Demo |Global Config|
+| :----------------: | :---------: | :--------------------------------------: | :----: | :---------------------------------------- | ------------------------------------------ |
+| type | [`AlertType`](#alerttype) | 'info' | Required. Specify the style of the warning prompt | [Basic Usage](demo#basic-usage) |
+| cssClass | `string` | -- | Optional. Customize className |
+| closeable | `boolean` | true | Optional. The close button is displayed by default | [Basic Usage](demo#tips-to-close) |
+| dismissTime | `number` | -- | Optional. Toggle off the delay time of Alert(`ms`) |
+| showIcon | `boolean` | true | Optional. Whether to use the default type icon | [Without Icon](demo#without-icon) |
+
+## d-alert Event
+
+| Attributes | Type | Description | Jump to Demo |
+| :--------: | :-----------------: | :------------------------- | -------------------------------------------- |
+| closeEvent | `EventEmitter` | Optional. Callback when alert is closed | [Closable Prompt](demo#tips-to-close) |
+
+# Interface & Type Definition
+### AlertType
+
+The default value is 'info', which specifies the type of alert warning.
+
+```ts
+export type AlertType = 'success' | 'danger' | 'warning' | 'info' | 'simple';
+```
diff --git a/packages/devui-vue/docs/en-US/components/anchor/anchor.md b/packages/devui-vue/docs/en-US/components/anchor/anchor.md
new file mode 100644
index 00000000..fd1bd914
--- /dev/null
+++ b/packages/devui-vue/docs/en-US/components/anchor/anchor.md
@@ -0,0 +1,126 @@
+# How to use
+
+Import into module:
+
+```ts
+import { AnchorModule } from 'ng-devui';
+```
+
+In the page:
+
+```html
+
+
+ anchorlink-one
+ anchorlink-two
+ anchorlink-three
+ anchorlink-four
+
+
+
+ anchorlink-one
+
+
+ anchorlink-two
+
+
+ anchorlink-three
+
+
+ anchorlink-four
+
+
+
+```
+
+```ts
+// using router (cross-route), anchorName means your own anchor
+this.router.navigateByUrl('../xx/xxx#anchorName');
+this.router.navigate(['/xxx'], { fragment: 'anchorName' });
+
+// using router (at the same level), anchorName means your own anchor
+this.router.navigateByUrl('#anchorName');
+this.router.navigate([], { fragment: 'anchorName' });
+```
+
+# dAnchor
+
+Define an anchor point
+
+## dAnchor Parameters
+
+| Parameter | Type | Default | Description | Jump to Demo |Global Config|
+| :----------------: | :----------: | :------: | :-----: | :---------------------------------------------------------------------------------------------------: | -------------------------------------------------- |
+| dAnchor | `string` | -- | Required. Sets an anchor name. | [Basic Usage](demo#basic-usage) |
+| anchorActive | `string` | -- | Optional. When the anchor is activated, the corresponding CSS class name takes effect for the module. | [Basic Usage](demo#basic-usage) |
+
+## dAnchor Anchor Activation Event
+
+The following classes are automatically added to the anchor to correspond to different activated objects:
+
+| css class name | Meaning |
+| :---------------------------: | :-------------------------------------------------------: |
+| anchor-active-by-anchor-link | Click the anchor link to activate it. |
+| anchor-active-by-scroll | The container scrolls to the anchor point for activation. |
+| anchor-active-by-click-inside | Click the anchor content to activate it. |
+| anchor-active-by-initial | Initialize the scroll bar position. |
+
+# dAnchorLink
+
+Define a link of an anchor point. Click the link to slide to the anchor point. When the anchor point is at the top of the page, the link class is activated.
+
+## dAnchorLink Parameters
+
+| Parameter | Type | Default | Description | Jump to Demo |
+| :----------: | :------: | :-----: | :------------------------------------------------------------------------------------------------: | -------------------------------------------------- |
+| dAnchorLink | `string` | -- | Required. Name of the target anchor point for sliding. | [Basic Usage](demo#basic-usage) |
+| anchorActive | `string` | -- | Optional. CSS class name corresponding to the link that takes effect when the anchor is activated. | [Basic Usage](demo#basic-usage) |
+
+# dAnchorBox
+
+There must be one container. Otherwise, the function cannot be used.
+
+Defines a container for scanning anchor points, placed on the common parent node of dAnchor and dAnchorLink, for communication between anchor points and links.
+
+## dAnchorBox Parameters
+
+| Parameter | Type | Default | Description | Jump to Demo |
+| :-----------: | :----------------------------: | :-------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | --------------------------------------------------------------------- |
+| view | `{top?:number,bottom?:number}` | {top:0,bottom:0} | Optional. It is used to adjust the visible region, for example, the head with a fixed position on the top. The value corresponds to the height of the blocked top or bottom. | [Basic Usage](demo#basic-usage) |
+| defaultAnchor | `string` | -- | Optional. An anchor link that is activated by default after a page is displayed. Generally, the first anchor link is set to the first anchor link. If this parameter is not set, the first anchor link can be activated only when the first anchor is moved to the top position. | [Basic Usage](demo#basic-usage) |
+| scrollTarget | `HTMLElement` | document.documentElement(document.body) | Optional. Sets the container where the scroll bar is located. This parameter is optional when the scroll bar is on the home page. | [Replace Rolling Container](demo#scroll-target) |
+
+# dAnchorHashSupport
+
+dAnchorBox support instruction
+
+## dAnchorHashSupport Parameters
+
+The following parameters are advanced configuration parameters and are not required. You only need to use dAnchorHashSupport.
+
+| Parameter | Type | Default | Description | Jump to Demo |
+| :--------------------------: | :-------: | :-----: | :-----------------------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------ |
+| updateUrlWhenAnchorActive | `boolean` | true | Optional. The URL is updated when the anchor is activated. The default value is true. | [URL Hash Anchor](demo#support-hash) |
+| scrollToAnchorByHashOnlyInit | `boolean` | false | Optional. True indicates that the fragment field changes from routes are received only during initialization. This field is used for complex scenarios. | [URL Hash Anchor](demo#support-hash) |
+
+The dAnchorHashSupport command is used together with the dAnchorBox command to bind the hash fragment of a route. For example, xxx.xxx/xxx#foo, where the foo field is a hash field.
+The hop hash field can be the anchor component, route navigate, and routerLink fragment field.
+
+# Note
+
+Note that this parameter cannot be used together with the RouterScoller of the routing module of ng6.1 or later. The routerlScroller will scroll to the traditional ID anchor point.
+Using RouterScroller alone, you can configure the routing module.
+
+```ts
+@NgModule({
+ //......
+ imports: [
+ //......
+ RouterModule.forRoot(routes, {
+ anchorScrolling: 'enabled', // This policy conflicts with the dAnchorHashSupport instruction of the anchor component.
+ }),
+ ],
+ //......
+})
+export class DemoModule {}
+```
diff --git a/packages/devui-vue/docs/en-US/components/avatar/avatar.md b/packages/devui-vue/docs/en-US/components/avatar/avatar.md
new file mode 100644
index 00000000..f057f819
--- /dev/null
+++ b/packages/devui-vue/docs/en-US/components/avatar/avatar.md
@@ -0,0 +1,42 @@
+# How to use
+
+Import into module:
+
+```ts
+import { AvatarModule } from 'ng-devui/avatar';
+```
+
+In the page:
+
+```xml
+
+```
+# d-avatar
+## d-avatar Parameter
+
+| Parameter | Type | Default | Description | Jump to Demo |Global Config|
+| :----------------: | :--------: | :--------------------: | :--: | :-------------------------------------------------------------------------- | ------------------------------------------------------------- |
+| name | `string` | -- | Required. The input character string is used to create a profile picture. | [Basic Rules](demo#basic-rules) |
+| gender | `string \| male \| female` | -- | Optional. The profile picture color is differentiated by gender. The input string can be in the format of `female \| male`. | [Basic Rules](demo#basic-rules) |
+| width | `number` | 40 | Optional. Width of the avatar(`px`) | [Basic Configuration](demo#basic-configuration) |
+| height | `number` | 40 | Optional. Set the height of the avatar(`px`) | [Basic Configuration](demo#basic-configuration) |
+| isRound | `boolean` | true | Optional. Indicating whether to display a circular avatar | [Basic Configuration](demo#basic-configuration) |
+| imgSrc | `string` | -- | Optional. Import a customized image as the avatar | [Basic Configuration](demo#basic-configuration) |
+| customText | `string` | -- | Optional. Input the customized display text | [Basic Configuration](demo#basic-configuration) |
+
+
+### Basic Profile Picture Display Rules
+
+- `Begin with Chinese `: Use the last two characters.
+- `Begin with English `: Use the first two characters.
+- `Use multiple English names together`: Use the first two letters of the first English name.
+- `Not starting with Chinese or English `: Use the first two characters.
+
+### Special avatar display rules
+
+- If `name`, `customText`, and `imgSrc` are not transferred, the user who uses the avatar does not exist.
+- If the values of `name`, `customText`, and `imgSrc` are empty, the user who uses the avatar does not have a nickname and the default avatar is used.
+
+### Display Priority
+
+imgSrc > customText > name
diff --git a/packages/devui-vue/docs/en-US/components/button/button.md b/packages/devui-vue/docs/en-US/components/button/button.md
new file mode 100644
index 00000000..b626daa9
--- /dev/null
+++ b/packages/devui-vue/docs/en-US/components/button/button.md
@@ -0,0 +1,82 @@
+# How to use
+
+Import into module:
+
+```ts
+import { ButtonModule } from 'ng-devui/button';
+```
+
+In the page:
+
+```xml
+
+```
+# d-button
+## d-button Parameter
+
+| Parameter | Type | Default | Description | Jump to Demo |Global Config|
+| :----------------: | :---------: | :------------: | :-----: | :--------------------------------------------------------------------------- | |
+| id | `string` | -- | Optional. ID of the button. | [Primary Buttons](demo#button-primary)|
+| type | [`IButtonType`](#ibuttontype) | 'button' | Optional. The type is `'button' \| 'submit' \| 'reset'` |[Danger Buttons](demo#button-danger) |
+| bsStyle | [`IButtonStyle`](#ibuttonstyle) | 'primary' | Optional. The style is `'primary' \| 'common' \| 'text' \| 'text-dark' \| 'danger'` | [Common Buttons](demo#button-common) |
+| bsSize | [`IButtonSize`](#ibuttonsize) | 'md' | Optional. The size is `'lg' \| 'md' \| 'sm' \| 'xs'` | [Button Size](demo#button-size) |
+| bsPosition |[`IButtonPosition`](#ibuttonposition) |'default'| Optional. The button position is `'default' \| 'left' \| 'right'` | [Left & Right Buttons](demo#button-left-right) |
+| bordered | `boolean` | false | Optional. Indicating whether a border exists | [Auto-focus Buttons](demo#button-auto-focus)|
+| icon | `string` | -- | Optional. Customized button icon | [Icon Buttons](demo#button-icon) |
+| showLoading | `boolean` | false | Optional. Indicating whether to display the loading prompt | [Loading Buttons](demo#button-loading) |
+| width | `string` | -- | Optional. Button width |[Combinations of Primary & Common Buttons](demo#button-primary-and-common) |
+| disabled | `boolean` | false | Optional. Indicating whether to disable the button | [Primary Buttons](demo#button-primary) |
+| autofocus | `boolean` | false | Optional. Indicating whether to automatically obtain the focus during button loading | [Auto-focus Buttons](demo#button-auto-focus) |
+
+## d-button Event
+
+| Parameter | Type | Description | Jump to Demo |
+| :------: | :-----------------: | :-------------------------------------------------------------------------------------- | ---------------------------------------------- |
+| btnClick | `EventEmitter` | Optional. Solve the click event is triggered when button is disabled. After the mouse is clicked, the mouse event object is returned | [Loading Buttons](demo#button-loading)|
+
+# d-button-group
+
+## d-button-group parameter
+
+| Parameter | Type | Default | Description | Jump to Demo |Global Config|
+| :----------------: | :---------: | :------------: | :-----: | :--------------------------------------------------------------------------- | |
+| size | [`IButtonGroupSize`](#ibuttongroupsize) | 'md' | Optional. The size is `'lg' \| 'md' \| 'sm' \| 'xs'` | [Button Group](demo#button-groups) |
+
+# Interface & Type Definition
+### IButtonType
+
+The default value is 'button', indicating the button type.
+
+```ts
+export type IButtonType = 'button' | 'submit' | 'reset';
+```
+
+### IButtonStyle
+
+The default value is 'primary', indicating the button style.
+
+```ts
+export type IButtonStyle = 'common' | 'primary' | 'text' | 'text-dark' | 'danger';
+```
+
+### IButtonPosition
+
+The default value is 'default', indicating the button position.
+
+```ts
+export type IButtonPosition = 'left' | 'right' | 'default';
+```
+
+### IButtonSize
+The default value is 'md', indicating the button size.
+
+```ts
+export type IButtonSize = 'lg' | 'md' | 'sm' | 'xs';
+```
+
+### IButtonGroupSize
+The default value is 'md', indicating the button-group size.
+
+```ts
+export type IButtonGroupSize = 'lg' | 'md' | 'sm' | 'xs';
+```
--
Gitee
From 418e9e73121aaabe1001cbffd623445533a8c429 Mon Sep 17 00:00:00 2001
From: xiaojiujiu <3507440900@qq.com>
Date: Mon, 8 Nov 2021 23:59:50 +0800
Subject: [PATCH 3/8] fixed #I4H6K3
---
.../docs/.vitepress/config/enSidebar.ts | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/packages/devui-vue/docs/.vitepress/config/enSidebar.ts b/packages/devui-vue/docs/.vitepress/config/enSidebar.ts
index 00c33617..4f814fef 100644
--- a/packages/devui-vue/docs/.vitepress/config/enSidebar.ts
+++ b/packages/devui-vue/docs/.vitepress/config/enSidebar.ts
@@ -33,15 +33,15 @@ const enSidebar = {
{
text: 'Feedback',
children: [
- { text: 'Alert', link: '/components/alert/', status: 'completed' },
- { text: 'Drawer', link: '/components/drawer/' },
- { text: 'Loading', link: '/components/loading/', status: 'completed' },
- { text: 'Mention', link: '/components/mention/' },
- { text: 'Modal', link: '/components/modal/' },
- { text: 'Popover', link: '/components/popover/', status: "progress" },
- { text: 'ReadTip', link: '/components/read-tip/' },
- { text: 'Toast', link: '/components/toast/', status: 'completed' },
- { text: 'Tooltip', link: '/components/tooltip/', status: 'completed' },
+ { text: 'Alert', link: '/en-US/components/alert/', status: 'completed' },
+ { text: 'Drawer', link: '/en-US/components/drawer/' },
+ { text: 'Loading', link: '/en-US/components/loading/', status: 'completed' },
+ { text: 'Mention', link: '/en-US/components/mention/' },
+ { text: 'Modal', link: '/en-US/components/modal/' },
+ { text: 'Popover', link: '/en-US/components/popover/', status: "progress" },
+ { text: 'ReadTip', link: '/en-US/components/read-tip/' },
+ { text: 'Toast', link: '/en-US/components/toast/', status: 'completed' },
+ { text: 'Tooltip', link: '/en-US/components/tooltip/', status: 'completed' },
]
},
{
--
Gitee
From 66eaa765aea73d30caa96cc175cbe8844c6238cb Mon Sep 17 00:00:00 2001
From: xiaojiujiu <3507440900@qq.com>
Date: Tue, 9 Nov 2021 21:40:42 +0800
Subject: [PATCH 4/8] =?UTF-8?q?docs:=20=E5=88=A0=E9=99=A4=E5=A4=9A?=
=?UTF-8?q?=E4=BD=99=E5=9B=BD=E9=99=85=E5=8C=96=E6=96=87=E4=BB=B6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../en-US/components/accordion/accordion.md | 189 ---
.../docs/en-US/components/accordion/index.md | 4 -
.../docs/en-US/components/alert/alert.md | 38 -
.../docs/en-US/components/alert/index.md | 23 -
.../docs/en-US/components/anchor/anchor.md | 126 --
.../docs/en-US/components/anchor/demo.tsx | 35 -
.../docs/en-US/components/anchor/index.md | 80 -
.../docs/en-US/components/avatar/avatar.md | 42 -
.../docs/en-US/components/avatar/index.md | 23 -
.../docs/en-US/components/badge/index.md | 178 ---
.../docs/en-US/components/button/button.md | 82 --
.../docs/en-US/components/button/index.md | 27 -
.../docs/en-US/components/card/index.md | 220 ---
.../docs/en-US/components/carousel/index.md | 162 --
.../docs/en-US/components/checkbox/index.md | 42 -
.../en-US/components/date-picker/index.md | 121 --
.../docs/en-US/components/icon/index.md | 71 -
.../en-US/components/image-preview/index.md | 137 --
.../docs/en-US/components/input/index.md | 96 --
.../docs/en-US/components/loading/index.md | 298 ----
.../docs/en-US/components/overlay/index.md | 198 ---
.../docs/en-US/components/pagination/index.md | 473 ------
.../docs/en-US/components/panel/index.md | 74 -
.../docs/en-US/components/popover/index.md | 386 -----
.../docs/en-US/components/progress/index.md | 142 --
.../components/quadrant-diagram/index.md | 44 -
.../docs/en-US/components/radio/index.md | 307 ----
.../docs/en-US/components/rate/index.md | 138 --
.../docs/en-US/components/search/index.md | 95 --
.../docs/en-US/components/select/index.md | 175 ---
.../docs/en-US/components/slider/index.md | 128 --
.../docs/en-US/components/status/index.md | 26 -
.../docs/en-US/components/sticky/index.md | 139 --
.../docs/en-US/components/switch/index.md | 66 -
.../docs/en-US/components/tabs/index.md | 7 -
.../docs/en-US/components/tag-input/index.md | 44 -
.../docs/en-US/components/toast/index.md | 611 --------
.../docs/en-US/components/transfer/index.md | 224 ---
.../docs/en-US/components/upload/index.md | 1297 -----------------
packages/devui-vue/docs/en-US/design.md | 1 -
packages/devui-vue/docs/en-US/theme.md | 1 -
packages/devui-vue/docs/en-US/version.md | 1 -
42 files changed, 6571 deletions(-)
delete mode 100644 packages/devui-vue/docs/en-US/components/accordion/accordion.md
delete mode 100644 packages/devui-vue/docs/en-US/components/accordion/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/alert/alert.md
delete mode 100644 packages/devui-vue/docs/en-US/components/alert/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/anchor/anchor.md
delete mode 100644 packages/devui-vue/docs/en-US/components/anchor/demo.tsx
delete mode 100644 packages/devui-vue/docs/en-US/components/anchor/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/avatar/avatar.md
delete mode 100644 packages/devui-vue/docs/en-US/components/avatar/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/badge/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/button/button.md
delete mode 100644 packages/devui-vue/docs/en-US/components/button/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/card/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/carousel/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/checkbox/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/date-picker/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/icon/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/image-preview/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/input/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/loading/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/overlay/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/pagination/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/panel/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/popover/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/progress/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/quadrant-diagram/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/radio/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/rate/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/search/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/select/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/slider/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/status/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/sticky/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/switch/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/tabs/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/tag-input/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/toast/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/transfer/index.md
delete mode 100644 packages/devui-vue/docs/en-US/components/upload/index.md
delete mode 100644 packages/devui-vue/docs/en-US/design.md
delete mode 100644 packages/devui-vue/docs/en-US/theme.md
delete mode 100644 packages/devui-vue/docs/en-US/version.md
diff --git a/packages/devui-vue/docs/en-US/components/accordion/accordion.md b/packages/devui-vue/docs/en-US/components/accordion/accordion.md
deleted file mode 100644
index dba8ce67..00000000
--- a/packages/devui-vue/docs/en-US/components/accordion/accordion.md
+++ /dev/null
@@ -1,189 +0,0 @@
-# How to use
-
-Import into module:
-
-```typescript
-import { AccordionModule } from ' ng-devui/accordion';
-```
-
-On the page:
-
-```html
-
-```
-
-## Accordion
-
-### d-accordion parameter
-
-| Parameter | Type | Default | Description | Jump to Demo |Global Config|
-| :----------------: | :----------------: | :----------------------------------------------------: | :--------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -------------------------------------------------------------------------- |
-| data | `Array \| AccordionMenuType` | -- | Required. Data source. You can customize an array or use the preset `AccordionMenuType` | [Basic usage](demo#basic-usage) |
-| titleKey | `string` | 'title' | Optional. Title attribute name. The type of item[titleKey] is `string`, indicating the title content. | [Change key value](demo#change-values) |
-| loadingKey | `string` | 'loading' | Optional. attribute name for determining whether a submenu is loaded. The type of item[loadingKey] is `boolean` | [Change key value](demo#change-values) |
-| childrenKey | `string` | 'children' | Optional. Submenu attribute name. The type of item[childrenKey] is `Array` | [Change key value](demo#change-values) |
-| disabledKey | `string` | 'disabled' | Optional. indicating whether to disable the attribute. The type of item[disabledKey] is `boolean` | [Change key value](demo#change-values) |
-| activeKey | `string` | 'active' | Optional. indicating whether a submenu is activated. The type of item[activeKey] is `boolean` | [Change key value](demo#change-values) |
-| openKey | `string` | 'open' | Optional. indicating whether a menu is expanded. The type of item[openKey] is `boolean` | [Change key value](demo#change-values) |
-| restrictOneOpen | `boolean` | false | Optional. Only one level-1 menu can be opened at a time. By default, there is no restriction. | [Basic usage](demo#basic-usage) |
-| menuItemTemplate | `TemplateRef` | Built-in | Optional. It can expand the menu content bar template. The available variable values are as follows. | [Using a Template](demo#using-templates) |
-| itemTemplate | `TemplateRef` | Built-in | Optional. The menu content bar template can be clicked. The available variable values are as follows: | [Using a Template](demo#using-templates) |
-| noContentTemplate | `TemplateRef` | Built-in | Optional. If there is no content, use a customized template. The available variable values are as follows: | [Using a Template](demo#using-templates) |
-| loadingTemplate | `TemplateRef` | Built-in | Optional. A customized template is used for loading. The available variable values are as follows | [Using a Template](demo#using-templates) |
-| innerListTemplate | `TemplateRef` | Built-in | Optional. The sublist content is customized and used as a folding panel. The available variable values are as follows. | [Using a Template](demo#using-templates) |
-| linkType | `'routerLink'\|'hrefLink'\|'dependOnLinkTypeKey'\|'''` | '' | Optional. `routerLink'` indicates the routing scenario. `hrefLink'` indicates the external link scenario. `dependOnLinkTypeKey'` indicates the dynamic routing or external link scenario. `''` is the default non-link type (you cannot right-click to open a new tab page) | [Built-in route and link type](demo#use-built-in-routing-and-link-types) |
-| linkTypeKey | `string` | 'linkType' | Optional. Key value of the link type, which is used to specify the object link type attribute name when linkType is set to `'dependOnLinkTypeKey'`. The value of item[linkTypeKey] is `'routerLink'\|'hrefLink'\| string`, in the preceding information, `routerLink'` indicates a route link, `hrefLink'` indicates an external link, and other values are default non-link types. |
-| linkKey | `string` | 'link' | Optional. Key of the link content, which is used to set the value of the link value when linkType is not set to ````. item[linkKey] indicates the route address or hyperlink address. |
-| linkTargetKey | `string` | 'target' | Optional. Key of the target window to be linked, which is used for the link type. item[linkTargetKey] indicates the target window of a single link. |
-| linkDefaultTarget | `string` | '\_self' | Optional. If target is not set, the default value of target is `'\_self'`, which is used for the link type and its value is the same as that of target attribute of link a. | [Built-in route and link type](demo#use-built-in-routing-and-link-types) |
-| autoOpenActiveMenu | `boolean` | false | Optional. Whether to automatically expand menus with active subitems | [Composite Hierarchy and Auto Expand](demo#compound-level-and-auto-expand) |
-| accordionType | `normal ' \| 'embed'` | 'normal' | Optional. The menu format is common (with shadow) or embedded (without shadow). | [Basic usage](demo#basic-usage) |
-| showAnimation | `boolean` | true | Optional. Indicating whether to display animations. | [Built-in route and link type](demo#use-built-in-routing-and-link-types) | ✔ |
-
-### d-accordion event
-
-| Event | Type | Description | Jump to Demo |
-| :--------------: | :-----------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------- |
-| menuToggle | `EventEmitter<`[`AccordionMenuToggleEvent`](#accordionmenutoggleevent)`>` | Optional. The menu can be expanded. In the returned object, the attribute item is the object data clicked. If open is true, the object will be expanded. If open is false, the object will be closed. If parent is the parent object data. Event is the native event of the click event. | [Basic usage](demo#basic-usage) |
-| itemClick | `EventEmitter<`[`AccordionItemClickEvent`](#accordionitemclickevent)`>` | Optional. It can click a menu event. In the returned object, the attribute item is the object data of the clicked object, the preActive object is the object expanded last time, the parent object is the data of the parent object, and the event is the native event of the click event. | [Basic usage](demo#basic-usage) |
-| activeItemChange | `EventEmitter` | Optional. Data of the newly activated sub-item is sent when the sub-item is switched. | [Basic usage](demo#basic-usage) |
-
-### AccordionMenuType Definition
-
-```typescript
-/* Basic data type */
-type AccordionMenuItemLinkType = 'routerLink' | 'hrefLink' | string;
-export interface AccordionBase {
- title: string;
- disabled?: boolean;
- [prop: string]: any;
-}
-interface IAccordionActiveable {
- active?: boolean;
-}
-interface IAccordionFoldable {
- open?: boolean;
- loading?: boolean;
- children?: Array;
-}
-interface IAccordionLinkable {
- link?: string;
- target?: boolean;
- linkType?: AccordionMenuItemLinkType;
-}
-export interface AccordionBaseItem extends AccordionBase, IAccordionActiveable {}
-export interface AccordionBaseMenu extends AccordionBase, IAccordionFoldable {}
-export interface AccordionLinkableItem extends AccordionBase, IAccordionActiveable, IAccordionLinkable {}
-export interface AccordionMenuItem extends AccordionBase, IAccordionActiveable, IAccordionFoldable, IAccordionLinkable {}
-export type AccordionMenuType = Array;
-
-/* Common configuration data type */
-interface AccordionMenuKeyGroup {
- titleKey?: string;
- activeKey?: string;
- disabledKey?: string;
- openKey?: string;
- loadingKey?: string;
- childrenKey?: string;
- linkKey?: string;
- linkTargetKey?: string;
- linkTypeKey?: string;
-}
-type AccordionTemplateRefArray = 'itemTemplate' | 'menuItemTemplate' | 'noContentTemplate' | 'loadingTemplate' | 'innerListTemplate';
-type AccordionTemplateRefGroup = {
- [p in AccordionTemplateRefArray]: TemplateRef;
-};
-interface AccordionConfigOptions {
- restrictOneOpen?: boolean;
- autoOpenActiveMenu?: boolean;
- showNoContent?: boolean;
- linkDefaultTarget?: string;
- i18nText: any;
- linkType: 'routerLink' | 'hrefLink' | 'dependOnLinkTypeKey' | '';
-}
-export interface AccordionOptions extends AccordionConfigOptions, AccordionMenuKeyGroup, AccordionTemplateRefGroup {}
-```
-
-## AccordionMenuToggleEvent
-
-```typescript
-export type AccordionMenuToggleEvent = {
- item: any;
- open: boolean;
- parent: any;
- event: MouseEvent;
-};
-```
-
-## AccordionItemClickEvent
-
-```typescript
-export type AccordionItemClickEvent = {
- item: any;
- prevActiveItem?: any;
- parent: any;
- event: MouseEvent;
-};
-```
-
-### Templates can use variable values.
-
-#### Variable Usage
-
-```html
-{{myitem}}
-```
-
-#### menuItemTemplate Available variable values
-
-| Variable | Type | Variable Description |
-| :----------------: | :--------: | :------------------------------------------------------------------------------------------: |
-| item | `any` | Expandable menu data |
-| deepth | `number` | Indicates the nested structure level. |
-| parent | `any` | Parent menu data |
-| ~~~titleKey~~~ | `string` | Deprecated.~~~ The titleKey value of the component. ~~~ |
-| ~~~disabledKey~~~ | `string` | Deprecated. ~~~ The value of the disabledKey of the component. ~~~ |
-| ~~~openKey~~~ | `string` | Deprecated. ~~~ The openKey value of the component. ~~~ |
-| ~~~menuToggleFn~~~ | `Function` | Deprecated.~~~ The parameter should be item, indicating that the level-1 menu is clicked.~~~ |
-
-#### itemTemplate Available variable values
-
-| Variable | Type | Variable Description |
-| :---------------: | :--------: | :------------------------------------------------------------------------------------------: |
-| item | `any` | Clickable menu data |
-| deepth | `number` | The value indicates the nested structure level. |
-| parent | `any` | Parent menu data |
-| ~~~titleKey~~~ | `string` | Deprecated.~~~ The titleKey value of the component ~~~ |
-| ~~~disabledKey~~~ | `string` | Deprecated.~~~ The value of the disabledKey of the component ~~~ |
-| ~~~activeKey~~~ | `string` | Deprecated.~~~ The activeKey value of the component ~~~ |
-| ~~~itemClickFn~~~ | `Function` | Deprecated. ~~~The parameter should be item, indicating that the level-2 menu is clicked.~~~ |
-
-#### noContentTemplate Available variable value
-
-| Variable | Type | Variable Description |
-| :------: | :------: | :---------------------------------------------: |
-| item | `any` | Parent menu single data |
-| deepth | `number` | The value indicates the nested structure level. |
-
-#### loadingTemplate Available variable values
-
-| Variable | Type | Variable Description |
-| :---------------------: | :--------------: | :---------------------------------------------: |
-| item | `any` | Parent menu single data |
-| deepth | `number` | The value indicates the nested structure level. |
-| LoadingKey value of the | ~~~loadingKey~~~ | `string` | ~~~ component ~~~ |
-
-#### InnerListTemplate Available Variable Values
-
-| Variable | Type | Variable Description |
-| :---------------: | :--------: | :------------------------------------------------------------------------------------------------------------------------------------------------------: |
-| item | `any` | Parent menu single data |
-| deepth | `number` | The value indicates the nested structure level. |
-| ~~~titleKey~~~ | `string` | Deprecated.~~~The titleKey value of the component ~~~ |
-| ~~~loadingKey~~~ | `string` | Deprecated.~~~ The loading key value of the component ~~~ |
-| ~~~childrenKey~~~ | `string` | Deprecated.~~~ The value of childrenKey of the component ~~~ |
-| ~~~disabledKey~~~ | `string` | Deprecated.~~~ The value of the disabledKey of the component ~~~ |
-| ~~~openKey~~~ | `string` | Deprecated.~~~ The openKey value of the component ~~~ |
-| ~~~activeKey~~~ | `string` | Deprecated. ~~~ The activeKey value of the component Use the level-2 menu ~~~ |
-| menuToggleFn | `Function` | The parameter should be item, indicating that the menu is expanded. The optional parameter event, original event, is used. |
-| itemClickFn | `Function` | The parameter must be an item of a menu that can be clicked, indicating that the menu is clicked. The optional parameter event, original event, is used. |
diff --git a/packages/devui-vue/docs/en-US/components/accordion/index.md b/packages/devui-vue/docs/en-US/components/accordion/index.md
deleted file mode 100644
index 5b42b165..00000000
--- a/packages/devui-vue/docs/en-US/components/accordion/index.md
+++ /dev/null
@@ -1,4 +0,0 @@
-# Accordion
-A component that provides navigation for a page.
-### When to use
-Use when you need to organize the menu in groups.
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/alert/alert.md b/packages/devui-vue/docs/en-US/components/alert/alert.md
deleted file mode 100644
index a3af2132..00000000
--- a/packages/devui-vue/docs/en-US/components/alert/alert.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# How to use
-
-Import into module:
-
-```ts
-import { AlertModule } from 'ng-devui/alert';
-```
-
-In the page:
-
-```xml
-
-```
-# d-alert
-## d-alert Parameter
-
-| Attributes | Type | Default | Description | Jump to Demo |Global Config|
-| :----------------: | :---------: | :--------------------------------------: | :----: | :---------------------------------------- | ------------------------------------------ |
-| type | [`AlertType`](#alerttype) | 'info' | Required. Specify the style of the warning prompt | [Basic Usage](demo#basic-usage) |
-| cssClass | `string` | -- | Optional. Customize className |
-| closeable | `boolean` | true | Optional. The close button is displayed by default | [Basic Usage](demo#tips-to-close) |
-| dismissTime | `number` | -- | Optional. Toggle off the delay time of Alert(`ms`) |
-| showIcon | `boolean` | true | Optional. Whether to use the default type icon | [Without Icon](demo#without-icon) |
-
-## d-alert Event
-
-| Attributes | Type | Description | Jump to Demo |
-| :--------: | :-----------------: | :------------------------- | -------------------------------------------- |
-| closeEvent | `EventEmitter` | Optional. Callback when alert is closed | [Closable Prompt](demo#tips-to-close) |
-
-# Interface & Type Definition
-### AlertType
-
-The default value is 'info', which specifies the type of alert warning.
-
-```ts
-export type AlertType = 'success' | 'danger' | 'warning' | 'info' | 'simple';
-```
diff --git a/packages/devui-vue/docs/en-US/components/alert/index.md b/packages/devui-vue/docs/en-US/components/alert/index.md
deleted file mode 100644
index 089868ec..00000000
--- a/packages/devui-vue/docs/en-US/components/alert/index.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# Alert
-
-A component that displays warning information, information that needs the user's attention。
-
-### When to use
-
-When the page needs to send a warning message to the user。
-
-### 基本用法
-
- success
- danger
- warning
- info
- simple
-
-```html
- success
- danger
- warning
- info
- simple
-```
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/anchor/anchor.md b/packages/devui-vue/docs/en-US/components/anchor/anchor.md
deleted file mode 100644
index fd1bd914..00000000
--- a/packages/devui-vue/docs/en-US/components/anchor/anchor.md
+++ /dev/null
@@ -1,126 +0,0 @@
-# How to use
-
-Import into module:
-
-```ts
-import { AnchorModule } from 'ng-devui';
-```
-
-In the page:
-
-```html
-
-
- anchorlink-one
- anchorlink-two
- anchorlink-three
- anchorlink-four
-
-
-
- anchorlink-one
-
-
- anchorlink-two
-
-
- anchorlink-three
-
-
- anchorlink-four
-
-
-
-```
-
-```ts
-// using router (cross-route), anchorName means your own anchor
-this.router.navigateByUrl('../xx/xxx#anchorName');
-this.router.navigate(['/xxx'], { fragment: 'anchorName' });
-
-// using router (at the same level), anchorName means your own anchor
-this.router.navigateByUrl('#anchorName');
-this.router.navigate([], { fragment: 'anchorName' });
-```
-
-# dAnchor
-
-Define an anchor point
-
-## dAnchor Parameters
-
-| Parameter | Type | Default | Description | Jump to Demo |Global Config|
-| :----------------: | :----------: | :------: | :-----: | :---------------------------------------------------------------------------------------------------: | -------------------------------------------------- |
-| dAnchor | `string` | -- | Required. Sets an anchor name. | [Basic Usage](demo#basic-usage) |
-| anchorActive | `string` | -- | Optional. When the anchor is activated, the corresponding CSS class name takes effect for the module. | [Basic Usage](demo#basic-usage) |
-
-## dAnchor Anchor Activation Event
-
-The following classes are automatically added to the anchor to correspond to different activated objects:
-
-| css class name | Meaning |
-| :---------------------------: | :-------------------------------------------------------: |
-| anchor-active-by-anchor-link | Click the anchor link to activate it. |
-| anchor-active-by-scroll | The container scrolls to the anchor point for activation. |
-| anchor-active-by-click-inside | Click the anchor content to activate it. |
-| anchor-active-by-initial | Initialize the scroll bar position. |
-
-# dAnchorLink
-
-Define a link of an anchor point. Click the link to slide to the anchor point. When the anchor point is at the top of the page, the link class is activated.
-
-## dAnchorLink Parameters
-
-| Parameter | Type | Default | Description | Jump to Demo |
-| :----------: | :------: | :-----: | :------------------------------------------------------------------------------------------------: | -------------------------------------------------- |
-| dAnchorLink | `string` | -- | Required. Name of the target anchor point for sliding. | [Basic Usage](demo#basic-usage) |
-| anchorActive | `string` | -- | Optional. CSS class name corresponding to the link that takes effect when the anchor is activated. | [Basic Usage](demo#basic-usage) |
-
-# dAnchorBox
-
-There must be one container. Otherwise, the function cannot be used.
-
-Defines a container for scanning anchor points, placed on the common parent node of dAnchor and dAnchorLink, for communication between anchor points and links.
-
-## dAnchorBox Parameters
-
-| Parameter | Type | Default | Description | Jump to Demo |
-| :-----------: | :----------------------------: | :-------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | --------------------------------------------------------------------- |
-| view | `{top?:number,bottom?:number}` | {top:0,bottom:0} | Optional. It is used to adjust the visible region, for example, the head with a fixed position on the top. The value corresponds to the height of the blocked top or bottom. | [Basic Usage](demo#basic-usage) |
-| defaultAnchor | `string` | -- | Optional. An anchor link that is activated by default after a page is displayed. Generally, the first anchor link is set to the first anchor link. If this parameter is not set, the first anchor link can be activated only when the first anchor is moved to the top position. | [Basic Usage](demo#basic-usage) |
-| scrollTarget | `HTMLElement` | document.documentElement(document.body) | Optional. Sets the container where the scroll bar is located. This parameter is optional when the scroll bar is on the home page. | [Replace Rolling Container](demo#scroll-target) |
-
-# dAnchorHashSupport
-
-dAnchorBox support instruction
-
-## dAnchorHashSupport Parameters
-
-The following parameters are advanced configuration parameters and are not required. You only need to use dAnchorHashSupport.
-
-| Parameter | Type | Default | Description | Jump to Demo |
-| :--------------------------: | :-------: | :-----: | :-----------------------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------ |
-| updateUrlWhenAnchorActive | `boolean` | true | Optional. The URL is updated when the anchor is activated. The default value is true. | [URL Hash Anchor](demo#support-hash) |
-| scrollToAnchorByHashOnlyInit | `boolean` | false | Optional. True indicates that the fragment field changes from routes are received only during initialization. This field is used for complex scenarios. | [URL Hash Anchor](demo#support-hash) |
-
-The dAnchorHashSupport command is used together with the dAnchorBox command to bind the hash fragment of a route. For example, xxx.xxx/xxx#foo, where the foo field is a hash field.
-The hop hash field can be the anchor component, route navigate, and routerLink fragment field.
-
-# Note
-
-Note that this parameter cannot be used together with the RouterScoller of the routing module of ng6.1 or later. The routerlScroller will scroll to the traditional ID anchor point.
-Using RouterScroller alone, you can configure the routing module.
-
-```ts
-@NgModule({
- //......
- imports: [
- //......
- RouterModule.forRoot(routes, {
- anchorScrolling: 'enabled', // This policy conflicts with the dAnchorHashSupport instruction of the anchor component.
- }),
- ],
- //......
-})
-export class DemoModule {}
-```
diff --git a/packages/devui-vue/docs/en-US/components/anchor/demo.tsx b/packages/devui-vue/docs/en-US/components/anchor/demo.tsx
deleted file mode 100644
index d87cc00c..00000000
--- a/packages/devui-vue/docs/en-US/components/anchor/demo.tsx
+++ /dev/null
@@ -1,35 +0,0 @@
-import { defineComponent } from 'vue'
-
-export default defineComponent({
- name: 'DAnchor',
- props: {
- },
- setup() {
- return () => {
- return (
-
-
- anchorlink-one
- anchorlink-two
- anchorlink-three
- anchorlink-four
-
-
-
- anchorlink-one
-
-
- anchorlink-two
-
-
- anchorlink-three
-
-
- anchorlink-four
-
-
-
- )
- }
- }
-})
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/anchor/index.md b/packages/devui-vue/docs/en-US/components/anchor/index.md
deleted file mode 100644
index 08f7664b..00000000
--- a/packages/devui-vue/docs/en-US/components/anchor/index.md
+++ /dev/null
@@ -1,80 +0,0 @@
-# anchor
-
-
-
-# When to use
-
-
-Use in the page:
-
-```html
-
-
-
- anchorlink-one
- anchorlink-two
- anchorlink-three
- anchorlink-four
-
-
-
- anchorlink-one1
-
-
- anchorlink-two
-
-
- anchorlink-three
-
-
- anchorlink-four
-
-
-
-```
-
-# dAnchor
-
-Define an anchor point。
-### dAnchor parameter
-
-| parameter | type | default | illustrate | jump Demo |config|
-| :----------------: | :----------: | :------: | :--: | :---------------------------------------------------: | ---------------------------- |
-| dAnchor | `string` | -- | required, set an anchor name | [basic usage](demo#basic-usage) |
-| anchorActive | `string` | -- | Optional, when the anchor point is activated, the corresponding css class name for the module to take effect | [basic usage](demo#basic-usage) |
-
-### dAnchor activation event
-
-The following classes are automatically added to the anchor points to correspond to different activated objects。
-
-| css classname | Representative meaning |
-| :---------------------------: | :--------------------: |
-| anchor-active-by-anchor-link | Click on the anchor link to activate |
-| anchor-active-by-scroll | The container is scrolled to the anchor point to activate |
-| anchor-active-by-click-inside | Click on the content inside the anchor to activate |
-| anchor-active-by-initial | Initialize scroll bar position activation |
-
-# dAnchorLink
-
-Define a link with an anchor point. Clicking on the link will slide to the anchor point. When the anchor point is at the top of the page, the link class will be activated。
-
-### dAnchorLink parameter
-
-| parameter | type | default | illustrate | jump Demo |config|
-| :----------------: | :----------: | :------: | :--: | :---------------------------------------------------: | ---------------------------- |
-| dAnchorLink | `string` | -- | required, click the name of the target anchor point to slide | [basic usage](demo#basic-usage) |
-| anchorActive | `string` | -- | optional, when the anchor point is active, the css class name corresponding to the effective link | [basic usage](demo#basic-usage) |
-
-# dAnchorBox
-
-There must be a container, otherwise the function cannot be used。
-
-Define a container for scanning anchor points and place it on the common parent node of dAnchor and dAnchorLink for communication between anchor points and links。
diff --git a/packages/devui-vue/docs/en-US/components/avatar/avatar.md b/packages/devui-vue/docs/en-US/components/avatar/avatar.md
deleted file mode 100644
index f057f819..00000000
--- a/packages/devui-vue/docs/en-US/components/avatar/avatar.md
+++ /dev/null
@@ -1,42 +0,0 @@
-# How to use
-
-Import into module:
-
-```ts
-import { AvatarModule } from 'ng-devui/avatar';
-```
-
-In the page:
-
-```xml
-
-```
-# d-avatar
-## d-avatar Parameter
-
-| Parameter | Type | Default | Description | Jump to Demo |Global Config|
-| :----------------: | :--------: | :--------------------: | :--: | :-------------------------------------------------------------------------- | ------------------------------------------------------------- |
-| name | `string` | -- | Required. The input character string is used to create a profile picture. | [Basic Rules](demo#basic-rules) |
-| gender | `string \| male \| female` | -- | Optional. The profile picture color is differentiated by gender. The input string can be in the format of `female \| male`. | [Basic Rules](demo#basic-rules) |
-| width | `number` | 40 | Optional. Width of the avatar(`px`) | [Basic Configuration](demo#basic-configuration) |
-| height | `number` | 40 | Optional. Set the height of the avatar(`px`) | [Basic Configuration](demo#basic-configuration) |
-| isRound | `boolean` | true | Optional. Indicating whether to display a circular avatar | [Basic Configuration](demo#basic-configuration) |
-| imgSrc | `string` | -- | Optional. Import a customized image as the avatar | [Basic Configuration](demo#basic-configuration) |
-| customText | `string` | -- | Optional. Input the customized display text | [Basic Configuration](demo#basic-configuration) |
-
-
-### Basic Profile Picture Display Rules
-
-- `Begin with Chinese `: Use the last two characters.
-- `Begin with English `: Use the first two characters.
-- `Use multiple English names together`: Use the first two letters of the first English name.
-- `Not starting with Chinese or English `: Use the first two characters.
-
-### Special avatar display rules
-
-- If `name`, `customText`, and `imgSrc` are not transferred, the user who uses the avatar does not exist.
-- If the values of `name`, `customText`, and `imgSrc` are empty, the user who uses the avatar does not have a nickname and the default avatar is used.
-
-### Display Priority
-
-imgSrc > customText > name
diff --git a/packages/devui-vue/docs/en-US/components/avatar/index.md b/packages/devui-vue/docs/en-US/components/avatar/index.md
deleted file mode 100644
index 3ca64429..00000000
--- a/packages/devui-vue/docs/en-US/components/avatar/index.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# Avatar
-
-The component that displays the user's avatar。
-
-### When to use
-
-当需要显示用户头像时。
-
-### Basic rules of avatar display
-
-When the 'name' attribute is passed to the avatar component, the avatar field will be displayed according to certain rules. Please refer to the API for specific rules。
-
-
-
-
-
-
-```html
-
-
-
-
-```
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/badge/index.md b/packages/devui-vue/docs/en-US/components/badge/index.md
deleted file mode 100644
index 2eb62674..00000000
--- a/packages/devui-vue/docs/en-US/components/badge/index.md
+++ /dev/null
@@ -1,178 +0,0 @@
-# Badge
-
-The round logo number in the upper right corner of the icon。
-
-### When to use
-
-Appears in the upper right corner of the icon or to the right of the list item, and prompts the user when there is a message to be processed through different status colors and numbers。
-
-### Basic Badge
-
-The basic badge type. When there is a package element, the badge and number will be displayed in the upper right corner。
-
-Unread message
-Unread message
-Unread message
-Unread message
-
-```html
-Unread message
-Unread message
-Unread message
-Unread message
-```
-
-### Dot Badge
-
-Dot badge type. When there is a package element and the showDot parameter is true, it is a dot badge. By default, small dots are displayed in the upper right corner and the number is not displayed。
-
-Unread message
-Unread message
-
-
-
-
-
-
-
-```html
-Unread message
-Unread message
-
-
-
-
-
-
-```
-
-### Count Badge
-
-When the badge is used independently and does not wrap any elements, only the badge status color and number are displayed。
-
-
-
- Unread message
-
-
-
- Personal message
-
-
-
-
-```html
-
-
- System message
-
-
-
- Personal message
-
-
-
-```
-
-### Status Badge
-
-When the badge is used independently, does not wrap any elements, and the showDot parameter is true, it is a state badge, and different states show different color points。
-
-   danger
-   warning
-   waiting
-   info
-   success
-
-```html
-   danger
-   warning
-   waiting
-   info
-   success
-```
-
-### Badge Position
-
-Set the badge position through the badgePos parameter。
-
-Unread message
-Unread message
-
-
-
-
-
-
-```html
-Unread message
-Unread message
-
-
-
-
-
-
-```
-
-### Define
-
-The badge display status color is set through the bgColor parameter (the badge status color set by the status parameter is invalid at this time), and the badge offset relative to the badgePos can be set through the offsetXY parameter. Customize text and background color through textColor and bgColor。
-
-
-
-
-
-
-
-Unread message
-Unread message
-
-
-```html
-
-
-
-
-
-
-Unread message
-Unread message
-
-```
-
-### API
-
-| parameter | type | default | illustrate |
-| :-------: | :-----------------: | :---------: | :--------------------------------------------------------------------------------------------------------------------------- |
-| count | `Number` | -- | Optionally, set the number displayed in the basic badge and count badge |
-| maxCount | `Number` | 99 | Optional, set the maximum number of basic badges and count badges that can be displayed, and display maxCount+ when count> maxCount |
-| showDot | `Boolean` | false | Optional, when true, it is a dot badge (with package) or status badge (without package); when it is false, it is a basic badge (with package) or counting badge (without package) |
-| status | `BadgeStatusType` | -- | Optional, status color danger\| warning \| waiting \| success \| info |
-| badgePos | `BadgePositionType` | 'top-right' | Optional, logo position top-left\| top-right \| bottom-left \| bottom-right |
-| bgColor | `String` | -- | Optional, customize the logo color, at this time the badge status color set by the status parameter is invalid |
-| textColor | `String` | -- | Optional, logo text color can be customized |
-| offsetXY | `[number, number] ` | -- | Optional, optional, the logo position offset when there is a package, the format is [x,y], and the unit is px. x is the offset relative to right or left, and y is the offset relative to top or bottom |
-
-
diff --git a/packages/devui-vue/docs/en-US/components/button/button.md b/packages/devui-vue/docs/en-US/components/button/button.md
deleted file mode 100644
index b626daa9..00000000
--- a/packages/devui-vue/docs/en-US/components/button/button.md
+++ /dev/null
@@ -1,82 +0,0 @@
-# How to use
-
-Import into module:
-
-```ts
-import { ButtonModule } from 'ng-devui/button';
-```
-
-In the page:
-
-```xml
-
-```
-# d-button
-## d-button Parameter
-
-| Parameter | Type | Default | Description | Jump to Demo |Global Config|
-| :----------------: | :---------: | :------------: | :-----: | :--------------------------------------------------------------------------- | |
-| id | `string` | -- | Optional. ID of the button. | [Primary Buttons](demo#button-primary)|
-| type | [`IButtonType`](#ibuttontype) | 'button' | Optional. The type is `'button' \| 'submit' \| 'reset'` |[Danger Buttons](demo#button-danger) |
-| bsStyle | [`IButtonStyle`](#ibuttonstyle) | 'primary' | Optional. The style is `'primary' \| 'common' \| 'text' \| 'text-dark' \| 'danger'` | [Common Buttons](demo#button-common) |
-| bsSize | [`IButtonSize`](#ibuttonsize) | 'md' | Optional. The size is `'lg' \| 'md' \| 'sm' \| 'xs'` | [Button Size](demo#button-size) |
-| bsPosition |[`IButtonPosition`](#ibuttonposition) |'default'| Optional. The button position is `'default' \| 'left' \| 'right'` | [Left & Right Buttons](demo#button-left-right) |
-| bordered | `boolean` | false | Optional. Indicating whether a border exists | [Auto-focus Buttons](demo#button-auto-focus)|
-| icon | `string` | -- | Optional. Customized button icon | [Icon Buttons](demo#button-icon) |
-| showLoading | `boolean` | false | Optional. Indicating whether to display the loading prompt | [Loading Buttons](demo#button-loading) |
-| width | `string` | -- | Optional. Button width |[Combinations of Primary & Common Buttons](demo#button-primary-and-common) |
-| disabled | `boolean` | false | Optional. Indicating whether to disable the button | [Primary Buttons](demo#button-primary) |
-| autofocus | `boolean` | false | Optional. Indicating whether to automatically obtain the focus during button loading | [Auto-focus Buttons](demo#button-auto-focus) |
-
-## d-button Event
-
-| Parameter | Type | Description | Jump to Demo |
-| :------: | :-----------------: | :-------------------------------------------------------------------------------------- | ---------------------------------------------- |
-| btnClick | `EventEmitter` | Optional. Solve the click event is triggered when button is disabled. After the mouse is clicked, the mouse event object is returned | [Loading Buttons](demo#button-loading)|
-
-# d-button-group
-
-## d-button-group parameter
-
-| Parameter | Type | Default | Description | Jump to Demo |Global Config|
-| :----------------: | :---------: | :------------: | :-----: | :--------------------------------------------------------------------------- | |
-| size | [`IButtonGroupSize`](#ibuttongroupsize) | 'md' | Optional. The size is `'lg' \| 'md' \| 'sm' \| 'xs'` | [Button Group](demo#button-groups) |
-
-# Interface & Type Definition
-### IButtonType
-
-The default value is 'button', indicating the button type.
-
-```ts
-export type IButtonType = 'button' | 'submit' | 'reset';
-```
-
-### IButtonStyle
-
-The default value is 'primary', indicating the button style.
-
-```ts
-export type IButtonStyle = 'common' | 'primary' | 'text' | 'text-dark' | 'danger';
-```
-
-### IButtonPosition
-
-The default value is 'default', indicating the button position.
-
-```ts
-export type IButtonPosition = 'left' | 'right' | 'default';
-```
-
-### IButtonSize
-The default value is 'md', indicating the button size.
-
-```ts
-export type IButtonSize = 'lg' | 'md' | 'sm' | 'xs';
-```
-
-### IButtonGroupSize
-The default value is 'md', indicating the button-group size.
-
-```ts
-export type IButtonGroupSize = 'lg' | 'md' | 'sm' | 'xs';
-```
diff --git a/packages/devui-vue/docs/en-US/components/button/index.md b/packages/devui-vue/docs/en-US/components/button/index.md
deleted file mode 100644
index 4870da3b..00000000
--- a/packages/devui-vue/docs/en-US/components/button/index.md
+++ /dev/null
@@ -1,27 +0,0 @@
-# Button
-
-The button is used to start an instant operation。
-
-### When to use
-
-An operation command (or a group of encapsulation) is marked, and the corresponding business logic is triggered in response to the user's click behavior。
-
-### Main button
-
-Primary
-Disabled
-
-```html
-Primary
-Disabled
-```
-
-### Secondary button
-
-Common
-Disabled
-
-```html
-Common
-Disabled
-```
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/card/index.md b/packages/devui-vue/docs/en-US/components/card/index.md
deleted file mode 100644
index d81ada82..00000000
--- a/packages/devui-vue/docs/en-US/components/card/index.md
+++ /dev/null
@@ -1,220 +0,0 @@
-# Card
-
-Universal card container。
-
-### When to use
-
-Basic card container, which can contain text, lists, pictures, paragraphs, used for overview display。
-
-
-### Basic usage
-
-
-
-
-
-
- DEVUI Course
-
-
- DevUI
-
-
- DEVUI is a free open-source and common solution for the front end of enterprise mid- and back-end products. Its design values are basedon...
-
-
-
- 12
-
-
- 8
-
-
- 8
-
-
-
-
-```html
-
-
-
-
-
- DEVUI Course
-
-
- DevUI
-
-
- DEVUI is a free open-source and common solution for the front end of enterprise mid- and back-end products. Its design values are basedon...
-
-
-
- 12
-
-
- 8
-
-
- 8
-
-
-
-```
-
-### Use image
-
-The alignment of the d-card-actions operation area can be set through align: initial alignment, tail alignment, stretch alignment。
-
-
-
-
-
-
- DEVUI Course
-
-
- DevUI
-
-
- DEVUI is a free open-source and common solution for the front end of enterprise mid- and back-end products. Its design values are basedon...
-
-
-
- 12
-
-
- 8
-
-
- 8
-
-
-
-
-```html
-
-
-
-
-
- DEVUI Course
-
-
- DevUI
-
-
- DEVUI is a free open-source and common solution for the front end of enterprise mid- and back-end products. Its design values are basedon...
-
-
-
- 12
-
-
- 8
-
-
- 8
-
-
-
-```
-
-### Custom Area
-
-
-
-
- DEVUI Course
-
-
- Updated at Dec 31 15:55
-
-
-
-
-
-
-
-```html
-
-
-
- DEVUI Course
-
-
- Updated at Dec 31 15:55
-
-
-
-
-
-
-```
-
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/carousel/index.md b/packages/devui-vue/docs/en-US/components/carousel/index.md
deleted file mode 100644
index 4fad5733..00000000
--- a/packages/devui-vue/docs/en-US/components/carousel/index.md
+++ /dev/null
@@ -1,162 +0,0 @@
-# Carousel
-
-A set of carousel areas。
-
-### When to use
-
-1. Used to display pictures or cards。
-
-### Basic usage
-
- {{ item }}
-
-
-```html
-
- {{ item }}
-
-```
-```css
-.d-carousel-item {
- text-align: center;
- line-height: 200px;
- background: var(--devui-global-bg, #f3f6f8);
-}
-```
-### 指示器&切换箭头
-arrowTrigger设为always可以使箭头永久显示,dotTrigger设为hover可以使hover到点上就切换。
-
-
- {{ item }}
-
-
-```html
-
- {{ item }}
-
-```
-### Automatic carousel
-
- {{ item }}
-
-
-```html
-
- {{ item }}
-
-```
-### Custom action
-
- {{ item }}
-
-
- 上一张
- 下一张
- 第一张
-
-
-```html
-
- {{ item }}
-
-
- 上一张
- 下一张
- 第一张
-
-```
-```css
-.carousel-demo-operate{
- margin-top: 10px;
-
- display: flex;
- align-items: center;
-
- > * {
- margin-right: 20px;
- }
-}
-```
-
-### API
-#### parameter
-
-| parameter | type | default | description | jump Demo |
-| :----------: | :--------------------------: | :------: | :---------------------------------------------- | ------------------------------------------------ |
-| arrowTrigger | `'hover'\|'never'\|'always'` | 'hover' | Optional, specify the switching arrow display mode | [Indicator-switch-arrow](#Indicator-switch-arrow) |
-| autoplay | `boolean` | false | Optional, whether to rotate automatically | [Automatic-carousel](#Automatic-carousel) |
-| autoplaySpeed | `number` | 3000 | Optional, used with `autoplay`, automatic rotation speed, unit: ms | [Automatic-carousel](#Automatic-carousel) |
-| height | `string` | '100%' | Optional, carousel container height | [Basic-usage](#Basic-usage) |
-| showDots | `boolean` | true | Optional, whether to display the panel indicator | [Automatic-carousel](#Automatic-carousel) |
-| dotPosition | `'top'\|'bottom'` | 'bottom' | Optional, panel indicator position | [Indicator-switch-arrow](#Indicator-switch-arrow) |
-| dotTrigger | `'click'\|'hover'` | 'click' | Optional, indicator triggers carousel mode | [Indicator-switch-arrow](#Indicator-switch-arrow) |
-| activeIndex | `number` | 0 | Optional, initialize the active card index, starting from 0, supporting `[(activeIndex)]` two-way binding | [Basic-usage](#Basic-usage) |
-
-#### Event
-
-| event | type | description | jump Demo |
-| :----------------: | :---------------------: | :-----------------------------------------: | ------------------------------------------------- |
-| activeIndexChange | `EventEmitter` | When the card is switched, return to the index of the current card, starting from 0 | [Basic-usage](#Basic-usage) |
-
-#### methods
-
-| methods | description | jump Demo |
-| :---------: | :---------------------------------- | :----------------------------- |
-| prev() | Switch to the previous card | [Custom-action](#Custom-action) |
-| next() | Switch to the next card | [Custom-action](#Custom-action) |
-| goTo(index) | Switch to the card with the specified index, the index starts from 0 | [Custom-action](#Custom-action) |
-
-
-
-
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/checkbox/index.md b/packages/devui-vue/docs/en-US/components/checkbox/index.md
deleted file mode 100644
index 1cd4822d..00000000
--- a/packages/devui-vue/docs/en-US/components/checkbox/index.md
+++ /dev/null
@@ -1,42 +0,0 @@
-# CheckBox
-
-CheckBox。
-
-### When to use
-
-1. Make multiple choices in a set of options;
-2. Used alone can indicate switching between the two states, and can be combined with the submit operation。
-
-### Basic usage
-
-
-
-
-```html
-
-
-```
-
-#### use CheckboxGroup
-
-
-
-
-{{ checkedValues.reduce((prev, current) => `${current} ${prev}`, '') }}
-
-
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/date-picker/index.md b/packages/devui-vue/docs/en-US/components/date-picker/index.md
deleted file mode 100644
index 6ec80542..00000000
--- a/packages/devui-vue/docs/en-US/components/date-picker/index.md
+++ /dev/null
@@ -1,121 +0,0 @@
-
-
-# DatePicker
-
-Date and time visual input。
-
-## Attributes auto-close
-
-|project|description|
-|----|----|
-|name|auto-close / autoClose|
-|type|boolean|
-|mustSelect|false|
-|default|false|
-|description|After selecting the date, whether to automatically close the date panel|
-
-```vue
-
-
-
-
-
-
-
-```
-
-
-
-
-## Attributes range
-
-|project|description|
-|----|----|
-|name|range|
-|type|boolean|
-|mustSelect|false|
-|default|false|
-|description|Whether to open interval selection|
-
-```vue
-
-
-
-
-
-
-
-```
-
-
-
-## Attributes format
-
-|project|type|
-|----|----|
-|name|format|
-|type|string|
-|mustSelect|false|
-|default|y/MM/dd|
-|description|Date value format|
-
-
-
-
-```vue
-
-
-```
-
-**Date formatting characters**
-
-|character|description|rule|
-|----|----|----|
-|y, yy, yyyy|year|When using `yy`, only the last 2 digits are displayed, otherwise 4 digits are displayed。for example:`yy/MM/dd -> 21/01/02`, `y/MM/dd -> 2021/01/02`|
-|M,MM|month|When using `MM`, the left side of a one-digit number will automatically add `0`。for example: `y/MM/dd -> 2021/01/02`,`y/M/d -> 2021/1/2`|
-|d,dd|date|rule reference`M`|
-|h,hh|hour|rule reference`M`;Use 24-hour representation。|
-|m,mm|minute|rule reference`M`|
-|s,ss|second|rule reference`M`|
-
-## Attributes range-spliter
-
-|project|type|
-|----|----|
-|name|range-spliter / rangeSpliter|
-|type|string|
-|mustSelect|false|
-|default|-|
-|description|In interval selection mode, the character that separates the start and end time。|
-
-```vue
-
-```
-
-
-
-## Event selectedDateChange
-
-```vue
-
-
-```
-
-
-
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/icon/index.md b/packages/devui-vue/docs/en-US/components/icon/index.md
deleted file mode 100644
index 45ba44f2..00000000
--- a/packages/devui-vue/docs/en-US/components/icon/index.md
+++ /dev/null
@@ -1,71 +0,0 @@
-# Icon 图标
-
-用于显示图标。
-
-### 何时使用
-
-需要显示图标时。
-
-所有内置的图标可在DevUI官网进行查看:
-
-[https://devui.design/icon/ruleResource](https://devui.design/icon/ruleResource)
-
-### 基本用法
-
-
-
-
-
-
-```html
-
-
-
-
-```
-
-### 自定义字体图标
-
-Icon 组件默认引用 DevUI 图标库的图标,如果需要在现有 Icon 的基础上使用更多图标,可以引入第三方 iconfont 对应的字体文件和 CSS 文件,之后就可以在 Icon 组件中直接使用。
-
-```css
-@font-face {
- font-family: "my-icon";
- src: url("./my-icon.ttf") format("truetype");
-}
-
-.my-icon {
- font-family: "my-icon";
-}
-
-.my-icon-right::before {
- content: "\E03F";
-}
-```
-
-引入字体图标的 css
-
-```css
-@import "my-icon.css";
-```
-
-or
-
-```js
-import "my-icon.css";
-```
-
-使用
-
-```html
-
-```
-
-### API
-
-| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
-| :---------: | :------: | :-------: | :----------------------- | --------------------------------- |
-| name | `String` | -- | 必选,Icon 名称 | [基本用法](#基本用法) |
-| size | `String` | '16px' | 可选,图标大小 | [基本用法](#基本用法) |
-| color | `String` | '#252b3a' | 可选,图标颜色 | [基本用法](#基本用法) |
-| classPrefix | `String` | 'icon' | 可选,自定义字体图标前缀 | [自定义字体图标](#自定义字体图标) |
diff --git a/packages/devui-vue/docs/en-US/components/image-preview/index.md b/packages/devui-vue/docs/en-US/components/image-preview/index.md
deleted file mode 100644
index 481641d3..00000000
--- a/packages/devui-vue/docs/en-US/components/image-preview/index.md
+++ /dev/null
@@ -1,137 +0,0 @@
-# ImagePreview
-
-Preview the components of one or more pictures。
-
-### When to use
-
-When you need to preview the image or preview the image in the container according to the user input。
-
-### Basic usage
-
-Use the v-d-image-preview command to preview the image in the container。
-
-
-
-
-
-```html
-
-
-
-
-
-```
-
-### Custom open preview window
-
-Pass in the custom parameter, the command will be automatically injected into the open method, and the preview window will be opened through custom.open
-
-
-
-
-自定义
-
-```html
-
-
-
-自定义
-
-
-```
-
-### Set zIndex
-
-Set zIndex to control the level of the pop-up effect, and set backDropZIndex to control the level of the background of the pop-up layer。
-You can see that when zIndex is set to be less than backDropZIndex, imagePreview will be displayed below the background。
-You can close imagePreview by Esc。
-
-```
-// 待嵌入 modal 组件即可
-```
-
-### API
-
-| parameter | type | default | description |
-| :------------: | :-------: | :---: | :------------------------------------------------------------ |
-| custom | `Object` | -- | Optional, the command will be automatically injected into the open method, and the preview window will be opened through custom.open |
-| disableDefault | `Boolean` | false | Optional, turn off the default click trigger image preview mode |
-| zIndex | `Number` | 1050 | Optional, optional, set the z-index value of the picture when previewing |
-| backDropZIndex | `Number` | 1040 | Optional, set the z-index value of the image background during preview |
-
-
-
-
diff --git a/packages/devui-vue/docs/en-US/components/input/index.md b/packages/devui-vue/docs/en-US/components/input/index.md
deleted file mode 100644
index edc7f8fa..00000000
--- a/packages/devui-vue/docs/en-US/components/input/index.md
+++ /dev/null
@@ -1,96 +0,0 @@
-# Input
-
-Text input。
-
-### When to use
-
-You need to manually enter text to use。
-
-### Basic usage
-
-:::demo
-
-```vue
-
- Default
-
-
-
- Disabled
-
-
-
- Error
-
-
-
-
-```
-
-:::
-
-### Size
-
-:::demo
-
-```vue
-
- Small
-
-
-
- Middle
-
-
-
- Large
-
-
-
-```
-
-:::
-
-
-### Password
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-### API
-
-| parameter | type | default | description | jump Demo |
-| :---------: | :------: | :-------: | :-----------------------: | :---------------------------------: |
-| id | `string` | -- | Optional, text box id | [Basic-usage](#Basic-usage) |
-| placeholder | `string` | -- | Optional,textarea placeholder | [Basic-usage](#Basic-usage) |
-| maxLength | `number` | Number.MAX_SAFE_INTEGER | Optional, the max-length of the input box | |
-| disabled | `boolean` | false | Optional,Whether the text box is disabled | [Basic-usage](#Basic-usage) |
-| error | `boolean` | false | Optional,Whether there is an input error in the text box | [Basic-usage](#Basic-usage) |
-| size | `'sm'\|''\|'lg'` | '' | Optional,There are three options for the size of the text box`'lg'`,`''`,`'sm'` | [Size](#Size) |
-| cssClass | `string` | '' | Optional,Support to pass in the class name to the input box | |
-| showPassword | `boolean` | false | Optional,password | [Password](#Password) |
-| autoFocus | `boolean` | false | Optional,Whether the input box is auto-focused | [Basic-usage](#Basic-usage) |
-
diff --git a/packages/devui-vue/docs/en-US/components/loading/index.md b/packages/devui-vue/docs/en-US/components/loading/index.md
deleted file mode 100644
index 5c0a61f5..00000000
--- a/packages/devui-vue/docs/en-US/components/loading/index.md
+++ /dev/null
@@ -1,298 +0,0 @@
-# Loading
-
-Prompt the user that the page is executing instructions and needs to wait。
-
-### When to use
-
-When the execution time is long (it takes more than a few seconds), show the user the status of execution。
-
-
-### Basic usage
-Show the basic usage in the scene of loading table data。
-:::demo
-
-```vue
-
- click me!
-
-
-
- 序号 姓名 队伍 操作
-
-
-
-
- {{index}} 张家齐 跳水 跳水队
-
-
-
-
-
-
-```
-:::
-
-
-### many promise
-support many promise。
-:::demo
-
-```vue
-
- click me!
-
- loading will show here2
-
-
-
-```
-:::
-
-### Custom Css Style
-Customize loading style through templateRef。
-:::demo
-
-```vue
-
- Loading Style 1
-
- Loading Style 2
-
- Loading Style 3
-
- loading will show here1
-
-
-
-
-
-```
-:::
-
-### Service method call
-Use the service method to load the loading component in full screen or load the loading component on the specified host。
-:::demo
-
-```vue
-
- click me show full screen loading!
-
- click me show loading in target!
-
- click me close loading in target!
-
- loading will show here3
-
-
-
-```
-:::
-
-### parameter
-The parameter of dLoading
-
-| **parameter** | **type** | **default** | **description** | **jump Demo** |
-| ------------------ | ------------------------------------------------------------ | ------------------------- | ------------------------------------------------------------ | ---------------------------- |
-| v-dLoading | `Promise \| Array> \| Boolean \| undefined` | -- | Optional, command mode, control loading status | [Basic-usage](#Basic-usage) |
-| target | `element` | document.body | Optional, service mode, DOM nodes that need to be covered by Loading | [Service-method-call](#Service-method-call) |
-| message | `string` | -- | Optional, prompt message during loading | [many-promise](#many-promise) |
-| loadingTemplateRef | `VNode` | -- | Optional, custom loading template | [Custom-css-style](#Custom-css-style) |
-| backdrop | `boolean` | true | Optional, whether to show the mask during loading | [Basic-usage](#Basic-usage) |
-| positionType | `string` | relative | Optional, specify the positioning type of the `dLoading` host element, the value is consistent with the css position attribute。 | [Basic-usage](#Basic-usage) |
-| view | `{top?:string,left?:string} ` | {top: '50%', left: '50%'} | Optional, adjust the display position of loading, relative to the top and left distances of the host element | [Basic-usage](#Basic-usage) |
-| zIndex | `number` | -- | Optional, z-index value of loading prompt | [Basic-usage](#Basic-usage) |
-
diff --git a/packages/devui-vue/docs/en-US/components/overlay/index.md b/packages/devui-vue/docs/en-US/components/overlay/index.md
deleted file mode 100644
index 6a7399ba..00000000
--- a/packages/devui-vue/docs/en-US/components/overlay/index.md
+++ /dev/null
@@ -1,198 +0,0 @@
-## overlay
-The mask layer is a basic component and is used to build components independent of the current page layout。
-### When to use
-You can use this component when you need a global pop-up window, or when you need an element-following function。
-### Fixed overlay
-
-:::demo Use `sm`, `''`, `lg` to define the basic type of `Search`
-
-```vue
-
- {{title}}
-
- hello world
-
-
-
-```
-:::
-
-
-### Elastic overlay
-
-:::demo
-```vue
-
-
-
orgin
-
{{title}}
-
-
- 依赖元素的 X 轴:
-
-
-
- 依赖元素的 Y 轴:
-
-
-
- Overlay X 轴:
-
-
-
- Overlay Y 轴:
-
-
-
-
-
-
- hello world
-
-
-
-```
-
-:::
-
-
-
-
-### API
-The parameter of d-fixed-overlay
-
-| parameter | type | default | description |
-| :--------------: | :------------------------: | :---: | :-------------------------------------------------------------------- |
-| visible | `boolean` | false | Optional, whether the mask layer is visible |
-| onUpdate:visible | `(value: boolean) => void` | -- | Optional, the mask layer cancels the visible event |
-| backgroundBlock | `boolean` | false | Optional, if true, the background cannot be scrolled |
-| backgroundClass | `string` | -- | Optional, the style class of the background |
-| hasBackdrop | `boolean` | true | Optional, if false, the content behind the background will be triggered |
-| backdropClick | `() => void` | -- | Optional, click on the event triggered by the background |
-| backdropClose | `boolean` | false | Optional, if true, clicking on the background will trigger `onUpdate:visible`, the default parameter is false |
-| overlayStyle | `CSSProperties` | -- | Optional, the style of the mask layer |
-
-The parameter of d-flexible-overlay
-
-| 参数 | 类型 | 默认 | 说明 |
-| :--------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---: | :---------------------------------------------------------------- |
-| visible | `boolean` | false | 可选,遮罩层是否可见 |
-| onUpdate:visible | `(value: boolean) => void` | -- | 可选,遮罩层取消可见事件 |
-| backgroundBlock | `boolean` | false | 可选,如果为 true,背景不能滚动 |
-| backgroundClass | `string` | -- | 可选,背景的样式类 |
-| hasBackdrop | `boolean` | true | 可选,如果为false,背景后下的内容将可以触发 |
-| backdropClick | `() => void` | -- | 可选,点击背景触发的事件 |
-| backdropClose | `boolean` | false | 可选,如果为true,点击背景将触发 `onUpdate:visible`,参数是 false |
-| origin | `Element \| ComponentPublicInstance \| { x: number, y: number, width?: number, height?: number }` | false | 必选,你必须指定起点元素才能让遮罩层与该元素连接在一起 |
-| position | `{originX: HorizontalPos, originY: VerticalPos, overlayX: HorizontalPos, overlayY: VerticalPos } (type HorizontalPos = 'left' \| 'center' \| 'right') ( type VerticalPos = 'top' \| 'center' \| 'bottom')` | false | 可选,指定遮罩层与原点的连接点 |
diff --git a/packages/devui-vue/docs/en-US/components/pagination/index.md b/packages/devui-vue/docs/en-US/components/pagination/index.md
deleted file mode 100644
index 6e85d151..00000000
--- a/packages/devui-vue/docs/en-US/components/pagination/index.md
+++ /dev/null
@@ -1,473 +0,0 @@
-# Pagination
-
-Pagination。
-
-### When to use
-
-When loading/rendering all the data will take a lot of time, you can switch the page number to browse the data。
-
-
-### Basic usage
-
-:::demo
-
-```vue
-
- size = 'sm'
-
-
- size = 'md'
-
-
- size = 'lg'
-
-
- Custom Style
-
-
-
-```
-:::
-
-
-### Minimalist mode
-Minimalist mode is suitable for some pages with a lot of information, which can simplify the complexity of the page。
-:::demo
-
-
-```vue
-
- Simple Mode
-
-
- Super Simple Mode
-
-
- haveConfigMenu = "true"
-
-
-
-
-
-
-
-
-```
-:::
-
-### Multiple configurations
-Support setting input jump, display jump button; setting pageSize and other functions。
-:::demo
-
-```vue
-
-
-
-
-
-
-
-
-
-
-
-```
-:::
-
-### Special cases
-The display of the pager in a special scene。
-:::demo
-
-
-```vue
-
-
- When the value of pageIndex
exceeds the maximum page number, enable showTruePageIndex
to display the value of pageIndex
-
-
-
-
- When the value of pageIndex
exceeds the maximum page number, the showTruePageIndex
function is disabled and only the maximum page number is displayed.
-
-
-
- Default Mode
-
-
- total = 0
- total = 5
- total = 15
-
-
- Simple Mode
-
-
- total = 0
- total = 20
- total = 30000
- total = 100000
- index = 2
- index = 3
-
-
-
-```
-:::
-
-### 参数
-
-d-pagination 参数
-
-| parameter | type | default | description | jump Demo |
-| ----------------- | ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------ | --------------------- |
-| pageSize | `number` | 10 | Optional, display the maximum number of entries per page | [Basic-usage](#Basic-usage) |
-| total | `number` | 0 | Optional, total number of entries displayed | [Basic-usage](#Basic-usage) |
-| pageSizeOptions | `number[] ` | 10 | Optional, the data source of the drop-down box for the maximum number of entries per page for pagination, there are four options by default 5, 10, 20, 50 | [Multiple-configurations](#Multiple-configurations) |
-| pageSizeDirection | `Array<`[`AppendToBodyDirection`](#appendtobodydirection) `\|` [`ConnectedPosition`](#connectedposition)`>` | ['centerDown', 'centerUp'] | Optional, set the display direction of the drop-down box of each page entry | [Multiple-configurations](#Multiple-configurations) |
-| pageIndex | `number` | 1 | Optional, initialize page number | [Basic-usage](#Basic-usage) |
-| maxItems | `number` | 10 | Optional, display a few buttons at most for pagination | [Basic-usage](#Basic-usage) |
-| preLink | `string` | -- | Optional, the previous page button displays the icon, the default setting is the left arrow icon | [Basic-usage](#Basic-usage) |
-| nextLink | `string` | -- | Optional, the next page button displays the icon, the default setting is the right arrow icon | [Basic-usage](#Basic-usage) |
-| size | `number` | '' | 可Selection, paging component size, there are three options lg,``,sm, respectively representing large, medium and small | [Basic-usage](#Basic-usage) |
-| canJumpPage | `boolean` | false | Optional, whether to display the page input jump | [Basic-usage](#Basic-usage) |
-| canChangePageSize | `boolean` | false |Optional, whether to display the drop-down box for selecting the maximum number of entries per page for changing the pagination | [Basic-usage](#Basic-usage) |
-| canViewTotal | `boolean` | false | Optional, whether to display total entries | [Basic-usage](#Basic-usage) |
-| totalItemText | `string` | 'All entries' | Optional, total entry text | [Minimalist-mode](#Minimalist-mode) |
-| goToText | `string` | 'jump to' | Optional, total entry text | [Basic-usage](#Basic-usage) |
-| showJumpButton | `boolean` | false | Optional, whether to show the jump button | [Multiple-configurations](#Multiple-configurations) |
-| showTruePageIndex | `boolean` | false | Optional, the switch to display the current page number when the page number exceeds the paging range | [Multiple-configurations](#Multiple-configurations) |
-| lite | `boolean` | false | Optional, whether to switch to Minimalist-mode | [Minimalist-mode](#Minimalist-mode) |
-| showPageSelector | `boolean` | true | Optional, whether to show page number drop-down under `Minimalist-mode` | [Minimalist-mode](#Minimalist-mode) |
-| haveConfigMenu | `boolean` | false | Optional, whether to display the configuration under `Minimalist-mode` | [Minimalist-mode](#Minimalist-mode) |
-| autoFixPageIndex | `boolean` | true | Optional, whether to automatically correct the page number when changing the pageSize. If the `pageIndex` is handled in the `pageSizeChange` event, it is recommended to set it to `false` | [Minimalist-mode](#Minimalist-mode) |
-| autoHide | `boolean` | false | Optional, whether to hide automatically, autoHide is true and the minimum value of pageSizeOptions> total does not show pagination | [Minimalist-mode](#Minimalist-mode) |
-
-d-pagination Event
-
-| parameter | type | default | jump Demo |
-| --------------- | -------------------- | ---------------------------------------------------------- | --------------------- |
-| pageIndexChange | `EventEmitter` | Optional, callback of page number change, return current page number value | [Multiple-configurations](#Multiple-configurations) |
-| pageSizeChange | `EventEmitter` | Optional, callback when the maximum number of items per page is changed, return the current number of items displayed on each page | [Multiple-configurations](#Multiple-configurations) |
-
-**Tnterface & TypeDefine**
-
-##### AppendToBodyDirection
-
-```ts
-export type AppendToBodyDirection = 'rightDown' | 'rightUp' | 'leftUp' | 'leftDown' | 'centerDown' | 'centerUp';
-```
-
-##### ConnectedPosition
-
-```ts
-export interface ConnectedPosition {
- originX: 'start' | 'center' | 'end';
- originY: 'top' | 'center' | 'bottom';
-
- overlayX: 'start' | 'center' | 'end';
- overlayY: 'top' | 'center' | 'bottom';
-
- weight?: number;
- offsetX?: number;
- offsetY?: number;
- panelClass?: string | string[];
-}
-```
-
diff --git a/packages/devui-vue/docs/en-US/components/panel/index.md b/packages/devui-vue/docs/en-US/components/panel/index.md
deleted file mode 100644
index da8c4438..00000000
--- a/packages/devui-vue/docs/en-US/components/panel/index.md
+++ /dev/null
@@ -1,74 +0,0 @@
-# Panel
-
-Content panel for content grouping。
-
-### When to use
-
-Used when the page content needs to be displayed in groups, generally including three parts: header, content area, and bottom。
-
-### Basic usage
-
-
-
-
- Panel with foldable
-
-
- This is body
-
-
-
-
- Panel has no left padding
-
-
- This is body
-
-
-
- Panel with header and footer
- This is body
- This is footer
-
-
-
-
-```html
-
-
-
- Panel with foldable
-
-
- This is body
-
-
-
-
- Panel has no left padding
-
-
- This is body
-
-
-
- Panel with header and footer
- This is body
- This is footer
-
-
-```
-
-
diff --git a/packages/devui-vue/docs/en-US/components/popover/index.md b/packages/devui-vue/docs/en-US/components/popover/index.md
deleted file mode 100644
index 522495c9..00000000
--- a/packages/devui-vue/docs/en-US/components/popover/index.md
+++ /dev/null
@@ -1,386 +0,0 @@
-# Popover
-Simple text prompt bubble box。
-
-### When to use
-Used to notify users of non-critical issues or to prompt a control in a special situation。
-
-### Basic usage
-When Popover pops up, it will be positioned based on the content of the `reference` slot。
-
-
-
-
- default
-
-
-
-
- info
-
-
-
-
- error
-
-
-
-
- success
-
-
-
-
- warning
-
-
-
-
- no-animation
-
-
-
-
-
-```html
-
-
- default
-
-
-
-
-
- info
-
-
-
-
-
- error
-
-
-
-
-
- success
-
-
-
-
-
- warning
-
-
-
-
- no-animation
-
-
-```
-
-### Custom content
-Customize the content of the `reference` slot and the content of the pop-up prompt。
-
-
-
-
- Custom-content
-
-
-
-
-```html
-
-
-
- Custom-content
-
-
-
-```
-
-### Pop-up position
-A total of 12 pop-up positions are supported。
-
-
-
-
- left
-
-
- left
-
-
-
-
- left-top
- left-top
-
-
- left-top
-
-
-
-
- left-bottom
- left-bottom
-
-
- left-bottom
-
-
-
-
-
-
-
- top
-
-
- top
-
-
-
-
- top-left
-
-
- top-left
-
-
-
-
- top-right
-
-
- top-right
-
-
-
-
-
-
-
- right
-
-
- right
-
-
-
-
- right-top
- right-top
-
-
- right-top
-
-
-
-
- right-bottom
- right-bottom
-
-
- right-bottom
-
-
-
-
-
-
-
- bottom
-
-
- bottom
-
-
-
-
- bottom-left
-
-
- bottom-left
-
-
-
-
- bottom-right
-
-
- bottom-right
-
-
-
-
-```html
-
-
-
- left
-
-
- left
-
-
-
-
- left-top
- left-top
-
-
- left-top
-
-
-
-
- left-bottom
- left-bottom
-
-
- left-bottom
-
-
-
-
-
-
-
- top
-
-
- top
-
-
-
-
- top-left
-
-
- top-left
-
-
-
-
- top-right
-
-
- top-right
-
-
-
-
-
-
-
- right
-
-
- right
-
-
-
-
- right-top
- right-top
-
-
- right-top
-
-
-
-
- right-bottom
- right-bottom
-
-
- right-bottom
-
-
-
-
-
-
-
- bottom
-
-
- bottom
-
-
-
-
- bottom-left
-
-
- bottom-left
-
-
-
-
- bottom-right
-
-
- bottom-right
-
-
-
-```
-
-### Delay trigger
-Only when the trigger is hover, the mouse moves in for more than [mouseEnterDelay] milliseconds to trigger to prevent flashing caused by the user inadvertently swiping. The default value is 150 milliseconds; after the mouse is moved out, it will be triggered after [mouseLeaveDelay] milliseconds. , The Popover component will be hidden, the default value is 100 milliseconds。
-
-
-
-
- Mouse enter 500ms later.
- show Me
-
-
- MouseEnter delay 500ms
-
-
-
-
- Mouse leave 2000ms later.
-
-
- MouseLeave delay 2000ms
-
-
-
-
-```html
-
-
- bottom-right
-
-
- bottom-right
-
-
-
-
- bottom-right
-
-
- bottom-right
-
-
-```
-
-### dPopover parameter
-
-| parameter | type | default | description | jump Demo |
-| ---- | ---- | ---- | ---- | ---- |
-| content | `string` | defalut |Optional, the display content of the pop-up box | [Custom-content](#Custom-content) |
-| visible | `boolean` | false | Optional, the initial pop-up state of the bullet box | [Basic-usage](#Basic-usage) |
-| trigger | `string` | click | Optional, trigger mode of the bullet frame | [Basic-usage](#Basic-usage) |
-| popType | `string` | default | Optional, pop-up box type, different styles | [Basic-usage](#Basic-usage) |
-| zIndex | `number` | 1060 | Optional, z-index value is used to manually control the layer height | [Basic-usage](#Basic-usage) |
-| positionType | `string` | bottom | Optionally, control the direction in which the bullet frame appears | [Pop-up-position](#Pop-up-position) |
-| showAnimation | `boolean` | true | Optional, whether to show animation | [Basic-usage](#Basic-usage) |
-| mouseEnterDelay | `number` | 150 | Optional, only when the trigger is hover, set the delay after the mouse moves in to display Popover, the unit is `ms`| [Delay-trigger](#Delay-trigger) |
-| mouseLeaveDelay | `number` | 100 | Optional, only need to set the delay after the mouse is moved out to hide the popover only when the trigger is hover, the unit is `ms` | [Delay-trigger](#Delay-trigger) |
-
diff --git a/packages/devui-vue/docs/en-US/components/progress/index.md b/packages/devui-vue/docs/en-US/components/progress/index.md
deleted file mode 100644
index 402090d5..00000000
--- a/packages/devui-vue/docs/en-US/components/progress/index.md
+++ /dev/null
@@ -1,142 +0,0 @@
-# Progress
-
-progress bar。
-
-### When to use
-1. When the operation takes a long time, show the user the progress of the operation。
-2. When the operation needs to interrupt the existing interface or background operation, it takes a long time。
-3. When it is necessary to display the percentage of an operation completed or the completed steps/total steps。
-
-### Basic usage
-Basic progress and text configuration。
-
-
-
-
-```html
-
-
-
-
-
-
-```
-
-```css
-.progress-container {
- margin-bottom: 20px;
-}
-```
-
-### Ring usage
-Basic progress and text configuration。
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-```html
-
-
-
-
-
-
-
-
-
-
-
-```
-
-```css
-.progress-container-circle {
- height: 130px;
- width: 130px;
- font-size: 20px;
- display: inline-block;
- margin-right: 10px;
-}
-
-.icon-position {
- position: absolute;
- top: 50%;
- left: 50%;
- width: 100%;
- margin: 0;
- padding: 0;
- line-height: 1;
- white-space: normal;
- text-align: center;
- transform: translate(-50%, -50%);
- color: #50d4ab;
- font-size: 24px;
-}
-```
-
-### API
-#### d-progress parameter
-| parameter | type | default | description | jump Demo |
-| :---: | :---: | :---: | :---: | :---: |
-| percentage | `number` | 0 | Optional, the maximum value of the progress bar is 100 | [基本用法](#基本用法) |
-| percentageText | `string` | -- | Optional, the text description of the current value of the progress bar, such as: '30%' \| '4/5' | [基本用法](#基本用法) |
-| barBgColor | `string` | #5170ff | Optional, the color of the progress bar is displayed, the default is sky blue | [基本用法](#基本用法) |
-| height | `string` | 20px | Optional, the height of the progress bar, the default value is 20px | [基本用法](#基本用法) |
-| isCircle | `boolean` | false | Optional, show whether the progress bar is a circle | [圆环用法](#圆环用法) |
-| strokeWidth | `number` | 6 | Optional, set the width of the circular progress bar, the unit is the percentage of the width of the progress bar and the canvas | [圆环用法](#圆环用法) |
-| showContent | `boolean` | true | Optional, set whether to display content in the circle-shaped progress bar | [圆环用法](#圆环用法) |
-
-
-
diff --git a/packages/devui-vue/docs/en-US/components/quadrant-diagram/index.md b/packages/devui-vue/docs/en-US/components/quadrant-diagram/index.md
deleted file mode 100644
index e212464c..00000000
--- a/packages/devui-vue/docs/en-US/components/quadrant-diagram/index.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# ProQuadrantDiagramgress
-
-Quadrant diagram。
-
-### When to use
-
-Regional division and value sorting of affairs according to needs, which can be used to manage the priority of affairs。
-
-### Basic usage
-
-Basic Usage
-
-:::demo
-
-```vue
-
-
-
-
-
-
-
-```
-
-:::
diff --git a/packages/devui-vue/docs/en-US/components/radio/index.md b/packages/devui-vue/docs/en-US/components/radio/index.md
deleted file mode 100644
index 3ab37dd6..00000000
--- a/packages/devui-vue/docs/en-US/components/radio/index.md
+++ /dev/null
@@ -1,307 +0,0 @@
-# Radio 单选框
-
-单选框。
-
-### 何时使用
-
-用户要从一个数据集中选择单个选项,且能并排查看所有可选项,选项数量在 2~7 之间时,建议使用单选按钮。
-
-### 相互独立的单选项
-
-:::demo
-
-```vue
-
-
- The Radio value is: {{ item }}
-
-
-
-
-```
-
-:::
-
-### radio 根据条件终止切换操作
-
-:::demo 根据条件判断,第二项禁止跳转。
-
-```vue
-
-
- The Radio value is: {{ item }}
-
-
-
-
-```
-
-:::
-
-### radio-group 根据条件终止切换操作
-
-:::demo
-
-```vue
-
-
-
- {{ item }}
-
-
-
-
- {{ item }}
-
-
-
-
-
-```
-
-:::
-
-### 禁用
-
-:::demo
-
-```vue
-
-
- The Radio value is: {{ item }}
-
-
-
-
-```
-
-:::
-
-### 横向排列
-
-:::demo
-
-```vue
-
-
-
- The Radio value is: {{ item }}
-
-
-
-
-
-```
-
-:::
-
-### 竖向排列
-
-:::demo
-
-```vue
-
-
-
-
-
-```
-
-:::
-
-### 自定义单选项
-
-:::demo 数组源可为普通数组、对象数组等。
-
-```vue
-
-
-
- The Radio value is: {{ item }}
-
-
-
-
- The Radio value is: {{ item.name }}
-
-
-
-
-
-```
-
-:::
-
-### API
-
-d-radio 参数
-
-| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
-| :----------: | :------------------: | :---: | :------------------------------------------------------------------------------ | --------------------------------------- |
-| name | `string` | -- | 可选,单选项名称 | [互相独立的单选项](#相互独立的单选项) |
-| value | `string` | -- | 必选,单选项值 | [互相独立的单选项](#相互独立的单选项) |
-| disabled | `boolean` | false | 可选,是否禁用该单选项 | [禁用](#禁用) |
-| beforeChange | `Function / Promise` | -- | 可选,radio 切换前的回调函数,返回 boolean 类型,返回 false 可以阻止 radio 切换 | [回调切换](#radio-根据条件终止切换操作) |
-
-d-radio 事件
-
-| 参数 | 类型 | 说明 | 跳转 Demo |
-| :----: | :--------------------: | :------------------------------- | ------------------------------------- |
-| change | `EventEmitter` | 单选项值改变时触发,返回选中的值 | [互相独立的单选项](#相互独立的单选项) |
-
-d-radio-group 参数
-
-| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
-| :----------: | :------------------: | :------: | :-------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| name | `string` | -- | 可选,单选框的名称 | [竖向排列](#竖向排列) |
-| values | `array` | -- | 可选,单选数据组 | [竖向排列](#竖向排列) |
-| disabled | `boolean` | false | 可选,是否禁用该选项组 | [radio-group 根据条件终止切换操作](#radio-group-根据条件终止切换操作) |
-| cssStyle | `'row' / 'column'` | 'column' | 可选,设置横向或纵向排列 | [横向排列](#横向排列) |
-| beforeChange | `Function / Promise` | -- | 可选,radio-group 切换前的回调函数,返回 boolean 类型,返回 false 可以阻止 radio-group 的切换 | [回调切换](#radio-group-根据条件终止切换操作) |
-
-d-radio-group 事件
-
-| 参数 | 类型 | 说明 | 跳转 Demo |
-| :----: | :--------------------: | :------------------------------- | --------------------- |
-| change | `EventEmitter` | 单选项值改变时触发,返回选中的值 | [竖向排列](#竖向排列) |
diff --git a/packages/devui-vue/docs/en-US/components/rate/index.md b/packages/devui-vue/docs/en-US/components/rate/index.md
deleted file mode 100644
index 4ffde650..00000000
--- a/packages/devui-vue/docs/en-US/components/rate/index.md
+++ /dev/null
@@ -1,138 +0,0 @@
-# Rate
-
-Grade evaluation。
-
-When to sue
-It can be used when users rate a product。
-
-### Demo
-
-### Read-only mode
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-### Dynamic mode
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-### Dynamic mode-custom
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-### Use the type parameter
-
-:::demo
-
-```vue
-
-
-
-
-
-
-
-
-
-
-
-
-```
-
-:::
-
-### API
-
-d-rate parameter
-
-| parameter | type | default | description | jump Demo |
-| :-------: | :-----------------------------: | :----: | :------------------------------------------------------- | ----------------------------------- |
-| read | `boolean` | false | Optional, set whether to read-only mode, read-only mode cannot be interactive | [只读模式](#只读模式) |
-| count | `number` | 5 | Optional, set the total number of levels | [只读模式](#只读模式) |
-| type | `'success'\|'warning'\|'error'` | -- | Optional, set the current rating type, different types correspond to different colors | [使用 type 参数](#使用-type-参数) |
-| color | `string` | -- | Optional, star color | [动态模式-自定义](#动态模式-自定义) |
-| icon | `string` | -- | Optional, the style of the rating icon, only supports all icons in the devUI icon library | [动态模式](#动态模式) |
-| character | `string` | -- | Optional, the style of the rating icon, only one of icon and character can be set | [动态模式-自定义](#动态模式-自定义) |
diff --git a/packages/devui-vue/docs/en-US/components/search/index.md b/packages/devui-vue/docs/en-US/components/search/index.md
deleted file mode 100644
index a47a8355..00000000
--- a/packages/devui-vue/docs/en-US/components/search/index.md
+++ /dev/null
@@ -1,95 +0,0 @@
-# Search 搜索框
-
-### 基本用法
-
-:::demo 使用`sm`,`''`,`lg`来定义`Search`基本类型
-
-```vue
-
-
- Small
-
- Middle
-
- Large
-
- Disabled
-
-
-
-```
-:::
-
-### 搜索图标左置
-
-:::demo 使用`left`,`right`来定义`Search`搜索图标位置, 默认`right`
-
-```vue
-
-
-
-
-
-```
-:::
-
-### 无边框
-
-:::demo 使用`noBorder`来定义`Search`无边框
-
-```vue
-
-
-
-
-
-```
-:::
-
-### 双向绑定
-
-:::demo 使用`v-model`双向绑定
-
-```vue
-
-
-
-
-
-
-```
-
-:::
-
-### API
-
-| 参数 | 类型 | 默认 | 说明 | 跳转 Demo | 全局配置项 |
-| :---------: | :------: | :-------: | :----------------------- | --------------------------------- | --------- |
-| size | `'sm'\|''\|'lg'` | '' | 可选,搜索框尺寸,有三种选择 lg、''、sm | [基本用法](#基本用法) ||
-| placeholder | `string` | -- | 可选,输入框 placeholder | [搜索图标左置](#搜索图标左置) ||
-| maxLength | `number` | -- | 可选,输入框的 max-length | [双向绑定](#双向绑定) ||
-| delay | `number` | 300 | 可选,debounceTime 的延迟 | [基本用法](#基本用法) ||
-| disabled | `boolean` | false | 可选,输入框是否被禁用 | [基本用法](#基本用法) ||
-| autoFocus | `boolean` | false | 可选,输入框是否自动对焦 | [基本用法](#基本用法) ||
-| isKeyupSearch | `boolean` | false | 可选,是否支持输入值立即触发 searchFn | [基本用法](#基本用法) ||
-| iconPosition | `string` | 'right' | 可选,搜索图标位置,有两种选择'left' / 'right' | [搜索图标左置](#搜索图标左置) ||
-| noBorder | `boolean` | false | 可选,是否显示边框 | [无边框](#无边框) ||
-| cssClass | `string` | '' | 可选,支持传入类名到输入框上 | [双向绑定](#双向绑定) ||
-
-### d-search 事件
-
-| 事件 | 类型 | 说明 | 跳转 Demo |
-| :---------: | :------: | :--------------------: | :---------: |
-| searchFn | `string` | 回车或点击搜索按钮触发的回调函数,返回文本框输入的值 | [基本用法](#基本用法) |
-
diff --git a/packages/devui-vue/docs/en-US/components/select/index.md b/packages/devui-vue/docs/en-US/components/select/index.md
deleted file mode 100644
index 5440b1c7..00000000
--- a/packages/devui-vue/docs/en-US/components/select/index.md
+++ /dev/null
@@ -1,175 +0,0 @@
-# Select 下拉选择框
-
-用于从列表中选择单个或者多个数据
-
-### 基本用法
-
-:::demo 通过`size`:`sm`,`md(默认)`,`lg`来设置`Select`大小,通过`overview`:`underlined`设置只有下边框样式
-
-```vue
-
-
- Small
-
-
- Middle
-
-
- Large
-
-
- Underlined
-
-
-
-
-
-```
-:::
-
-#### 多选
-
-:::demo 通过`multiple`:`true`来开启多选
-
-```vue
-
-
-
-
-
-```
-:::
-
-#### 禁用
-
-:::demo 通过`disabled`:`true`来禁用`Select`,通过`option-disabled-key`来设置单个选项禁用,比如设置`disabled`字段,则对象上disabled为`true`时不可选择
-
-```vue
-
-
-
-
-
-
-
-
-
-
-```
-:::
-
-#### 可清空
-
-:::demo 通过`allow-clear`:`true`来设置`Select`可清空
-
-```vue
-
-
-
-
-
-
-
-
-```
-:::
diff --git a/packages/devui-vue/docs/en-US/components/slider/index.md b/packages/devui-vue/docs/en-US/components/slider/index.md
deleted file mode 100644
index 171e2e5b..00000000
--- a/packages/devui-vue/docs/en-US/components/slider/index.md
+++ /dev/null
@@ -1,128 +0,0 @@
-# Slider 滑动输入条
-
-滑动输入条
-
-### 何时使用
-
-当用户需要在数值区间内进行选择时使用
-
-### 基本用法
-
-
-
-
-
-### 带有输入框的滑动组件
-
-
-
-
-
-### 可设置 Step 的滑动组件
-
-
-
-
-
-```html
-
-
-
-
-
-
-
-
-
-
-```
-
-### 禁止输入态
-
-
-
-
-
-```html
-
-
-
-
-```
-
-
-
-### API
-
-d-slider 参数
-
-| 参数 | 类型 | 默认 | 说明 | 跳转 |
-| --------- | ------- | ----- | ------------------------------------------------------------------- | ---- |
-| max | number | 100 | 可选,滑动输入条的最大值 |[基本用法](#基本用法) |
-| min | number | 0 | 可选,滑动输入条的最小值 |[基本用法](#基本用法) |
-| step | number | 1 | 可选,滑动输入条的步长,取值必须大于等于1,且必须可被(max-min)整除 |[基本用法](#可设置Step的滑动组件) |
-| disabled | boolean | false | 可选,值为 true 时禁止用户输入 |[基本用法](#禁止输入态) |
-| showInput | boolean | false | 可选,值为 true 显示输入框 |[基本用法](#带有输入框的滑动组件) |
-
diff --git a/packages/devui-vue/docs/en-US/components/status/index.md b/packages/devui-vue/docs/en-US/components/status/index.md
deleted file mode 100644
index 4f0996af..00000000
--- a/packages/devui-vue/docs/en-US/components/status/index.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# Status 状态
-
-传达交互结果的组件。
-
-### 何时使用
-
-表示一个任务的执行结果时使用。
-
-### 基本用法
-Success
-Error
-Warning
-Initial
-Waiting
-Running
-Invalid
-
-```html
-Success
-Error
-Warning
-Initial
-Waiting
-Running
-Invalid
-```
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/sticky/index.md b/packages/devui-vue/docs/en-US/components/sticky/index.md
deleted file mode 100644
index e3acf7c0..00000000
--- a/packages/devui-vue/docs/en-US/components/sticky/index.md
+++ /dev/null
@@ -1,139 +0,0 @@
-# sticky 便贴
-
-### 何时使用
-当用户在滚动屏幕时,需要某个区域内容在段落或者浏览器可视区域可见时。
-
-### 基本用法
-
-:::demo 默认容器为父元素
-
-```vue
-
-
-
-
-
-
-```
-:::
-
-### 指定容器
-
-:::demo
-
-```vue
-
-
-
-
-
-```
-:::
-
-
-### 指定滚动容器
-
-:::demo
-
-```vue
-
-
-
-
-
-
-```
-:::
-
-
-### API
-
-| 参数 | 类型 | 默认 | 说明 | 跳转 Demo | 全局配置项 |
-| :---------: | :------: | :-------: | :----------------------- | --------------------------------- | --------- |
-| zIndex | `number` | -- | 可选,指定包裹层的 z-index,用于浮动的时候控制 z 轴的叠放 | [基本用法](#基本用法) ||
-| container | `Element` | 父容器 | 可选,触发的容器,可不同于父容器 | [指定容器](#指定容器) ||
-| view | `{top?:number,bottom?:number}` | {top:0,bottom:0} | 可选,用于可视区域的调整,比如顶部有固定位置的头部等,数值对应被遮挡的顶部或底部的高度 | [基本用法](#基本用法) ||
-| scrollTarget | `Element` | document.documentElement | 可选,设置要发生滚动的容器,一般为滚动条所在容器,为主页面的滚动条时候可以不设置 | [指定滚动容器](#指定滚动容器) ||
-
-
-### d-sticky 事件
-
-| 事件 | 类型 | 说明 | 跳转 Demo |
-| :---------: | :------: | :--------------------: | :---------: |
-| statusChange | `string` | 可选,状态变化的时候触发,值为变化后的状态值 | [基本用法](#基本用法) |
-
diff --git a/packages/devui-vue/docs/en-US/components/switch/index.md b/packages/devui-vue/docs/en-US/components/switch/index.md
deleted file mode 100644
index 5845385f..00000000
--- a/packages/devui-vue/docs/en-US/components/switch/index.md
+++ /dev/null
@@ -1,66 +0,0 @@
-# Switch 开关
-
-开/关切换组件。
-
-### 何时使用
-
-当两种状态需要来回切换控制时,比如启用/禁用。
-
-### 基本用法
-
-
-
-#### Small
-
-
-
-
-
-
-
-
-#### Middle
-
-
-
-
-
-
-
-
-
-
-
-
-#### Large
-
-
-
-
-
-```html
-
-
-
-
-```
-
-
diff --git a/packages/devui-vue/docs/en-US/components/tabs/index.md b/packages/devui-vue/docs/en-US/components/tabs/index.md
deleted file mode 100644
index 1fe14767..00000000
--- a/packages/devui-vue/docs/en-US/components/tabs/index.md
+++ /dev/null
@@ -1,7 +0,0 @@
-# Tabs 选项卡切换
-
-选项卡切换组件。
-
-### 何时使用
-
-用户需要通过平级的区域将大块内容进行收纳和展现,保持界面整洁。
diff --git a/packages/devui-vue/docs/en-US/components/tag-input/index.md b/packages/devui-vue/docs/en-US/components/tag-input/index.md
deleted file mode 100644
index 80bd047c..00000000
--- a/packages/devui-vue/docs/en-US/components/tag-input/index.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# TagInput 标签输入框
-
-输入标签组件。
-
-### 何时使用
-
-当用户需要输入多个标签时。
-
-### 基本用法
-
-
-
-```html
-
-```
-
-
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/components/toast/index.md b/packages/devui-vue/docs/en-US/components/toast/index.md
deleted file mode 100644
index 2218666a..00000000
--- a/packages/devui-vue/docs/en-US/components/toast/index.md
+++ /dev/null
@@ -1,611 +0,0 @@
-# Toast 全局通知
-
-全局信息提示组件。
-
-### 何时使用
-
-当需要向用户全局展示提示信息时使用,显示数秒后消失。
-
-### 基本用法
-
-common 时不展示图标。
-
-
-
-```html
-
-```
-
-```ts
-import { defineComponent, ref } from 'vue'
-
-export default defineComponent({
- setup() {
- const msgs = ref([])
-
- function showToast(type: any) {
- switch (type) {
- case 'link':
- msgs.value = [
- { severity: 'info', summary: 'Relative', detail: `Back to Home Page ` },
- { severity: 'info', summary: 'Absolute', content: 'slot:customTemplate', myInfo: 'Devui' }
- ]
- break
- case 'multiple':
- msgs.value = [
- {
- severity: 'info',
- summary: 'Summary',
- content: 'This is a test text. This is a test text. This is a test text.'
- },
- {
- severity: 'info',
- summary: 'Summary',
- content: 'This is a test text. This is a test text. This is a test text.'
- }
- ]
- break
- case 'noTitle':
- msgs.value = [{ severity: 'warn', content: 'This is a test text. This is a test text. This is a test text.' }]
- break
- case 'plainText':
- msgs.value = [{ severity: 'info', content: 'data:' }]
- break
- default:
- msgs.value = [
- {
- severity: type,
- summary: 'Summary',
- content: 'This is a test text. This is a test text. This is a test text.'
- }
- ]
- }
- }
-
- return {
- msgs,
- showToast
- }
- }
-})
-```
-
-### 超时时间
-
-当设置超时时间、没有标题时,则不展示标题和关闭按钮。
-
-
-
- Success
- Warn
- Error
- common
-
-
-```html
-
-
- Success
- Warn
- Error
- common
-
-```
-
-```ts
-import { defineComponent, ref } from 'vue'
-
-export default defineComponent({
- setup() {
- const msgs = ref([])
-
- function showToast(type: any) {
- switch (type) {
- case 'error':
- msgs.value = [{ severity: type, content: 'This is a test text. This is a test text. This is a test text.' }]
- break
- case 'common':
- msgs.value = [{ severity: type, content: 'This is a test text. This is a test text. This is a test text.' }]
- break
- default:
- msgs.value = [
- {
- severity: type,
- summary: 'Summary',
- content: 'This is a test text. This is a test text. This is a test text.'
- }
- ]
- }
- }
-
- return {
- msgs,
- showToast
- }
- }
-})
-```
-
-### 自定义样式
-
-
-
-
-
-```html
-
-```
-
-```scss
-.custom-class {
- .devui-toast-item-container {
- color: #252b3a;
- background-color: #ffffff;
-
- .devui-toast-icon-close {
- top: 10px;
- right: 13px;
-
- & i.icon {
- color: #252b3a !important;
- }
- }
-
- .devui-toast-image {
- top: 15px;
- }
-
- .devui-toast-message {
- line-height: 23px;
-
- .devui-toast-title {
- font-size: 16px;
- }
-
- p {
- font-size: 14px;
- }
- }
- }
-}
-```
-
-```ts
-import { defineComponent, ref } from 'vue'
-
-export default defineComponent({
- setup() {
- const msgs = ref([])
-
- function showToast() {
- msgs.value = [
- {
- severity: 'success',
- summary: 'Success',
- content: 'This is a test text. This is a test text. This is a test text.'
- }
- ]
- }
-
- return {
- msgs,
- showToast
- }
- }
-})
-```
-
-### 每个消息使用单独的超时时间
-
-当设置超时时间模式为 single 时,每个消息使用自身的 life 作为超时时间,如果未设置则按 severity 判断,severity 也未设置时默认超时时间为 5000 毫秒。
-
-
-
-```html
-
-```
-
-```ts
-import { defineComponent, ref } from 'vue'
-
-export default defineComponent({
- setup() {
- const msgs = ref([])
-
- function showToast() {
- msgs.value = [
- { life: 3000, summary: 'Summary', content: 'This is a test text. This is a test text. This is a test text.' },
- {
- life: 6000,
- severity: 'info',
- summary: 'Summary',
- content: 'This is a test text. This is a test text. This is a test text.'
- },
- {
- severity: 'success',
- summary: 'Success',
- content: 'This is a test text. This is a test text. This is a test text.'
- },
- { severity: 'warn', summary: 'Warn', content: 'This is a test text. This is a test text. This is a test text.' }
- ]
- }
-
- return {
- msgs,
- showToast
- }
- }
-})
-```
-
-### 服务方式调用
-
-使用服务的方式创建 toast 全局通知。
-
-click me show simplest toast!
-click me show customer toast!
-click me close customer toast!
-only close first customer toast!
-
-```html
-click me show simplest toast!
-click me show customer toast!
-click me close customer toast!
-only close first customer toast!
-```
-
-```ts
-import { defineComponent, ref } from 'vue'
-import { ToastService } from 'devui/toast'
-
-export default defineComponent({
- setup() {
- const results = ref()
-
- function openToast2() {
- results.value = ToastService.open({
- value: [
- { severity: 'info', summary: 'summary', content: '1. I am content' },
- { severity: 'error', summary: 'summary', content: '2. I am content' },
- { severity: 'error', summary: 'summary', content: '3. I am content' }
- ],
- sticky: true,
- style: { width: '600px', color: 'red' },
- styleClass: 'myCustom-toast',
- life: 5000,
- lifeMode: 'global',
- /*
- 接收发射过来的数据
- */
- onCloseEvent(value: any) {
- console.log('closeEvent', value)
- },
- onValueChange(value: any) {
- console.log('valueChange', value)
- }
- })
-
- console.log('results', results.value)
-
- isShow.value = true
- }
-
- function closeToast2() {
- results.value.toastInstance.close()
- isShow.value = false
- }
-
- function closeToast3() {
- /*
- 1.可以根据指定下标关闭 results.value.toastInstance.close(0);
- 2.可以根据value对象去关闭,作用跟1是等同的,如下所示:
- */
- results.value.toastInstance.close({ severity: 'info', summary: 'summary', content: '1. I am content' })
- }
-
- return {
- isShow,
- openToast,
- openToast2,
- closeToast2,
- closeToast3
- }
- }
-})
-```
-
-### Toast Api
-
-
-
-### Toast Event
-
-
-
-### 接口 & 类型定义
-
-Message
-
-```ts
-export interface Message {
- severity?: string // 预设值有 common、success、error、warn、info,超时时间参见 life 说明,未设置或非预设值时超时时间为 5000 毫秒,warn 和 error 为 10000 毫秒
- summary?: string // 消息标题。当设置超时时间,未设置标题时,不展示标题和关闭按钮
- detail?: string // 消息内容,推荐使用content替换
- content?: string | `slot:${string}` | (message: Message) => ReturnType // 消息内容,支持纯文本和插槽,推荐使用
- life?: number // 单个消息超时时间,需设置 lifeMode 为 single 。每个消息使用自己的超时时间,开启该模式却未设置时按 severity 判断超时时间
- id?: any // 消息ID
-}
-```
-
-### Service 引入方式
-
-```ts
-import { ToastService } from 'devui'
-```
-
-### Service 使用
-
-```ts
-// 方式 1,局部引入 ToastService
-ToastService.open({ xxx })
-
-// 方式2,全局属性
-app.config.globalProperties.$toastService.open({ xxx })
-```
-
-### Service Api
-
-
-
-
-
-
diff --git a/packages/devui-vue/docs/en-US/components/transfer/index.md b/packages/devui-vue/docs/en-US/components/transfer/index.md
deleted file mode 100644
index 988204fe..00000000
--- a/packages/devui-vue/docs/en-US/components/transfer/index.md
+++ /dev/null
@@ -1,224 +0,0 @@
-# Transfer 穿梭框
-
-双栏穿梭选择框。
-
-### 何时使用
-
-需要在多个可选项中进行多选时。穿梭选择框可用只管的方式在两栏中移动数据,完成选择行为。其中左边一栏为source,右边一栏为target。最终返回两栏的数据,提供给开发者使用。
-
-### 基本用法
-
-穿梭框基本用法。
-
-
-
-
-
-```html
-
-
-```
-
-```ts
-import {defineComponent, reactive} from 'vue'
- type TData = {
- id: number
- age: number
- value: string
- disabled?: boolean
- }
- export default defineComponent({
- setup() {
- const options = reactive({
- titles: ['sourceHeader', 'targetHeader'],
- source: [
- {
- key: '北京',
- value: '北京',
- disabled: false
- },
- {
- key: '上海',
- value: '上海',
- disabled: true
- },
- {
- key: '广州',
- value: '广州',
- disabled: false
- },
- {
- key: '深圳',
- value: '深圳',
- disabled: false
- },
- {
- key: '成都',
- value: '成都',
- disabled: false
- },
- {
- key: '武汉',
- value: '武汉',
- disabled: false
- },
- {
- key: '西安',
- value: '西安',
- disabled: false
- },
- {
- key: '福建',
- value: '福建',
- disabled: false
- },
- {
- key: '大连',
- value: '大连',
- disabled: false
- },
- {
- key: '重庆',
- value: '重庆',
- disabled: false
- }
- ],
- target: [
- {
- key: '南充',
- value: '南充',
- disabled: false
- },
- {
- key: '广元',
- value: '广元',
- disabled: true
- },
- {
- key: '绵阳',
- value: '绵阳',
- disabled: false
- }
- ],
- isSearch: true,
- modelValues: ['深圳', '成都', '绵阳']
- })
- return {
- options
- }
- }
- })
-```
-
-### 参数
-
-| **参数** | **类型** | **默认** | **说明** | **跳转 Demo** |
-| ------------------ | ------------------------------------------------------------ | ------------------------- | ------------------------------------------------------------ | ---------------------------- |
-| sourceOption | Array | [] | 可选参数,穿梭框源数据 | [基本用法](#基本用法) |
-| targetOption | Array | [] | 可选参数,穿梭框目标数据 | [基本用法](#基本用法) |
-| titles | Array | [] | 可选参数,穿梭框标题 | [基本用法](#基本用法) |
-| height | string | 320px | 可选参数,穿梭框高度 | [基本用法](#基本用法) |
-| isSearch | boolean | true | 可选参数,是否可以搜索 | [基本用法](#基本用法) |
-| disabled | boolean | false | 可选参数 穿梭框禁止使用 | [基本用法](#基本用法) |
diff --git a/packages/devui-vue/docs/en-US/components/upload/index.md b/packages/devui-vue/docs/en-US/components/upload/index.md
deleted file mode 100644
index b2f8d8c2..00000000
--- a/packages/devui-vue/docs/en-US/components/upload/index.md
+++ /dev/null
@@ -1,1297 +0,0 @@
-# Upload
-
-File upload component。
-
-### When to use
-
-When you need to upload files to the back-end server。
-
-### Basic usage
-
-Single file upload, drag file upload, prohibit upload。
-
-Basic Usage
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-Dragdrop
-
-:::demo
-
-```vue
-
-
-
- Upload
-
-
-
-```
-
-:::
-
-Disabled
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-### Multiple file upload
-
-Multi-file upload, support drag file upload, prohibit upload。
-
-Basic Usage
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-Upload Directory
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-Dragdrop
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-Disabled
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-### Auto upload
-
-Set up automatic upload via autoUpload。
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-### customize
-
-Customize the upload button, set the selected file list template through slot preloadFiles, and set the uploaded file list template through slot uploadedFiles。
-
-:::demo
-
-```vue
-
-
-
-
-
-
-
-
- {{ fileUploader.file.name }}
-
-
-
- preLoad
- Uploading}
- Uploaded
- Upload Failed
-
-
-
- slotProps.deleteFile(fileUploader.filePath)
- "
- >
- Delete
-
-
-
-
-
-
-
-
-
-
- {{ uploadedFile.name }}
-
-
- Uploaded
-
-
- slotProps.deleteFile(uploadedFile)"
- >
- Delete
-
-
-
-
-
-
-
-
-
- 自定义上传
-
-
-
-
-
-```
-
-:::
-
-### Dynamic upload parameters
-
-Users can dynamically modify upload parameters through beforeUpload。
-
-:::demo
-
-```vue
-
-
-
-
-```
-
-:::
-
-### Upload from any area
-
-Users can upload files in any area through the default slot。
-:::demo
-
-```vue
-
-
- 选取文件
-
-
-
-
- {{ fileUploader.file.name }}
-
-
-
- preLoad
- Uploading}
- Uploaded
- Upload Failed
-
-
-
- slotProps.deleteFile(event)"
- >
- Delete
-
-
-
-
-
-
-
-
-
-
- {{ uploadedFile.name }}
-
-
- Uploaded
-
-
- slotProps.deleteFile(uploadedFile)"
- >
- Delete
-
-
-
-
-
-
-
-
-
-```
-
-:::
-
-自定义默认 slot,初始显示已上传文件。
-
-:::demo
-
-```vue
-
-
-
-
-
-
-
- 将文件拖到此处,或
- 点击上传
-
-
-
-
-
-
- {{ fileUploader.file.name }}
-
-
-
- preLoad
- Uploading
- Uploaded
- Upload Failed
-
-
-
- slotProps.deleteFile(event)"
- >
- Delete
-
-
-
-
-
-
-
-
-
-
- {{ uploadedFile.name }}
-
-
- Uploaded
-
-
- slotProps.deleteFile(uploadedFile)"
- >
- Delete
-
-
-
-
-
-
-
-
-
-
-```
-
-:::
-
-### API
-
-d-single-upload 参数
-
-| **参数** | **类型** | **默认** | 说明 | **跳转 Demo** |
-| ---------------------- | --------------------------------- | ---------- | ---------------------------------------------------------------------------------------- | --------------------- |
-| fileOptions | [IFileOptions](#ifileoptions) | -- | 必选,待上传文件配置 | [基本用法](#基本用法) |
-| filePath | `string` | -- | 文件路径 | [基本用法](#基本用法) |
-| uploadOptions | [IUploadOptions](#iuploadoptions) | \-- | 必选,上传配置 | [基本用法](#基本用法) |
-| autoUpload | `boolean` | false | 可选,是否自动上传 | [基本用法](#基本用法) |
-| placeholderText | `string` | '选择文件' | 可选,上传输入框中的 Placeholder 文字 | [基本用法](#基本用法) |
-| uploadText | `string` | '上传' | 可选,上传按钮文字 | [基本用法](#基本用法) |
-| uploadedFiles | `Array` | [] | 可选,获取已上传的文件列表 | [基本用法](#基本用法) |
-| withoutBtn | `boolean` | false | 可选,是否舍弃按钮 | [基本用法](#基本用法) |
-| enableDrop | `boolean` | false | 可选,是否支持拖拽 | [基本用法](#基本用法) |
-| beforeUpload | `boolean Promise ` | \-- | 可选,上传前的回调,通过返回`true` or `false` ,控制文件是否上传,参数为文件信息及上传配置 | [基本用法](#基本用法) |
-| dynamicUploadOptionsFn | [IUploadOptions](#iuploadoptions) | \-- | 为文件动态设置自定义的上传参数, 参数为当前选中文件及`uploadOptions`的值 | [基本用法](#基本用法) |
-| disabled | `boolean` | false | 可选,是否禁用上传组件 | [基本用法](#基本用法) |
-| showTip | `boolean` | false | 可选,是否显示上传提示信息 | [自动上传](#自动上传) |
-
-d-single-upload 事件
-
-| 参数 | 类型 | 说明 | 跳转 Demo |
-| ----------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| fileOver | `EventEmitter` | 支持拖拽上传时,文件移动到可拖放区域触发事件,可拖动的元素移出放置目标时返回`false`,元素正在拖动到放置目标时返回`true` | [基本用法](#基本用法) |
-| fileDrop | `EventEmitter` | 支持拖拽上传时,当前拖拽的文件列表回调,单文件上传默认返回第一个文件 | [基本用法](#基本用法) |
-| successEvent | `EventEmitter>` | 上传成功时的回调函数,返回文件及 xhr 的响应信息 | [基本用法](#基本用法) |
-| errorEvent | `EventEmitter<{file: File; response: any}>` | 上传错误时的回调函数,返回上传失败的错误信息 | [基本用法](#基本用法) |
-| deleteUploadedFileEvent | `EventEmitter` | 删除上传文件的回调函数,返回删除文件的路径信息 | [基本用法](#基本用法) |
-| fileSelect | `EventEmitter` | 文件选择后的回调函数,返回已选择文件信息 | [基本用法](#基本用法) |
-
-d-multiple-upload 参数
-
-| **参数** | **类型** | **默认** | 说明 | **跳转 Demo** |
-| ---------------------- | --------------------------------- | -------------- | ---------------------------------------------------------------------------------------- | ------------------------- |
-| fileOptions | [IFileOptions](#ifileoptions) | -- | 必选,待上传文件配置 | [多文件上传](#多文件上传) |
-| filePath | `string` | -- | 文件路径 | [多文件上传](#多文件上传) |
-| uploadOptions | [IUploadOptions](#iuploadoptions) | \-- | 必选,上传配置 | [多文件上传](#多文件上传) |
-| autoUpload | `boolean` | false | 可选,是否自动上传 | [自动上传](#自动上传) |
-| placeholderText | `string` | '选择多个文件' | 可选,上传输入框中的 Placeholder 文字 | [基本用法](#基本用法) |
-| uploadText | `string` | '上传' | 可选,上传按钮文字 | [基本用法](#基本用法) |
-| uploadedFiles | `Array` | [] | 可选,获取已上传的文件列表 | [多文件上传](#多文件上传) |
-| withoutBtn | `boolean` | false | 可选,是否舍弃按钮 | [自定义](#自定义) |
-| enableDrop | `boolean` | false | 可选,是否支持拖拽 | [多文件上传](#多文件上传) |
-| beforeUpload | `boolean Promise` | \-- | 可选,上传前的回调,通过返回`true` or `false` ,控制文件是否上传,参数为文件信息及上传配置 | [多文件上传](#多文件上传) |
-| dynamicUploadOptionsFn | [IUploadOptions](#iuploadoptions) | \-- | 为文件动态设置自定义的上传参数, 参数为当前选中文件及`uploadOptions`的值 | [多文件上传](#多文件上传) |
-| disabled | `boolean` | false | 可选,是否禁用上传组件 | [多文件上传](#多文件上传) |
-| showTip | `boolean` | false | 可选,是否显示上传提示信息 | [多文件上传](#多文件上传) |
-| setCustomUploadOptions | [IUploadOptions](#iuploadoptions) | -- | 为每个文件设置自定义的上传参数, 参数为当前选中文件及`uploadOptions`的值 | [自定义](#自定义) |
-
-d-multiple-upload 事件
-
-| 参数 | 类型 | 说明 | 跳转 Demo |
-| ----------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------- |
-| fileOver | `EventEmitter` | 支持拖拽上传时,文件移动到可拖放区域触发事件,可拖动的元素移出放置目标时返回`false`,元素正在拖动到放置目标时返回`true` | [多文件上传](#多文件上传) |
-| fileDrop | `EventEmitter` | 支持拖拽上传时,当前拖拽的文件列表回调,单文件上传默认返回第一个文件 | [多文件上传](#多文件上传) |
-| successEvent | `EventEmitter>` | 上传成功时的回调函数,返回文件及 xhr 的响应信息 | [多文件上传](#多文件上传) |
-| errorEvent | `EventEmitter<{file: File; response: any}>` | 上传错误时的回调函数,返回上传失败的错误信息 | [多文件上传](#多文件上传) |
-| deleteUploadedFileEvent | `EventEmitter` | 删除上传文件的回调函数,返回删除文件的路径信息 | [多文件上传](#多文件上传) |
-| fileSelect | `EventEmitter` | 文件选择后的回调函数,返回已选择文件信息 | [多文件上传](#多文件上传) |
-
-### slot
-
-| name | 默认 | 说明 | 跳转 Demo |
-| ------------- | ---- | ----------------------------------------------------------------------------- | ----------------- |
-| preloadFiles | -- | 可选,用于创建自定义 已选择文件列表模板,参数为 `{fileUploaders, deleteFile}` | [自定义](#自定义) |
-| uploadedFiles | -- | 可选,用于创建自定义 已上传文件列表模板,参数为 `{uploadedFiles, deleteFile}` | [自定义](#自定义) |
-
-### 接口 & 类型定义
-
-### IUploadOptions
-
-```typescript
-export class IUploadOptions {
- // 上传接口地址
- uri: string
- // http 请求方法
- method?: string
- // 上传文件大小限制
- maximumSize?: number
- // 自定义请求headers
- headers?: { [key: string]: any }
- // 认证token
- authToken?: string
- // 认证token header标示
- authTokenHeader?: string
- // 上传额外自定义参数
- additionalParameter?: { [key: string]: any }
- // 上传文件字段名称,默认file
- fileFieldName?: string
- // 多文件上传,是否检查文件重名,设置为true,重名文件不会覆盖,否则会覆盖上传
- checkSameName?: boolean
- // 指示了是否该使用类似cookies,authorization headers(头部授权)或者TLS客户端证书这一类资格证书来创建一个跨站点访问控制(cross-site Access-Control)请求
- withCredentials?: boolean
- // 手动设置返回数据类型
- responseType?: 'arraybuffer' | 'blob' | 'json' | 'text'
-}
-```
-
-### IFileOptions
-
-```typescript
-export class IFileOptions {
- // 规定能够通过文件上传进行提交的文件类型,例如 accept: '.xls,.xlsx,.pages,.mp3,.png'
- accept?: string
- // 输入字段可选择多个值
- multiple?: boolean
- // 是否允许用户选择文件目录,而不是文件
- webkitdirectory?: boolean
-}
-```
diff --git a/packages/devui-vue/docs/en-US/design.md b/packages/devui-vue/docs/en-US/design.md
deleted file mode 100644
index f936956a..00000000
--- a/packages/devui-vue/docs/en-US/design.md
+++ /dev/null
@@ -1 +0,0 @@
-# Design
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/theme.md b/packages/devui-vue/docs/en-US/theme.md
deleted file mode 100644
index b29f0a86..00000000
--- a/packages/devui-vue/docs/en-US/theme.md
+++ /dev/null
@@ -1 +0,0 @@
-# Theme
\ No newline at end of file
diff --git a/packages/devui-vue/docs/en-US/version.md b/packages/devui-vue/docs/en-US/version.md
deleted file mode 100644
index e04a043b..00000000
--- a/packages/devui-vue/docs/en-US/version.md
+++ /dev/null
@@ -1 +0,0 @@
-# Version
\ No newline at end of file
--
Gitee
From cba50a2d852034113ecaa20f4da22c279e2d0b9a Mon Sep 17 00:00:00 2001
From: xiaojiujiu <3507440900@qq.com>
Date: Tue, 9 Nov 2021 22:03:55 +0800
Subject: [PATCH 5/8] =?UTF-8?q?docs(tooltip:=20=E4=BF=AE=E6=94=B9=E5=9B=BD?=
=?UTF-8?q?=E9=99=85=E5=8C=96=E6=96=87=E6=A1=A3)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../docs/en-US/components/tooltip/index.md | 29 ++++++++++---------
1 file changed, 16 insertions(+), 13 deletions(-)
diff --git a/packages/devui-vue/docs/en-US/components/tooltip/index.md b/packages/devui-vue/docs/en-US/components/tooltip/index.md
index 3faa69f2..aa45d39c 100644
--- a/packages/devui-vue/docs/en-US/components/tooltip/index.md
+++ b/packages/devui-vue/docs/en-US/components/tooltip/index.md
@@ -1,6 +1,9 @@
# Tooltip
-Text prompt component。
+Import into module.
+```ts
+import { TooltipModule } from 'devui/tooltip';
+```
### When to use
@@ -10,27 +13,27 @@ The user moves the mouse to the text, and it is used when further prompts are ne
:::demo We can control the display position of the tooltip by controlling the attribute `position`. There are 4 values for `position`, which are `top`, `right`, `bottom`, and `left`. Control the content of the tooltip prompt box through the attribute `content`。
-上面
+top
-右面
+right
-下面
+bottom
-左面
+left
```vue
- 上面
+ top
- 下面
+ bottom
- 左面
+ left
- 右面
+ right
```
@@ -93,8 +96,8 @@ The mouse will be triggered after moving in for more than [mouseEnterDelay] mill
| parameter | type | default | description | jump Demo | Global configuration items |
| :---------: | :------: | :-------: | :----------------------- | --------------------------------- | --------- |
-| content | `string|DOMString` | -- | Required, tooltip displays content | [基本用法](#基本用法) ||
-| position | `PositionType | PositionType[]` | ['top', 'right', 'bottom', 'left'] | Optional, tooltip display position | [基本用法](#基本用法) ||
+| content | `string|DOMString` | -- | Required, tooltip displays content | [Basic Usage](#demo#basic-usage) ||
+| position | `PositionType | PositionType[]` | ['top', 'right', 'bottom', 'left'] | Optional, tooltip display position | [Basic Usage](#demo#basic-usage) ||
| showAnimation | `boolean` | true | Optional, whether to show the wipe out animation | |✔|
-| mouseEnterDelay | `number` | 150 | Optional, how long is the delay before the Tooltip is displayed after the mouse moves in, the unit is ms | [基本用法](#延时触发) ||
-| mouseLeaveDelay | `number` | 100 | Optional, after the mouse is moved out, how long is the delay before the Tooltip is hidden, the unit is ms | [基本用法](#延时触发) ||
+| mouseEnterDelay | `number` | 150 | Optional, how long is the delay before the Tooltip is displayed after the mouse moves in, the unit is ms | [Delay Trigger](#delay-trigger) ||
+| mouseLeaveDelay | `number` | 100 | Optional, after the mouse is moved out, how long is the delay before the Tooltip is hidden, the unit is ms | [Delay Trigger](#delay-trigger) ||
--
Gitee
From 7b6cbd3ddfc058150cce6bb6e5ce2d229e66f6e3 Mon Sep 17 00:00:00 2001
From: xiaojiujiu <3507440900@qq.com>
Date: Tue, 9 Nov 2021 23:32:08 +0800
Subject: [PATCH 6/8] =?UTF-8?q?docs(tooltip:=20=E5=88=A0=E9=99=A4=E5=9B=BD?=
=?UTF-8?q?=E9=99=85=E5=8C=96=E6=96=87=E4=BB=B6)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../docs/en-US/components/tooltip/index.md | 103 ------------------
1 file changed, 103 deletions(-)
delete mode 100644 packages/devui-vue/docs/en-US/components/tooltip/index.md
diff --git a/packages/devui-vue/docs/en-US/components/tooltip/index.md b/packages/devui-vue/docs/en-US/components/tooltip/index.md
deleted file mode 100644
index aa45d39c..00000000
--- a/packages/devui-vue/docs/en-US/components/tooltip/index.md
+++ /dev/null
@@ -1,103 +0,0 @@
-# Tooltip
-
-Import into module.
-```ts
-import { TooltipModule } from 'devui/tooltip';
-```
-
-### When to use
-
-The user moves the mouse to the text, and it is used when further prompts are needed。
-
-### Basic usage
-
-:::demo We can control the display position of the tooltip by controlling the attribute `position`. There are 4 values for `position`, which are `top`, `right`, `bottom`, and `left`. Control the content of the tooltip prompt box through the attribute `content`。
-
-top
-
-right
-
-bottom
-
-left
-
-```vue
-
-
- top
-
-
- bottom
-
-
- left
-
-
- right
-
-
-```
-
-```css
-.example {
- height: 50px;
- width: 60px;
- background: cornflowerblue;
- margin-top: 30px;
-}
-```
-:::
-
-### Delay trigger
-
-The mouse will be triggered after moving in for more than [mouseEnterDelay] milliseconds to prevent flashing caused by the user accidentally swiping. The default value is 150 milliseconds; after the mouse is moved out, the toolTip component will be hidden after [mouseLeaveDelay] milliseconds. The default value Is 100 milliseconds。
-
-:::demo Use the `mouseEnterDelay` property to control the `delay display` of the tooltip prompt box (the default is 100ms), and the `mouseLeaveDelay` property to control the `delay disappearing` of the tooltip prompt box (the default is 150ms)
-MouseEnter delay 500ms
-
-MouseLeave delay 1000ms
-```vue
-
-
- MouseEnter delay 500ms
-
-
-
- MouseLeave delay 1000ms
-
-
-```
-
-```css
-.customCss {
- width: fit-content;
- height: 30px;
- padding: 10px;
- display: flex;
- justify-content: center;
- align-items: center;
- color: #fff;
- background: cornflowerblue;
-}
-.customCss-leave {
- width: fit-content;
- height: 30px;
- padding: 10px;
- display: flex;
- justify-content: center;
- align-items: center;
- color: #252b3a;
- background: #fff;
-}
-```
-:::
-
-### Tooltip Api
-
-| parameter | type | default | description | jump Demo | Global configuration items |
-| :---------: | :------: | :-------: | :----------------------- | --------------------------------- | --------- |
-| content | `string|DOMString` | -- | Required, tooltip displays content | [Basic Usage](#demo#basic-usage) ||
-| position | `PositionType | PositionType[]` | ['top', 'right', 'bottom', 'left'] | Optional, tooltip display position | [Basic Usage](#demo#basic-usage) ||
-| showAnimation | `boolean` | true | Optional, whether to show the wipe out animation | |✔|
-| mouseEnterDelay | `number` | 150 | Optional, how long is the delay before the Tooltip is displayed after the mouse moves in, the unit is ms | [Delay Trigger](#delay-trigger) ||
-| mouseLeaveDelay | `number` | 100 | Optional, after the mouse is moved out, how long is the delay before the Tooltip is hidden, the unit is ms | [Delay Trigger](#delay-trigger) ||
--
Gitee
From 81458d0eb0d79080f0fc64ee1aac5d66c96c9def Mon Sep 17 00:00:00 2001
From: xiaojiujiu <3507440900@qq.com>
Date: Sun, 21 Nov 2021 12:38:57 +0800
Subject: [PATCH 7/8] =?UTF-8?q?fixed:=20#I4H6K3(=E8=A7=A3=E5=86=B3?=
=?UTF-8?q?=E5=9B=BD=E9=99=85=E5=8C=96=E6=98=BE=E7=A4=BA=E9=94=99=E8=AF=AF?=
=?UTF-8?q?)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
packages/devui-vue/docs/en-US/index.md | 43 --------------------------
1 file changed, 43 deletions(-)
delete mode 100644 packages/devui-vue/docs/en-US/index.md
diff --git a/packages/devui-vue/docs/en-US/index.md b/packages/devui-vue/docs/en-US/index.md
deleted file mode 100644
index 4194e11d..00000000
--- a/packages/devui-vue/docs/en-US/index.md
+++ /dev/null
@@ -1,43 +0,0 @@
-# Quick Start
-
-Guide you how to use DevUI in your project
-
-### Vue version
-
-Vue version currently supported ^3.0.0
-
-### 1. Create a project
-
-It is recommended to use @vite/cli to create your project
-
-```shell
-yarn create vite my-vue-app --template vue-ts
-```
-
-### 2. Install
-
-Go to your project folder and use yarn to install DevUI
-
-```shell
-yarn add vue-devui
-
-# 可选,字体图标库, 部分Demo依赖此字体库
-# yarn add @devui-design/icons
-```
-
-### 3. Introduce modules and styles
-
-main.ts
-
-```js
-import DevUI from 'vue-devui'
-import 'vue-devui/style.css'
-
-createApp(App).use(DevUI).mount('#app')
-```
-
-### 4. Start development and debugging
-
-```shell
-yarn dev
-```
\ No newline at end of file
--
Gitee
From 8f18d4683399388193b1698b9c29521bc2c82575 Mon Sep 17 00:00:00 2001
From: xiaojiujiu <3507440900@qq.com>
Date: Sun, 21 Nov 2021 13:06:33 +0800
Subject: [PATCH 8/8] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E5=BF=AB=E9=80=9F?=
=?UTF-8?q?=E5=BC=80=E5=A7=8B=E5=9B=BD=E9=99=85=E5=8C=96=E6=96=87=E4=BB=B6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
packages/devui-vue/docs/en-US/index.md | 78 ++++++++++++++++++++++++++
1 file changed, 78 insertions(+)
create mode 100644 packages/devui-vue/docs/en-US/index.md
diff --git a/packages/devui-vue/docs/en-US/index.md b/packages/devui-vue/docs/en-US/index.md
new file mode 100644
index 00000000..8c2877b1
--- /dev/null
+++ b/packages/devui-vue/docs/en-US/index.md
@@ -0,0 +1,78 @@
+# Quick Start
+
+Guide you how to use DevUI in your project
+
+### Vue version
+
+Vue version currently supported ^3.0.0
+
+### 1. Create a project
+
+It is recommended to use @vite/cli to create your project
+
+```shell
+yarn create vite my-vue-app --template vue-ts
+```
+
+### 2. Install
+
+Go to your project folder and use yarn to install DevUI
+
+```shell
+yarn add vue-devui
+
+# Optional, font icon library, some demos rely on this font library
+# yarn add @devui-design/icons
+# main.ts file introduction
+# import '@devui-design/icons/icomoon/devui-icon.css'
+```
+
+### 3. Import modules and styles
+
+main.ts
+
+```js
+import DevUI from 'vue-devui'
+import 'vue-devui/style.css'
+
+createApp(App).use(DevUI).mount('#app')
+```
+```js
+// On-demand introduction
+// main.ts file
+import { createApp } from 'vue'
+import App from './App.vue'
+
+// Step 1: Introduce a single component
+import { Button } from 'vue-devui'
+// or import Button from 'vue-devui/button'
+// Step 2: Introduce component style
+// 方式一:Manually import component styles
+import 'vue-devui/button/style.css'
+
+// 方式二:Automatically introduce components on demand
+// vite.config.ts file
+// import styleImport from 'vite-plugin-style-import'
+// plugins: [
+// vue(),
+// styleImport({
+// libs: [
+// {
+// libraryName: 'vue-devui',
+// esModule: true,
+// resolveStyle: (name) => `vue-devui/${name}/style`,
+// },
+// ],
+// })
+// ]
+
+createApp(App)
+.use(Button) // Step 3: Use component
+.mount('#app')
+```
+
+### 4. Start development and debugging
+
+```shell
+yarn dev
+```
\ No newline at end of file
--
Gitee