Skip to content

Commit 0f626d0

Browse files
committed
docs: add algolia search
1 parent 5a3433a commit 0f626d0

22 files changed

+180
-102
lines changed

examples/sites/demos/pc/webdoc/develop-demo-en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!--anchor:on-->
22

3-
## Development Example
3+
# Development Example
44

55
This article is based on[Vite](https://cn.vitejs.dev/) Project example to show how to use`TinyVue`components.
66

7-
### Building the Vite project
7+
## Building the Vite project
88

99
Create a`Vite`Works:
1010

@@ -30,7 +30,7 @@ After the browser is started, if the following interface is displayed, it indica
3030

3131
<img src="@demos/resource/vite-vue.png" class="image" style="box-shadow: 0 0 0 1px rgba(0, 0, 0, 0.14)" ><br><br>
3232

33-
### Install and use`TinyVue`Components
33+
## Install and use`TinyVue`Components
3434

3535
Run the following command to install the`Vue 3.0`version of`TinyVue`Component library:
3636

examples/sites/demos/pc/webdoc/develop-demo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!--anchor:on-->
22

3-
## 开发示例
3+
# 开发示例
44

55
本文以 [Vite](https://cn.vitejs.dev/) 工程为例,展示如何使用 `TinyVue` 组件。
66

7-
### 搭建 Vite 项目
7+
## 搭建 Vite 项目
88

99
使用以下命令创建 `Vite` 工程:
1010

@@ -30,7 +30,7 @@ npm run dev
3030

3131
<img src="@demos/resource/vite-vue.png" class="image" style="box-shadow: 0 0 0 1px rgba(0, 0, 0, 0.14)" ><br><br>
3232

33-
### 安装并使用 `TinyVue` 组件
33+
## 安装并使用 `TinyVue` 组件
3434

3535
执行以下命令安装 `Vue 3.0` 版本的 `TinyVue` 组件库 :
3636

examples/sites/demos/pc/webdoc/envpreparation-open-en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
## Environment Preparation
1+
# Environment Preparation
22

33
TinyVue is a`Vue`UI component library, which can also support`Vue 2.0`and`Vue 3.0`.
44

55
Browser compatibility`TinyVue`The latest versions of mainstream browsers are supported: Chrome, Edge, Firefox, Opera, and Safari. No longer supported`Internet Explorer`.
66

7-
### Installing Node.js
7+
## Installing Node.js
88

99
Recommended Installation`v16.13.0`version, if the local`Node.js`, run the following command to check whether the version is correct:
1010

1111
```bash
1212
node -v
1313
```
1414

15-
### Installing Yarn
15+
## Installing Yarn
1616

1717
management`npm`There are two main tools for the package. One is the installation.`Node.js`When it comes`npm`, the other is the faster`yarn`, run the following command to install:
1818

examples/sites/demos/pc/webdoc/envpreparation-open.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
## 环境准备
1+
# 环境准备
22

33
TinyVue 是一个基于 `Vue` 的 UI 组件库,可以同时支持 `Vue 2.0``Vue 3.0`
44

55
浏览器兼容性 `TinyVue` 支持主流浏览器的最新版本:Chrome、Edge、Firefox、Opera、Safari 不支持 IE 浏览器
66

7-
### 安装 Node.js
7+
## 安装 Node.js
88

99
推荐安装 `v16.13.0` 及以上版本,如果本地已经安装了 `Node.js`,可以通过以下命令检查版本是否正确:
1010

1111
```bash
1212
node -v
1313
```
1414

15-
### 安装 Yarn
15+
## 安装 Yarn
1616

1717
管理 `npm` 包的工具主要有两种,一种是安装 `Node.js` 时自带的 `npm` ,另一种是速度更快的 `yarn`,通过以下命令安装:
1818

examples/sites/demos/pc/webdoc/faq-en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## FAQ
1+
# FAQ
22

3-
### 1、Popup element misaligned and flipped in wujie micro front-end
3+
## 1、Popup element misaligned and flipped in wujie micro front-end
44

55
_Reason:_ The popup element has a boundary detection logic, and in sub applications, the width and height of 'window' may be much smaller than that of the viewport,
66
therefore, it can misjudge boundaries, leading to issues such as flipping and misalignment.

examples/sites/demos/pc/webdoc/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## 常见问题
1+
# 常见问题
22

3-
### 1、弹出元素在无界微前端中发生错位、翻转
3+
## 1、弹出元素在无界微前端中发生错位、翻转
44

55
_原因:_ 弹出类的元素,存在一个边界检测逻辑,在子应用中,`window` 的宽高可能会比视口小得多,
66
因此会错误判断边界,导致翻转和错位等问题。

examples/sites/demos/pc/webdoc/form-valid-en.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
## Form Verification Configuration
1+
# Form Verification Configuration
22

33
<br>
44
<br>
55

66
Form validation is based on`async-validator`Encapsulated, mainly used`validate`Function and`rules`Configuration rules of the.
77

8-
### API
8+
## API
99

10-
#### validate
10+
### validate
1111

1212
When submitting a form, the system verifies the fields to be verified in the entire form to obtain the verification result. The following is an example:
1313

@@ -21,11 +21,11 @@ Parameter description:
2121

2222
- `error`: Array type, including fields that do not pass the verification.
2323

24-
### Rules
24+
## Rules
2525

2626
Used to set the verification rules for each field to be verified in the form, including the verification type of each field, whether it is mandatory, and the prompt information indicating that the verification fails.
2727

28-
#### type
28+
### type
2929

3030
through`type`Set the verification type of the field to be verified. With this function, we can verify some specific fields without writing regular rules and making judgments. The following is an example:
3131

@@ -67,15 +67,15 @@ The values that can be set are as follows:
6767

6868
- `any`: any type
6969

70-
#### required
70+
### required
7171

7272
`required`The attribute value of is of the Boolean type, which is used to set whether a field is mandatory, that is, non-empty verification.
7373

7474
- `true`: Set to`true`, indicates that the field is mandatory and the label is marked with a red asterisk \*.
7575

7676
- `false`: default value, indicating that the field is not mandatory. The label does not contain red asterisks \*.
7777

78-
#### pattern
78+
### pattern
7979

8080
Configure the regular expression used to verify the field. The following is an example:
8181

@@ -85,7 +85,7 @@ rules: {
8585
}
8686
```
8787

88-
#### min
88+
### min
8989

9090
For the string and array types, the lengths are compared. For the number type, the number cannot be less than`min`. An example is as follows:
9191

@@ -95,7 +95,7 @@ rules: {
9595
}
9696
```
9797

98-
#### max
98+
### max
9999

100100
For the string and array types, the lengths are compared. For the number type, the number cannot be greater than`max`. An example of the use is as follows:
101101

@@ -105,7 +105,7 @@ rules: {
105105
}
106106
```
107107

108-
#### len
108+
### len
109109

110110
To verify the exact length of the field, specify`len`Property. For string and array types, the length property is compared. For type number, this property indicates an exact match for that number, that is, it can only be strictly equal to`len`. If`len`Attribute vs.`min`and`max`Attributes are used together, then`len`Preferred. Examples of usage are as follows:
111111

@@ -115,7 +115,7 @@ rules: {
115115
}
116116
```
117117

118-
#### trigger
118+
### trigger
119119

120120
Configure the way to trigger the verification rules through `trigger`. When it is `change`, the verification is triggered when the input box value changes. When it is `blur`,
121121
the verification is triggered after the input box value is out of focus. Can be set to an array `['change', 'blur']` to trigger both scenarios. The default is to trigger both scenarios.
@@ -137,7 +137,7 @@ The configurable values are as follows:
137137
138138
- `change`: The verification is triggered when the value in the input box changes.
139139
140-
#### enum
140+
### enum
141141
142142
Enumerated value validation, which verifies whether the value of the field is in`enum`Attribute configuration array`['admin', 'user', 'guest']`Medium. For example:
143143
@@ -147,7 +147,7 @@ rules: {
147147
}
148148
````
149149

150-
#### whitespace
150+
### whitespace
151151

152152
Verify that mandatory fields have only spaces. Mandatory fields that contain only blanks are generally considered an error. To treat a string consisting only of spaces as an error, you can set`whitespace`for`true`If this parameter is not configured, the input value of all spaces is valid.
153153

@@ -157,7 +157,7 @@ rules: {
157157
}
158158
```
159159

160-
#### fields
160+
### fields
161161

162162
deep rule. If you need to validate deep object properties, you can assign nested rules to the rule's`fields`Attribute to validate an object or array validation rule. Note that if you do not specify on the parent rule`required`Property, the field is not declared to be fully valid on the source object, and the deep validation rule will not be enforced because there are no verifiable objects. For example:
163163

@@ -192,7 +192,7 @@ rules: {
192192
}
193193
```
194194

195-
#### defaultField
195+
### defaultField
196196

197197
`defaultField`Attributes can be used with array or object types to validate all values of the container. It can be an object or an array containing validation rules. For example:
198198

@@ -205,7 +205,7 @@ rules: {
205205
}
206206
```
207207

208-
#### transform
208+
### transform
209209

210210
Sometimes it is necessary to convert values before validation to force or in some way clean them up.`transform`, add a feature to the validation rule. Before validation, the attribute is converted and then reassigned to the source object to change the value of the attribute. For example, the space entered by the user is removed.
211211

@@ -222,7 +222,7 @@ rules: {
222222
}
223223
```
224224

225-
#### messages
225+
### messages
226226

227227
This parameter is used to configure the message displayed when field verification fails. Internationalization is supported.
228228

@@ -250,7 +250,7 @@ rules: {
250250
}
251251
```
252252

253-
#### validator
253+
### validator
254254

255255
By`validator`The options are customized for a field.`callback`Must be invoked.
256256

@@ -278,7 +278,7 @@ rules: {
278278
}
279279
```
280280

281-
#### asyncValidator
281+
### asyncValidator
282282

283283
By`asyncValidator`The option is to perform custom asynchronous validation for a field.`callback`Must be invoked.
284284

0 commit comments

Comments
 (0)