Skip to content

Commit

Permalink
docs(ui): typo (#1208)
Browse files Browse the repository at this point in the history 
Co-authored-by: chouchouji <[email protected]>
  • Loading branch information
@chouchouji
chouchouji and chouchouji authored Oct 9, 2023
1 parent 286b76d commit e8f32a6
Show file tree
Hide file tree
Showing 68 changed files with 226 additions and 226 deletions.
18 changes: 9 additions & 9 deletions packages/varlet-ui/src/action-sheet/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

An action sheet pops up to give the user the ability to select options.
`ActionSheet` Functional and component use methods are provided, and there is no essential difference between the two effects and parameters.
The function returns a `Promise`，on selection return `action`，Click modal close to return `close`.
The function returns a `Promise`, on selection return `action`. Click modal close to return `close`.

## Functional

Expand Down Expand Up @@ -404,12 +404,12 @@ function handleSelect(action) {

| Event | Description | Arguments |
| --------------- | ---------------------------------------------------- | ---------------- |
| `select` | Triggered when the action is click | `action: Action` |
| `open` | Triggered when the action sheet is open | `-` |
| `opened` | Triggered when the action sheet open-animation ends | `-` |
| `close` | Triggered when the action sheet is close | `-` |
| `closed` | Triggered when the action sheet close-animation ends | `-` |
| `click-overlay` | Triggered when you click on overlay | `-` |
| `select` | Triggered when selecting an action sheet | `action: Action` |
| `open` | Triggered when opening an action sheet | `-` |
| `opened` | Triggered when an action sheet open-animation ends | `-` |
| `close` | Triggered when closing an action sheet | `-` |
| `closed` | Triggered when an action sheet close-animation ends | `-` |
| `click-overlay` | Triggered when clicking on overlay | `-` |

### Methods

Expand Down Expand Up @@ -446,7 +446,7 @@ function handleSelect(action) {
| ----------- | ----------------------------------- | --------- | ------- |
| `name` | Action name | _string_ | `-` |
| `color` | Action text color | _string_ | `-` |
| `icon` | Icon，support network image address | _string_ | `-` |
| `icon` | Icon, support network image address | _string_ | `-` |
| `iconSize` | Icon size | _string_ | `-` |
| `namespace` | Icon namespace | _string_ | `-` |
| `className` | Class name | _string_ | `-` |
Expand All @@ -461,7 +461,7 @@ function handleSelect(action) {

### Style Variables

Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

| Variable | Default |
| ------------------------------------------- | ---------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/action-sheet/docs/zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ function handleSelect(action) {

| 事件名 | 说明 | 参数 |
| --- | --- | --- |
| `select` | 选择选项时出发 | `action: Action` |
| `select` | 选择选项时触发 | `action: Action` |
| `open` | 打开动作面板时触发 | `-` |
| `opened` | 打开动作面板动画结束时触发 | `-` |
| `close` | 关闭动作面板时触发 | `-` |
Expand Down
4 changes: 2 additions & 2 deletions packages/varlet-ui/src/app-bar/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ const active = ref(0)
| `color` | Background | _string_ | `-` |
| `text-color` | Text color | _string_ | `-` |
| `title` | Title | _string_ | - |
| `title-position` | Title location,Can be set to `left`,`center`,`right` | _string_ | `left` |
| `title-position` | Title location, can be set to `left`, `center`, `right` | _string_ | `left` |
| `elevation` | Elevation level, options `true` `false` and level of `0-24` | _string \| number \| boolean_| `true` |
| `round` | Whether to use rounded border | _boolean_ | `false` |
| `image` | Background image | _string_ | `-` |
Expand All @@ -155,7 +155,7 @@ const active = ref(0)
| `content` | Insert the content to the extra content of the app bar | `-` |

### Style Variables
Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

| Variable | Default |
| --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/avatar/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ import logo from '../../assets/logo.png'
| `default` | Avatar group content | `-` |

### Style Variables
Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

#### Avatar Variables

Expand Down
6 changes: 3 additions & 3 deletions packages/varlet-ui/src/back-top/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const lists = [...Array(100).keys()]

| Prop | Description | Type | Default |
| ----- |---------------------------------------------------------------------------------------------------------|--------|-------|
| `target` | The target to trigger scroll, If it is undefined back top will listen to the nearest scrollable parent. | _string \| HTMLElement_ | `-` |
| `target` | The target to trigger scroll. If it is undefined, back top will listen to the nearest scrollable parent. | _string \| HTMLElement_ | `-` |
| `visibility-height` | The button will not show until the scroll height reaches this value | _string \| number_ | `200` |
| `bottom` | Distance between `BackTop` and page bottom | _string \| number_ | `40` |
| `right` | Distance between `BackTop` and page right | _string \| number_ | `40` |
Expand All @@ -35,7 +35,7 @@ const lists = [...Array(100).keys()]

| Event | Description | arguments |
| ----- | -------------- | -------- |
| `click` | Triggers when click | `event: Event` |
| `click` | Triggered when click | `event: Event` |

### Slots

Expand All @@ -44,7 +44,7 @@ const lists = [...Array(100).keys()]
| `default` | Custom the content | `-` |

### Style Variables
Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

| Variable | Default |
| --- | --- |
Expand Down
4 changes: 2 additions & 2 deletions packages/varlet-ui/src/badge/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Set Badge Icon through `icon` property.

| Prop | Description | Type | Default |
| --- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- |
| `type` | Badge type. Can be set to `default` `primary` `info` `success` `warning` `danger` | _string_ | `default` |
| `type` | Badge type, can be set to `default` `primary` `info` `success` `warning` `danger` | _string_ | `default` |
| `hidden` | Whether to hidden badge | _boolean_ | `false` |
| `dot` | Whether the badge is a dot | _boolean_ | `false`|
| `value` | The value shown in the badge (takes effect when `dot` is `false`) | _string \| number_ | `0`|
Expand All @@ -163,7 +163,7 @@ Set Badge Icon through `icon` property.
| `value` | The value shown in the badge | `-` |

### Style Variables
Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

| Variable | Default |
| --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/bottom-navigation-item/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

| Event | Description | Arguments |
| ---- | ---- | ---- |
| `click` | Trigger on click | `active: number \| string` |
| `click` | Triggered when clicking | `active: number \| string` |

### Slots

Expand Down
6 changes: 3 additions & 3 deletions packages/varlet-ui/src/bottom-navigation/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,13 +198,13 @@ const isEven = ref(true)
| ---- | ---- | ---- |
| `before-change` | The callback function before switching labels, which returns falsy value to prevent switching, supports the return of promise | `active: number \| string` |
| `change` | Triggered when switching labels | `active: number \| string` |
| `fab-click` | Triggered when fab button click | `-` |
| `fab-click` | Triggered when clicking fab button | `-` |

#### BottomNavigationItem Events

|Event | Description | Arguments |
| ---- | ---- | ---- |
| `click` | Trigger on click | `active: number \| string` |
| `click` | Triggered when clicking | `active: number \| string` |

### Slots

Expand All @@ -224,7 +224,7 @@ const isEven = ref(true)

### Style Variables

Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

#### BottomNavigation Variables

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/breadcrumb/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Prop | Description | Type | Default |
| ----------- | -------------- | ----------------------------- |-----|
| `separator` | separator | _string_ | `-` |
| `separator` | Separator | _string_ | `-` |

### Events

Expand Down
6 changes: 3 additions & 3 deletions packages/varlet-ui/src/breadcrumbs/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,13 @@ import { Snackbar } from '@varlet/ui'

| Prop | Description | Type | Default |
| ----------- | ------ | -------- | ------ |
| `separator` | separator | _string_ | `/` |
| `separator` | Separator | _string_ | `/` |

#### Breadcrumb Props

| Prop | Description | Type | Default |
| ----------- | -------------- | ----------------------------- |-----|
| `separator` | separator | _string_ | `-` |
| `separator` | Separator | _string_ | `-` |

### Events

Expand All @@ -123,7 +123,7 @@ import { Snackbar } from '@varlet/ui'

### Style Variables

Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).
#### Breadcrumb Variables

| Variable | Default |
Expand Down
8 changes: 4 additions & 4 deletions packages/varlet-ui/src/button-group/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

| Prop | Description | Type | Default |
|--------------|------------------------------------------------------------------------------------------|----------|-----------|
| `type` | Button Group type, Can be set to `default` `primary` `info` `success` `warning` `danger` | _string_ | `default` |
| `size` | Button Group size, Can be set to `normal` `mini` `small` `large` | _string_ | `normal` |
| `mode` | Button Group mode, Can be set to `normal` `text` `outline` | _string_ | `normal` |
| `type` | Button Group type, can be set to `default` `primary` `info` `success` `warning` `danger` | _string_ | `default` |
| `size` | Button Group size, can be set to `normal` `mini` `small` `large` | _string_ | `normal` |
| `mode` | Button Group mode, can be set to `normal` `text` `outline` | _string_ | `normal` |
| `vertical` | Whether to be vertical button group | _boolean_ | `false` |
| `elevation` | Elevation of Button Group, options `true` `false` and level of `0-24` | _string \| number \| boolean_| `true` |
| `color` | Button Group background color | _string_ | `-` |
Expand All @@ -16,4 +16,4 @@

| Name | Description | SlotProps |
| ----- |----------------------| -------- |
| `default` | Button group content | `-` |
| `default` | Button Group content | `-` |
10 changes: 5 additions & 5 deletions packages/varlet-ui/src/button/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -300,9 +300,9 @@ function handleAutoLoadingClick() {

| Prop | Description | Type | Default |
|--------------|------------------------------------------------------------------------------------------|----------|-----------|
| `type` | Button Group type, Can be set to `default` `primary` `info` `success` `warning` `danger` | _string_ | `default` |
| `size` | Button Group size, Can be set to `normal` `mini` `small` `large` | _string_ | `normal` |
| `mode` | Button Group mode, Can be set to `normal` `text` `outline` | _string_ | `normal` |
| `type` | Button Group type, can be set to `default` `primary` `info` `success` `warning` `danger` | _string_ | `default` |
| `size` | Button Group size, can be set to `normal` `mini` `small` `large` | _string_ | `normal` |
| `mode` | Button Group mode, can be set to `normal` `text` `outline` | _string_ | `normal` |
| `vertical` | Whether to be vertical button group | _boolean_ | `false` |
| `elevation` | Elevation of Button Group, options `true` `false` and level of `0-24` | _string \| number \| boolean_| `true` |
| `color` | Button Group background color | _string_ | `-` |
Expand All @@ -329,11 +329,11 @@ function handleAutoLoadingClick() {

| Name | Description | SlotProps |
| --------- | -------------- | --------- |
| `default` | Button group content | `-` |
| `default` | Button Group content | `-` |

### Style Variables

Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

#### Button Variables

Expand Down
8 changes: 4 additions & 4 deletions packages/varlet-ui/src/card/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ const floating = ref(false)
| `fit` | Fill mode, options `fill` `contain` `cover` `none` `scale-down` | _string_ | `cover` |
| `outline` | Whether to be outline card | _boolean_ | `false` |
| `alt` | Alt text | _string_ | `-` |
| `image-height` | height of Image | _string \| number_ | `-` |
| `image-width` | width of Image | _string \| number_ | `-` |
| `image-height` | Height of Image | _string \| number_ | `-` |
| `image-width` | Width of Image | _string \| number_ | `-` |
| `ripple` | Whether to enable ripple | _boolean_ | `false` |
| `floating` | Whether to full screen | _boolean_ | `false` |
| `floating-duration` | Time to full screen(ms) | _number_ | `250` |
Expand All @@ -167,7 +167,7 @@ const floating = ref(false)

| Events | Description | Arguments |
| ------- | -------------------------------- | -------------- |
| `click` | Triggered when the Card is click | `event: Event` |
| `click` | Triggered when the card is click | `event: Event` |

### Slots

Expand All @@ -183,7 +183,7 @@ const floating = ref(false)

### Style Variables

Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

| Variable | Default |
|-------------------------------------|-----------------------|
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/cell/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ const handleClick = (item) => {

### Style Variables

Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

| Variable | Default |
|-----------------| --- |
Expand Down
14 changes: 7 additions & 7 deletions packages/varlet-ui/src/checkbox-group/docs/en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@ const value = ref([])
| --- | --- | --- | --- |
| `v-model` | The value of the binding | _any[]_ | `[]` |
| `max` | Maximum number of checked | _string \| number_ | `-` |
| `direction` | The layout direction，Optional value is `horizontal` `vertical` | _string_ | `horizontal` |
| `rules` | The validation rules，Returns `true` to indicate that the validation passed，The remaining values are converted to text as user prompts | _Array<(value: any[]) => any>_ | `horizontal` |
| `direction` | The layout direction, optional value is `horizontal` `vertical` | _string_ | `horizontal` |
| `rules` | The validation rules, return `true` to indicate that the validation passed. The remaining values are converted to text as user prompts | _Array<(value: any[]) => any>_ | `horizontal` |

#### Checkbox Props

Expand All @@ -228,7 +228,7 @@ const value = ref([])
| `readonly` | Whether the readonly | _boolean_ | `false` |
| `indeterminate` | Whether indeterminate status(style has the highest priority) | _boolean_ | `false` |
| `ripple` | Whether to open ripple | _boolean_ | `true` |
| `rules` | The validation rules，Returns `true` to indicate that the validation passed，The remaining values are converted to text as user prompts | _Array<(value: any) => any>_ | `-` |
| `rules` | The validation rules, return `true` to indicate that the validation passed. The remaining values are converted to text as user prompts | _Array<(value: any) => any>_ | `-` |

### Methods

Expand Down Expand Up @@ -257,22 +257,22 @@ const value = ref([])

| Event | Description | Arguments |
| --- | --- | --- |
| `change` | Trigger on change | `value: any[]` |
| `change` | Triggered on change | `value: any[]` |

#### Checkbox Events

| Event | Description | Arguments |
| --- | --- | --- |
| `click` | Triggered on Click | `e: Event` |
| `change` | Trigger on change | `value: any` |
| `change` | Triggered on change | `value: any` |

### Slots

#### CheckboxGroup Slots

| Name | Description | SlotProps |
| --- | --- | --- |
| `default` | Checkbox group content | `-` |
| `default` | Checkbox Group content | `-` |

#### Checkbox Slots

Expand All @@ -284,7 +284,7 @@ const value = ref([])
| `default` | Displayed text | `-` |

### Style Variables
Here are the CSS variables used by the component, Styles can be customized using [StyleProvider](#/en-US/style-provider).
Here are the CSS variables used by the component. Styles can be customized using [StyleProvider](#/en-US/style-provider).

| Variable | Default |
| --- | --- |
Expand Down
Loading

0 comments on commit e8f32a6

Please sign in to comment.