Skip to content

Commit

Permalink
docs: fomat doc indent
Browse files Browse the repository at this point in the history
  • Loading branch information
@thinkasany
thinkasany committed Nov 9, 2022
1 parent cd4f379 commit 37c5d52
Show file tree
Hide file tree
Showing 30 changed files with 82 additions and 82 deletions.
4 changes: 2 additions & 2 deletions packages/quark/src/checkbox/doc-react.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,14 @@ Checkbox { --radio-background: linear-gradient(225deg, #ff918d 0%, #f54640
| size | 复选框大小，可选值为 `normal` `big` | `string` | `normal` |
| disabled | 复选框禁用状态 | `boolean` | `false` |
| checked | 复选框勾选状态 | `boolean` | `false` |
| onChange | 复选框勾选状态变化时回调函数 | `(e:{detail: {value: string}})=>void` |
| onChange | 复选框勾选状态变化时回调函数 | `(e: { detail: { value: string } }) => void` |

### Checkbox-group Props

| 参数 | 说明 | 类型 | 默认值 |
| -------- | ------------------------------ | ----------------------------------------- | ------ |
| value | 指定选中的选项 | `string` | - |
| onChange | 复选框组勾选状态变化时回调函数 | `(e:{detail: {value: string[]}}) => void` |
| onChange | 复选框组勾选状态变化时回调函数 | `(e: { detail: { value: string[] } }) => void` |

## 样式变量

Expand Down
4 changes: 2 additions & 2 deletions packages/quark/src/checkbox/doc.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ export default {

| 参数 | 说明 | 类型 |
| ------ | ---------------------------- | ------------------------------------- |
| change | 复选框勾选状态变化时回调函数 | `(e:{detail: {value: string}})=>void` |
| change | 复选框勾选状态变化时回调函数 | `(e: { detail: { value: string } }) => void` |

### quark-checkbox-group Props

Expand All @@ -134,7 +134,7 @@ export default {

| 参数 | 说明 | 类型 |
| ------ | ------------------------------ | ----------------------------------------- |
| change | 复选框组勾选状态变化时回调函数 | `(e:{detail: {value: string[]}}) => void` |
| change | 复选框组勾选状态变化时回调函数 | `(e: { detail: { value: string[] } }) => void` |

## 样式变量

Expand Down
6 changes: 3 additions & 3 deletions packages/quark/src/field/doc-react.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,9 @@ export default () => {
| readonly | 是否只读 | `boolean` | `false` |
| required | 是否必填 | `boolean` | `false` |
| errormsg | 错误提示信息 | `string` | - |
| onChange | 值改变事件 | `（e:{detail:{value: string}}）=> void` | |
| onFocus | 聚焦事件 | `（e:{detail:{value: string}}）=> void` | |
| onBlur | 失焦事件 | `（e:{detail:{value: string}}）=> void` | |
| onChange | 值改变事件 | `(e: { detail: { value: string } }) => void` | |
| onFocus | 聚焦事件 | `(e: { detail: { value: string } }) => void` | |
| onBlur | 失焦事件 | `(e: { detail: { value: string } }) => void` | |

### Method

Expand Down
6 changes: 3 additions & 3 deletions packages/quark/src/field/doc.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,9 @@ import "quarkd/lib/field";

| 参数 | 说明 | 类型 |
| ------ | ---------- | --------------------------------------- |
| change | 值改变事件 | `（e:{detail:{value: string}}）=> void` |
| focus | 聚焦事件 | `（e:{detail:{value: string}}）=> void` |
| blur | 失焦事件 | `（e:{detail:{value: string}}）=> void` |
| change | 值改变事件 | `(e: { detail: { value: string } }) => void` |
| focus | 聚焦事件 | `(e: { detail: { value: string } }) => void` |
| blur | 失焦事件 | `(e: { detail: { value: string } }) => void` |

### Method

Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/popup/doc-react.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export default () => {
| closeable | 是否显示关闭按钮 | `boolean` | `false` |
| safearea | 是否开启底部安全区域适配 | ` boolean` | `false` |
| zindex | popup 层级设置 | `number、string` | - |
| onClosed | 组件关闭回调 | `（）=> void` | - |
| onClosed | 组件关闭回调 | `() => void` | - |

## 样式变量

Expand Down
6 changes: 3 additions & 3 deletions packages/quark/src/popup/doc.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,16 @@ export default {
| --------- | ------------------------ | ----------------------------- | --------- |
| open | 弹窗状态 | `boolean` | `require` |
| position | 弹框位置 | `top` `bottom` `left` `right` | `bottom` |
| round | 是否圆角 | `boolean ` | `false` |
| closeable | 是否显示关闭按钮 | `boolean ` | `false` |
| round | 是否圆角 | `boolean` | `false` |
| closeable | 是否显示关闭按钮 | `boolean` | `false` |
| safearea | 是否开启底部安全区域适配 | `boolean` | `false` |
| zindex | popup 层级设置 | `number、string` | - |

### Event

| 名称 | 说明 | 类型 |
| ------ | ------------ | ------------- |
| closed | 组件关闭回调 | `（）=> void` |
| closed | 组件关闭回调 | `() => void` |

## 样式变量

Expand Down
6 changes: 3 additions & 3 deletions packages/quark/src/popupextra/doc-react.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@ export default () => {
| open | 弹窗状态 | `boolean` | `require` |
| title | 主标题 | `string` |
| subtitle | 主标题 | `string` |
| hideclose | 是否隐藏右上角关闭按钮 | `boolean ` | `false` |
| round | 是否圆角 | `boolean ` | `true` |
| hideclose | 是否隐藏右上角关闭按钮 | `boolean` | `false` |
| round | 是否圆角 | `boolean` | `true` |
| safearea | 是否开启底部安全区域适配 | `boolean` | `false` |
| zindex | popup 层级设置 | `number、string` | - |
| onClosed | 组件关闭回调 | `（）=> void` |
| onClosed | 组件关闭回调 | `() => void` |
## 样式变量
Expand Down
6 changes: 3 additions & 3 deletions packages/quark/src/popupextra/doc.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,16 +79,16 @@ export default {
| open | 弹窗状态 | `boolean` | `require` |
| title | 主标题 | `string` |
| subtitle | 主标题 | `string` |
| hideclose | 是否隐藏右上角关闭按钮 | `boolean ` | `false` |
| round | 是否圆角 | `boolean ` | `true` |
| hideclose | 是否隐藏右上角关闭按钮 | `boolean` | `false` |
| round | 是否圆角 | `boolean` | `true` |
| safearea | 是否开启底部安全区域适配 | `boolean` | `false` |
| zindex | popup 层级设置 | `number、string` | - |

### Event

| 名称 | 说明 | 类型 |
| ------ | ------------ | ------------- |
| closed | 组件关闭回调 | `（）=> void` |
| closed | 组件关闭回调 | `() => void` |

## 样式变量

Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/radio/doc-react.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Custom checked color
| 参数 | 说明 | 类型 | 默认值 |
| -------- | ----------------------------------------------------------------------------- | -------- | ------ |
| value | Specific radio | `String` | - |
| onChange | Emitted when radio check status changed `(e:{detail: {value: string}})=>void` |
| onChange | Emitted when radio check status changed `(e: { detail: { value: string } }) => void` |

## CSS Variables

Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/radio/doc-react.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ export default () => {
| 参数 | 说明 | 类型 | 默认值 |
| -------- | -------------- | ------------------------------------- | ------ |
| value | 指定选中的选项 | `string` | - |
| onChange | 变化时回调函数 | `(e:{detail: {value: string}})=>void` |
| onChange | 变化时回调函数 | `(e: { detail: { value: string } }) => void` |

## 样式变量

Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/radio/doc.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ export default {

| 参数 | 说明 | 类型 |
| ------ | -------------- | ------------------------------------- |
| change | 变化时回调函数 | `(e:{detail: {value: string}})=>void` |
| change | 变化时回调函数 | `(e: { detail: { value: string } }) => void` |

## 样式变量

Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/rate/doc-react.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ export default () => {
| disabled | Whether to disable rate | `boolean` | `false` |
| readonly | Whether to be readonly | `boolean` | `false` |
| activecolor | chosen color | `string` | `#ffc800` |
| onChange Emitted when rate changed | `( e:{detail:{value:string}})=>void` | |
| onChange Emitted when rate changed | `(e: { detail: { value: string } }) => void` | |
2 changes: 1 addition & 1 deletion packages/quark/src/rate/doc-react.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ export default () => {
| disabled | 是否禁用 | `boolean` | `false` |
| readonly | 是否只读 | `boolean` | `false` |
| activecolor | 选中的时候颜色 | `string` | `#ffc800` |
| onChange | 当前分值修改时时触发的事件 | `( e:{detail:{value:string}})=>void` | |
| onChange | 当前分值修改时时触发的事件 | `(e: { detail: { value: string } }) => void` | |
2 changes: 1 addition & 1 deletion packages/quark/src/rate/doc.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ quark-rate {

| Event | Description | Type |
| ------ | ------------------------- | ------------------------------------ |
| change | Emitted when rate changed | `( e:{detail:{value:string}})=>void` |
| change | Emitted when rate changed | `(e: { detail: { value: string } }) => void` |
2 changes: 1 addition & 1 deletion packages/quark/src/rate/doc.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ quark-rate {

| 参数 | 说明 | 类型 |
| ------ | -------------------------- | ------------------------------------ |
| change | 当前分值修改时时触发的事件 | `( e:{detail:{value:string}})=>void` |
| change | 当前分值修改时时触发的事件 | `(e: { detail: { value: string } }) => void` |
2 changes: 1 addition & 1 deletion packages/quark/src/switch/doc-react.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export default () => {
| disabled | Disable switch | `boolean` | `false` |
| size | Switch size | `number` | `16px` |
| color | Switch color | `string` | - |
| onChange | Emitted when check status changed | `e: {detail:{value: string}}）=>void ` |
| onChange | Emitted when check status changed | `e: ({ detail: { value: string } }) => void` |

## CSS Variables

Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/switch/doc-react.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export default () => {
| disabled | 禁用 | `boolean` | `false` |
| size | 开关大小 | `number` | `16px ` |
| color | 颜色 | `string` | - |
| onChange | change 回调函数 | `e: {detail:{value: string}}）=>void ` |
| onChange | change 回调函数 | `e: ({ detail: { value: string } }) => void` |

## 样式变量

Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/switch/doc.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ export default {

| Event | Description | Arguments |
| ------ | --------------------------------- | -------------------------------------- |
| change | Emitted when check status changed | `e: {detail:{value: string}}）=>void ` |
| change | Emitted when check status changed | `e: ({ detail: { value: string } }) => void` |

## CSS Variables

Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/switch/doc.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ export default {

| 名称 | 说明 | 类型 |
| ------ | --------------- | -------------------------------------- |
| change | change 回调函数 | `e: {detail:{value: string}}）=>void ` |
| change | change 回调函数 | `e: ({ detail: { value: string } }) => void` |

## 样式变量

Expand Down
12 changes: 6 additions & 6 deletions packages/quark/src/textarea/doc-react.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,19 @@ export default () => {

| 参数 | 说明 | 类型 | 默认值 |
| ------------------ | ----------------------------------------- | --------------------------------------- | ------- |
| value | 输入值 | `string ` |
| value | 输入值 | `string` |
| placeholder | 提示文本 | `string` |
| rows | 行数 | `number` | `2` |
| maxlength | 最大字符数 | `number ` | `-` |
| maxlength | 最大字符数 | `number` | `-` |
| showcount | 显示字数 | `boolean` | `false` |
| autocomplete | 自动补全 | `boolean` | `false` |
| disabled | 是否禁用 | `boolean` | `false` |
| readonly | 是否只读 | `boolean` | `false` |
| id | textarea 元素的 id，常用来配合 label 使用 | `string` |
| onInput | 文本域内容变化时触发 | `(e: {detail:{value: string}}）=>void ` | |
| onFocus | 文本域获得焦点时触发 | `(e: {detail:{value: string}}）=>void ` | |
| onBlur | 文本域失去焦点时触发 | `(e: {detail:{value: string}}）=>void ` | |
| onCompositionStart | 输入法编辑器开始新的输入时触发 | `(）=>void ` |
| onInput | 文本域内容变化时触发 | `(e: { detail: { value: string } }) => void` | |
| onFocus | 文本域获得焦点时触发 | `(e: { detail: { value: string } }) => void` | |
| onBlur | 文本域失去焦点时触发 | `(e: { detail: { value: string } }) => void` | |
| onCompositionStart | 输入法编辑器开始新的输入时触发 | `(）=> void ` |

## CSS 样式变量

Expand Down
8 changes: 4 additions & 4 deletions packages/quark/src/textarea/doc.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,10 @@ textarea native events are supported

| Event | Description | Type |
| ---------------- | -------------------------------------------- | --------------------------------------- |
| input | Emitted when input value changed | `(e: {detail:{value: string}}）=>void ` |
| focus | Emitted when input is focused | `(e: {detail:{value: string}}）=>void ` |
| blur | Emitted when input is blurred | `(e: {detail:{value: string}}）=>void ` |
| compositionstart | Emitted when input editor starts a new input | `(）=>void ` |
| input | Emitted when input value changed | `(e: ({ detail: { value: string } }) => void` |
| focus | Emitted when input is focused | `(e: ({ detail: { value: string } }) => void` |
| blur | Emitted when input is blurred | `(e: ({ detail: { value: string } }) => void` |
| compositionstart | Emitted when input editor starts a new input | `(）=> void ` |

## CSS Variables

Expand Down
14 changes: 7 additions & 7 deletions packages/quark/src/textarea/doc.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ export default {

| 参数 | 说明 | 类型 | 默认值 |
| ------------ | ----------------------------------------- | --------- | ------- |
| value | 输入值 | `string ` |
| value | 输入值 | `string` |
| placeholder | 提示文本 | `string` |
| rows | 行数 | `number` | `2` |
| maxlength | 最大字符数 | `number ` | `-` |
| maxlength | 最大字符数 | `number` | `-` |
| showcount | 显示字数 | `boolean` | `false` |
| autocomplete | 自动补全 | `boolean` | `false` |
| disabled | 是否禁用 | `boolean` | `false` |
Expand All @@ -120,18 +120,18 @@ textarea 原生事件均支持

| 属性 | 说明 | 类型 |
| ---------------- | ------------------------------ | --------------------------------------- |
| input | 文本域内容变化时触发 | `(e: {detail:{value: string}}）=>void ` |
| focus | 文本域获得焦点时触发 | `(e: {detail:{value: string}}）=>void ` |
| blur | 文本域失去焦点时触发 | `(e: {detail:{value: string}}）=>void ` |
| compositionstart | 输入法编辑器开始新的输入时触发 | `(）=>void ` |
| input | 文本域内容变化时触发 | `(e: { detail: { value: string } }) => void` |
| focus | 文本域获得焦点时触发 | `(e: { detail: { value: string } }) => void` |
| blur | 文本域失去焦点时触发 | `(e: { detail: { value: string } }) => void` |
| compositionstart | 输入法编辑器开始新的输入时触发 | `(）=> void ` |

## CSS 样式变量

组件提供了以下[CSS 变量](https://developer.mozilla.org/zh-CN/docs/Web/CSS/Using_CSS_custom_properties)，可用于自定义样式，使用方法请参考[主题定制](#/zh-CN/guide/theme)。

| 名称 | 说明 | 默认值 |
| ---------------------------- | -------------- | ---------- |
| --textarea-color | 文字颜色 | `#242729 ` |
| --textarea-color | 文字颜色 | `#242729` |
| --textarea-font-size | 文字大小 | `14px` |
| --textarea-text-align | 文字位置 | `left` |
| --textarea-text-count-align | 统计字数位置 | `right` |
Expand Down
2 changes: 1 addition & 1 deletion packages/quark/src/toast/doc-react.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ toast2.hide();
| duration | Toast duration(ms), won't disappear if value is 0 | `number` | `2000ms` |
| size | Custom icon size | `number` | `40px` |
| zIndex | Custom zIndex | `number` | `9999` |
| close | Callback function after close | `()=>void` | - |
| close | Callback function after close | `() => void` | - |

## CSS Variables

Expand Down
Loading

0 comments on commit 37c5d52

Please sign in to comment.