diff --git a/one/docs/components/badge.md b/one/docs/components/badge.md index 5e18f23..6b19d5d 100644 --- a/one/docs/components/badge.md +++ b/one/docs/components/badge.md @@ -14,7 +14,7 @@ [[ demo src="/demo/badge/number.vue" ]] -### 圆点徽标 +### 飘角徽标 不提供徽标内容时,徽标将以圆点样式显示在右上角。 diff --git a/one/docs/components/cascader.md b/one/docs/components/cascader.md index c4e05d6..5418bb7 100644 --- a/one/docs/components/cascader.md +++ b/one/docs/components/cascader.md @@ -55,17 +55,17 @@ | ``options`` | `Array` | - | [^options] | | ``value`` | `Array<*>|*` | - | [^value] | | ``multiple`` | `boolean` | `false` | 是否允许多选。 | -| ``inline`` | `boolean` | `false` | 下拉面板是否内联展示。 | +| ``inline`` | `boolean` | `false` | 下拉面板是否以内联模式展示(展开选项将拆分面板而非向外扩展)。 | | ``max`` | `number` | - | 多选时允许选择的项目上限。 | | ``placeholder`` | `string` | `cascader.placeholder` | 未选择时的占位文本。 | | ``clearable`` | `boolean` | `false` | 是否可以清除已选内容。 | | ``searchable`` | `boolean` | `false` | 是否允许搜索选项。 | | ``expanded`` | `boolean=` | `false` | [^expanded] | -| ``column-trigger`` | `hover | click` | `click` | [^column-trigger] | -| ``select-mode`` | `'leaf-only' | 'any'` | `any` | [^select-mode] | +| ``column-trigger`` | `'hover' | 'click'` | `'click'` | [^column-trigger] | +| ``select-mode`` | `'leaf-only' | 'any'` | `'any'` | [^select-mode] | | ``column-width`` | `number | string` | - | [^column-width] | | ``show-select-all`` | `boolean` | `false` | 在多选模式下是否有全选按钮。 | -| ``value-display`` | `'complete' | 'simple'` | `simple` | [^value-display] | +| ``value-display`` | `'complete' | 'simple'` | `'simple'` | [^value-display] | | ``disabled`` | `boolean=` | `false` | 是否为禁用状态。 | | ``readonly`` | `boolean=` | `false` | 是否为只读状态。 | | ``overlay-class`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 | @@ -160,7 +160,7 @@ | 名称 | 描述 | | -- | -- | | ``trigger`` | [^slot-trigger] | -| ``pane`` | 下拉面板中的内容插槽。用域参数同 [`trigger`](#slots-trigger) 插槽。 | +| ``pane`` | 下拉面板中的内容插槽。作用域参数同 [`trigger`](#slots-trigger) 插槽。 | | ``before`` | 选项列表前的内容。无默认内容。作用域参数同 [`trigger`](#slots-trigger) 插槽。 | | ``after`` | 选项列表后的内容。无默认内容。作用域参数同 [`trigger`](#slots-trigger) 插槽。 | | ``column-before`` | [^slot-column-before] | @@ -244,7 +244,7 @@ ^^^slot-selected 选中值渲染区域。 -默认内容:单选时渲染选中项目的标签;多选时将每个选中项目的标签渲染成`Tag`。 +默认内容:单选时渲染选中项目的文本;多选时将每个选中项目的标签渲染成`Tag`。 +++单选时的作用域参数 | 名称 | 类型 | 描述 | diff --git a/one/docs/components/dropdown.md b/one/docs/components/dropdown.md index 4acb2e2..df39d58 100644 --- a/one/docs/components/dropdown.md +++ b/one/docs/components/dropdown.md @@ -18,7 +18,7 @@ [[ demo src="/demo/dropdown/size.vue" ]] -### 内联模式 +### 内联选项 `Dropdown` 组件内支持内联使用 `OptionGroup` 及 `Option` 组件来代替 [`options`](#props-options) 属性。 diff --git a/one/docs/components/select.md b/one/docs/components/select.md index 02b61c3..75f9e62 100644 --- a/one/docs/components/select.md +++ b/one/docs/components/select.md @@ -12,7 +12,7 @@ [[ demo src="/demo/select/size.vue" ]] -### 内联模式 +### 内联选项 `Select` 组件内支持内联使用 `OptionGroup` 及 `Option` 组件来代替 [`options`](#props-options) 属性。 diff --git a/one/docs/en-US/components/alert.md b/one/docs/en-US/components/alert.md index 325bfc5..5609ea8 100644 --- a/one/docs/en-US/components/alert.md +++ b/one/docs/en-US/components/alert.md @@ -70,7 +70,7 @@ The content of the message. Default: message text. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `message` | `string` | Message text. | diff --git a/one/docs/en-US/components/breadcrumb.md b/one/docs/en-US/components/breadcrumb.md index 6b7c151..c85edca 100644 --- a/one/docs/en-US/components/breadcrumb.md +++ b/one/docs/en-US/components/breadcrumb.md @@ -81,10 +81,10 @@ The last item will always be displayed as plain text by default. ^^^slot-item The content of each breadcrumb item. Default to the `label` properties of each item within `routes`, or the default slot content of [`BreadcrumbItem`]('./breadcrumb-item) components. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | -| `route` | `Object` | The item in `routes`. Custom properties will also be passes into the scope object. | +| `route` | `Object` | The item in `routes`. Custom properties will also be passes into the slot props object. | +++ ^^^ diff --git a/one/docs/en-US/components/button-group.md b/one/docs/en-US/components/button-group.md index c7ea1d7..4f7c951 100644 --- a/one/docs/en-US/components/button-group.md +++ b/one/docs/en-US/components/button-group.md @@ -76,7 +76,7 @@ The content of each button. Shows the text specified by the `label` property by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The label text of the button. | @@ -85,7 +85,7 @@ Shows the text specified by the `label` property by default. | `disabled` | `boolean=` | Whether the button is disabled. | +++ -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. ^^^ ### Events diff --git a/one/docs/en-US/components/calendar.md b/one/docs/en-US/components/calendar.md index 69d802c..2f680a2 100644 --- a/one/docs/en-US/components/calendar.md +++ b/one/docs/en-US/components/calendar.md @@ -67,7 +67,7 @@ Selected date(s) or date range(s). Data type differs according to `multiple` and ^^^slot-date The content of each date cell. Displays the corresponding day of month by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `year` | `number` | The full representation of year. | diff --git a/one/docs/en-US/components/carousel.md b/one/docs/en-US/components/carousel.md index 0824ee8..8d82cfb 100644 --- a/one/docs/en-US/components/carousel.md +++ b/one/docs/en-US/components/carousel.md @@ -86,7 +86,7 @@ The behavior triggers item switch when radio indicator is displayed. ^^^slot-item The content of each carousel item. Displays the corresponding image by default. -The slot scope properties are the same as each item inside `datasource` (including custom properties), with an extra `index: number`, which denotes the index within the datasource. i.e. The `slot-scope` is in the form of `{src, alt, label, index, ...}`. +The slot props are the same as each item inside `datasource` (including custom properties), with an extra `index: number`, which denotes the index within the datasource. i.e. The `slot-scope` is in the form of `{src, alt, label, index, ...}`. ^^^ ### Events diff --git a/one/docs/en-US/components/check-button-group.md b/one/docs/en-US/components/check-button-group.md index 97f5acf..b526b99 100644 --- a/one/docs/en-US/components/check-button-group.md +++ b/one/docs/en-US/components/check-button-group.md @@ -62,7 +62,7 @@ The `value`s of the selected items. ^^^slot-item The label content of each button. Displays the value of the `label` property by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the item. | @@ -71,7 +71,7 @@ The label content of each button. Displays the value of the `label` property by | `disabled` | `boolean=` | Whether the item is disabled. | +++ -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. ^^^ ### Events diff --git a/one/docs/en-US/components/checkbox-group.md b/one/docs/en-US/components/checkbox-group.md index 3794f04..94aa700 100644 --- a/one/docs/en-US/components/checkbox-group.md +++ b/one/docs/en-US/components/checkbox-group.md @@ -61,7 +61,7 @@ The `value`s of the selected items. ^^^slot-item The label content of each checkbox. Displays the value of the `label` property by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the item. | @@ -70,7 +70,7 @@ The label content of each checkbox. Displays the value of the `label` property b | `disabled` | `boolean=` | Whether the item is disabled. | +++ -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. ^^^ ### Events diff --git a/one/docs/en-US/components/column.md b/one/docs/en-US/components/column.md index 9fb3511..903b01f 100644 --- a/one/docs/en-US/components/column.md +++ b/one/docs/en-US/components/column.md @@ -74,7 +74,7 @@ The table foot. ^^^slot-default The content of the table cell. Displays the property value corresponds to the [`field`](#props-field) prop in table's [`data`](./table#props-data) prop. -The slot scope properties are the same as each item inside `data`, with an extra `index: number`, which denotes the index within the row data. +The slot props are the same as each item inside `data`, with an extra `index: number`, which denotes the index within the row data. ^^^ ^^^slot-sub-row @@ -82,7 +82,7 @@ The content of cells in a sub row. Sub row data comes from the `children` array Displays the value keyed by the [`field`](#props-field) prop inside the sub row data, which is `data[i].children[j]` of the parent table. -The slot scope properties are the same as each item inside `children`, with an extra `index: number`, which denotes the index within the row data. +The slot props are the same as each item inside `children`, with an extra `index: number`, which denotes the index within the row data. :::warning The `sub-row` slot of `Column` will be ignored when content is provided for `Table`'s [`sub-row`](./table#slots-sub-row) slot. @@ -92,7 +92,7 @@ The `sub-row` slot of `Column` will be ignored when content is provided for `Tab ^^^slot-desc The content of the description overlay. Will override the [`desc`](#props-desc) prop when set. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `close` | `function(): void` | Used to close the description overlay. | @@ -102,7 +102,7 @@ The content of the description overlay. Will override the [`desc`](#props-desc) ^^^slot-filter The content of the filter dropdown. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `close` | `function(): void` | Used to close the filter dropdown. | diff --git a/one/docs/en-US/components/date-picker.md b/one/docs/en-US/components/date-picker.md index ed9d11b..2291266 100644 --- a/one/docs/en-US/components/date-picker.md +++ b/one/docs/en-US/components/date-picker.md @@ -178,7 +178,7 @@ Whether the dropdown overlay is expanded. ^^^slot-date The content of each date cell in the dropdown overlay. Displays the corresponding day of month by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `year` | `number` | The full representation of year. | diff --git a/one/docs/en-US/components/dialog.md b/one/docs/en-US/components/dialog.md index 0e80d90..0a85584 100644 --- a/one/docs/en-US/components/dialog.md +++ b/one/docs/en-US/components/dialog.md @@ -117,7 +117,7 @@ methods: { The foot of the dialog. Displays “OK” and “Cancel” buttons by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `close` | `function(type: string): void` | The callback to trigger closing the dialog. `type` is the action type and will be passed into `before-close` hook as the first argument. And an event named after `type` will be triggered synchronously. | diff --git a/one/docs/en-US/components/dropdown.md b/one/docs/en-US/components/dropdown.md index 2a2f190..0a1e096 100644 --- a/one/docs/en-US/components/dropdown.md +++ b/one/docs/en-US/components/dropdown.md @@ -18,7 +18,7 @@ Available size values for the [`ui`](#props-ui) prop: `xs` / `s` / `m` / `l`. [[ demo src="/demo/dropdown/size.vue" ]] -### Using embedded `OptionGroup`s & `Option`s +### Embedded options Can be used with embedded `OptionGroup`s & `Option`s. @@ -109,7 +109,7 @@ Whether the dropdown menu is expanded. ^^^slot-label The content of the select button. Displays the [`label`](#props-label) prop by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the dropdown option. | @@ -119,20 +119,20 @@ The content of the select button. Displays the [`label`](#props-label) prop by d ^^^slot-group-label The label text of each option group (option with child `options`). Displays the `label` of the option by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option group. | | `disabled` | `boolean=` | Whether the option group is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-option-label The label text of each option (option without child `options`). Displays the `label` of the option by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option. | @@ -141,13 +141,13 @@ The label text of each option (option without child `options`). Displays the `la | `disabled` | `boolean=` | Whether the option is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-option The entire content area of each option (option without child `options`). Displays the default content of `Options` component by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option. | @@ -156,13 +156,13 @@ The entire content area of each option (option without child `options`). Display | `disabled` | `boolean=` | Whether the option is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-trigger The entire drop-down trigger area. Displays the dropdown button by default. -+++Scope properties ++++Slot props | Name | Type | Description | | --- | --- | --- | | `attrs` | `Object` | Attributes that need to be output to the trigger element, including `aria-*` / `disabled`, etc., can be output using `v-bind="attrs"`. | diff --git a/one/docs/en-US/components/filter-panel.md b/one/docs/en-US/components/filter-panel.md index 4f71628..2663c32 100644 --- a/one/docs/en-US/components/filter-panel.md +++ b/one/docs/en-US/components/filter-panel.md @@ -50,7 +50,7 @@ function (keyword, { label }) { ^^^default The content of the filter panel. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `items` | `Array` | The filtered items from the [`datasource`](#props-datasource) prop and shares the same type with `datasource`. | diff --git a/one/docs/en-US/components/option-group.md b/one/docs/en-US/components/option-group.md index a451421..0bad8da 100644 --- a/one/docs/en-US/components/option-group.md +++ b/one/docs/en-US/components/option-group.md @@ -56,7 +56,7 @@ The way to display child options. ^^^slot-label The label of the option group. Displays the [`label`](#props-label) prop by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option group. | @@ -67,20 +67,20 @@ The label of the option group. Displays the [`label`](#props-label) prop by defa ^^^slot-group-label The label text of each option group (option with child `options`). Displays the `label` of the option by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option group. | | `disabled` | `boolean=` | Whether the option group is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-option-label The label text of each option (option without child `options`). Displays the `label` of the option by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option. | @@ -89,13 +89,13 @@ The label text of each option (option without child `options`). Displays the `la | `disabled` | `boolean=` | Whether the option is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-option The entire content area of each option (option without child `options`). Displays the default content of `Options` component by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option. | @@ -104,7 +104,7 @@ The entire content area of each option (option without child `options`). Display | `disabled` | `boolean=` | Whether the option is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ### Icons diff --git a/one/docs/en-US/components/progress.md b/one/docs/en-US/components/progress.md index d481ab0..fc9c5e8 100644 --- a/one/docs/en-US/components/progress.md +++ b/one/docs/en-US/components/progress.md @@ -49,7 +49,7 @@ The status of the progress. Available values are `success` / `alert`, denoting s ^^^slot-default The description content. Displays the percentage value of the progress by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `percent` | `number` | The percentage value of the progress. | diff --git a/one/docs/en-US/components/radio-button-group.md b/one/docs/en-US/components/radio-button-group.md index df12305..be9d1e2 100644 --- a/one/docs/en-US/components/radio-button-group.md +++ b/one/docs/en-US/components/radio-button-group.md @@ -61,7 +61,7 @@ The `value`s of the selected items. ^^^slot-item The label content of each button. Displays the value of the `label` property by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the item. | @@ -70,7 +70,7 @@ The label content of each button. Displays the value of the `label` property by | `disabled` | `boolean=` | Whether the item is disabled. | +++ -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. ^^^ ### Events diff --git a/one/docs/en-US/components/radio-group.md b/one/docs/en-US/components/radio-group.md index 0937ee0..7cddab9 100644 --- a/one/docs/en-US/components/radio-group.md +++ b/one/docs/en-US/components/radio-group.md @@ -59,7 +59,7 @@ The `value` of the selected item. ^^^slot-item The label content of each radio. Displays the value of the `label` property by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the item. | @@ -68,7 +68,7 @@ The label content of each radio. Displays the value of the `label` property by d | `disabled` | `boolean=` | Whether the item is disabled. | +++ -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. ^^^ ### Events diff --git a/one/docs/en-US/components/region-picker.md b/one/docs/en-US/components/region-picker.md index 9aa6e1b..44eb16c 100644 --- a/one/docs/en-US/components/region-picker.md +++ b/one/docs/en-US/components/region-picker.md @@ -46,7 +46,7 @@ The array of selected `value`s. ^^^slot-label The label content of each node. Displays the `label` property of each item by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the node. | @@ -57,7 +57,7 @@ The label content of each node. Displays the `label` property of each item by de | `overlay` | `boolean=` | Whether the node is displayed inside the overlay. | +++ -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. :::tip When `level` is `2` and `overlay` is `true`, the information of selected node count vs total node count will be displayed after the node label. diff --git a/one/docs/en-US/components/schedule.md b/one/docs/en-US/components/schedule.md index d43853d..f7322ab 100644 --- a/one/docs/en-US/components/schedule.md +++ b/one/docs/en-US/components/schedule.md @@ -67,20 +67,20 @@ Shortcut selection list. The type is `{label: string, selected: boolean | Array} ^^^slot-legend-label The text label of each legend. Displays the `label` property of each legend by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The text label of the legend. | | `value` | `string` | The value of the legend. | +++ -Additionally, custom properties inside `statuses` apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties inside `statuses` apart from the listed ones will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-hour The content of each hour cell. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `day` | `number` | The day of week. `0` denotes Sunday. | @@ -91,7 +91,7 @@ The content of each hour cell. ^^^slot-label The content of the selected label. By default, displays the time range in the form of `${from}:00–${to + 1}:00` when it's more than 3 hours, displays “Entire Day” when every hour of a day are selected; displays nothing for less than 3 hours. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `from` | `number` | The first hour of the time range. | @@ -102,7 +102,7 @@ The content of the selected label. By default, displays the time range in the fo ^^^slot-tooltip The tooltip for each hour cell. Displays `${hour}:00–${hour + 1}:00` for current hour by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `day` | `number` | The day of week. `0` denotes Sunday. | diff --git a/one/docs/en-US/components/search-box.md b/one/docs/en-US/components/search-box.md index 830bf8d..f53d964 100644 --- a/one/docs/en-US/components/search-box.md +++ b/one/docs/en-US/components/search-box.md @@ -108,7 +108,7 @@ Whether the suggestion list is expanded (if there are no items in `suggestions`, ^^^slot-suggestions The content of the entire suggestion list. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `suggestions` | `Array<{value: string, label: string}>` | The normalized suggestions from the [`suggestions`](#props-suggestions) prop. | @@ -117,13 +117,13 @@ The content of the entire suggestion list. ^^^slot-suggestion The content of each suggestion option. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The text label of the suggestion option. | | `value` | `string` | The value of the suggestion option. | -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. When `suggestions` is an `Array`, the `label` and `value` of the suggestion option will share the same `string` value. +++ diff --git a/one/docs/en-US/components/select.md b/one/docs/en-US/components/select.md index b3c4378..a8fa71c 100644 --- a/one/docs/en-US/components/select.md +++ b/one/docs/en-US/components/select.md @@ -12,7 +12,7 @@ Available size variants for the [`ui`](#props-ui) prop: `xs` / `s` / `m` / `l`. [[ demo src="/demo/select/size.vue" ]] -### Using embedded `OptionGroup`s & `Option`s +### Embedded options Can be used with embedded `OptionGroup`s & `Option`s. @@ -108,7 +108,7 @@ Whether the dropdown menu is expanded. ^^^slot-before The content before the options in the dropdown layer. No default content. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `value` | `*` | The value of the selected option. | @@ -121,7 +121,7 @@ The content before the options in the dropdown layer. No default content. ^^^slot-label The content of the select button. Displays the `label` of selected option or the text content of the selected embedded option by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the selected option. | @@ -130,26 +130,26 @@ The content of the select button. Displays the `label` of selected option or the | `disabled` | `boolean=` | Whether the option is disabled. | +++ -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-group-label The label text of each option group (option with child `options`). Displays the `label` of the option by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option group. | | `disabled` | `boolean=` | Whether the option group is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-option-label The label text of each option (option without child `options`). Displays the `label` of the option by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option. | @@ -158,13 +158,13 @@ The label text of each option (option without child `options`). Displays the `la | `disabled` | `boolean=` | Whether the option is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ^^^slot-option The entire content area of each option (option without child `options`). Displays the default content of `Options` component by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of the option. | @@ -173,13 +173,13 @@ The entire content area of each option (option without child `options`). Display | `disabled` | `boolean=` | Whether the option is disabled. | +++ -Additionally, custom properties in current option, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current option, apart from the listed ones, will also be passes into the slot props object via `v-bind`. ^^^ ^^^^slot-trigger The entire drop-down trigger area. Displays the select input by default. -+++Scope properties ++++Slot props | Name | Type | Description | | --- | --- | --- | | `attrs` | `Object` | Attributes that need to be output to the trigger element, including `aria-*` / `disabled`, etc., can be output using `v-bind="attrs"`. | @@ -229,5 +229,5 @@ Triggers when the selected option changed. The callback parameter list is `(valu | Name | Description | | -- | -- | -| ``expand`` | Expand the dropdown layer. | -| ``collapse`` | Collapse the dropdown layer. | +| ``expand`` | Expand the dropdown panel. | +| ``collapse`` | Collapse the dropdown panel. | diff --git a/one/docs/en-US/components/slider.md b/one/docs/en-US/components/slider.md index 8250453..8510c0a 100644 --- a/one/docs/en-US/components/slider.md +++ b/one/docs/en-US/components/slider.md @@ -89,7 +89,7 @@ When `parse` and `format` are specified, values can be of any type, and `parse` ^^^slot-thumb The thumb(s) of the slider. Displays a round button by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `index` | `number` | The index of current thumb. | @@ -102,7 +102,7 @@ The thumb(s) of the slider. Displays a round button by default. ^^^slot-tip The entire tooltip for each thumb. Displays a `Tooltip` component with `value` as its content by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `target` | `HTMLElement` | The rendered `Element` for current thumb. | diff --git a/one/docs/en-US/components/steps.md b/one/docs/en-US/components/steps.md index 3b9b599..882f927 100644 --- a/one/docs/en-US/components/steps.md +++ b/one/docs/en-US/components/steps.md @@ -55,14 +55,14 @@ The datasource of steps with item type being `{ label, desc, to, status }`. | Name | Description | | -- | -- | | ``default`` | [^slot-default] | -| ``index`` | The step index. Displays an index value starts from `1`, a success icon for finished steps by default and an error icon for error steps. Resides inside the [`default`](#slots-default) slot and share the same scope properties. | -| ``label`` | The step label. Displays the `label` property by default. Resides inside the [`default`](#slots-default) slot and share the same scope properties. | -| ``desc`` | The step description. Displays the `desc` property by default. Resides inside the [`default`](#slots-default) slot and share the same scope properties. | +| ``index`` | The step index. Displays an index value starts from `1`, a success icon for finished steps by default and an error icon for error steps. Resides inside the [`default`](#slots-default) slot and share the same slot props. | +| ``label`` | The step label. Displays the `label` property by default. Resides inside the [`default`](#slots-default) slot and share the same slot props. | +| ``desc`` | The step description. Displays the `desc` property by default. Resides inside the [`default`](#slots-default) slot and share the same slot props. | ^^^slot-default The content of each step. Displays the step index/completed icon, label and description by default. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The label of the step. Same as the `label` property from items of the [`steps`](#props-steps) prop. | @@ -71,7 +71,7 @@ The content of each step. Displays the step index/completed icon, label and desc | `status` | `string` | The status of the step. Same as the `status` property from items of the [`steps`](#props-steps) prop. | | `index` | `number` | The index of the step. (Starts from `0`.) | -Additionally, custom properties in current step, apart from the listed ones, will also be passes into the scope object via `v-bind`. +Additionally, custom properties in current step, apart from the listed ones, will also be passes into the slot props object via `v-bind`. +++ ^^^ diff --git a/one/docs/en-US/components/table.md b/one/docs/en-US/components/table.md index b7a3df7..d9d66da 100644 --- a/one/docs/en-US/components/table.md +++ b/one/docs/en-US/components/table.md @@ -114,7 +114,7 @@ The values of expanded rows. Each item is the value keyed by the [`key-field`](# ^^^slot-sub-row The content of the expanded sub-row. Will span across all columns and override the [`sub-row`](./column#slots-sub-row) slot of the `Column` components inside the table. -The slot scope properties are the same as each item inside [`data`](#props-data), with an extra `index: number`, which denotes the index within the datasource. +The slot props are the same as each item inside [`data`](#props-data), with an extra `index: number`, which denotes the index within the datasource. ^^^ ### Events diff --git a/one/docs/en-US/components/transfer.md b/one/docs/en-US/components/transfer.md index 6e32191..8c3ba47 100644 --- a/one/docs/en-US/components/transfer.md +++ b/one/docs/en-US/components/transfer.md @@ -125,19 +125,19 @@ Merge strategy for selected values. When all child nodes under a node are select | ``candidate`` | The candidate panel. | | ``candidate-head`` | [^candidate-head] | | ``selected-head`` | [^selected-head] | -| ``candidate-title`` | The title text of the candidate panel. Shares the same scope properties with slot `candidate-head`. | -| ``selected-title`` | The title text of the selected panel. Shares the same scope properties with slot `selected-head`. | +| ``candidate-title`` | The title text of the candidate panel. Shares the same slot props with slot `candidate-head`. | +| ``selected-title`` | The title text of the selected panel. Shares the same slot props with slot `selected-head`. | | ``candidate-no-data`` | The content displayed when there's no data inside the candidate panel. | | ``selected-no-data`` | The content displayed when there's no data inside the selected panel. | | ``candidate-item`` | [^candidate-item] | | ``selected-item`` | [^selected-item] | -| ``candidate-item-label`` | Label text of each item inside the candidate panel. Shares the same scope properties with slot `candidate-item`. | -| ``selected-item-label`` | Label text of each item inside the selected panel. Shares the same scope properties with slot `selected-item` when `selected-show-mode` is `'tree'`. Otherwise this slot specifies custom content for any item along the path for all selected leaf item and shares the same scope properties with slot `candidate-item`. | +| ``candidate-item-label`` | Label text of each item inside the candidate panel. Shares the same slot props with slot `candidate-item`. | +| ``selected-item-label`` | Label text of each item inside the selected panel. Shares the same slot props with slot `selected-item` when `selected-show-mode` is `'tree'`. Otherwise this slot specifies custom content for any item along the path for all selected leaf item and shares the same slot props with slot `candidate-item`. | ^^^candidate-head The head area of the candidate panel. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `count` | `number` | The number of candidate items. | @@ -146,7 +146,7 @@ The head area of the candidate panel. ^^^selected-head The head area of the selected panel. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `count` | `number` | The number of selected items. | @@ -155,7 +155,7 @@ The head area of the selected panel. ^^^candidate-item The content of each item inside the candidate panel. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of current item. | @@ -169,8 +169,8 @@ The content of each item inside the candidate panel. ^^^selected-item The content of each item inside the selected panel. -+++Scope properties -The scope properties will be the same as slot `candidate-item` when `selected-show-mode` is `'tree'`. They'll be as follows when `selected-show-mode` is `'flat'`. ++++Slot props +The slot props will be the same as slot `candidate-item` when `selected-show-mode` is `'tree'`. They'll be as follows when `selected-show-mode` is `'flat'`. | Name | Type | Description | | -- | -- | -- | diff --git a/one/docs/en-US/components/tree.md b/one/docs/en-US/components/tree.md index 4954afb..c19c8fa 100644 --- a/one/docs/en-US/components/tree.md +++ b/one/docs/en-US/components/tree.md @@ -96,14 +96,14 @@ Merge strategy for selected values. When all child nodes under a node are select | Name | Description | | -- | -- | | ``item`` | [^item] | -| ``item-label`` | The label of each node. Shares the same scope properties with the [`item`](#slots-item) slot. | -| ``item-before`` | The area before the label of each node. Shares the same scope properties with the [`item`](#slots-item) slot. | -| ``item-after`` | The area after the label of each node. Shares the same scope properties with the [`item`](#slots-item) slot. | +| ``item-label`` | The label of each node. Shares the same slot props with the [`item`](#slots-item) slot. | +| ``item-before`` | The area before the label of each node. Shares the same slot props with the [`item`](#slots-item) slot. | +| ``item-after`` | The area after the label of each node. Shares the same slot props with the [`item`](#slots-item) slot. | ^^^item The content of each entire node. -+++Scope properties ++++Slot props | Name | Type | Description | | -- | -- | -- | | `label` | `string` | The descriptive label of current node. | @@ -113,7 +113,7 @@ The content of each entire node. | `depth` | `number` | The depth of current node. | +++ -Additionally, custom properties apart from the listed ones will also be passes into the scope object via `v-bind`. +Additionally, custom properties apart from the listed ones will also be passes into the slot props object via `v-bind`. ^^^ ### Events diff --git a/one/docs/en-US/components/uploader.md b/one/docs/en-US/components/uploader.md index 4c77548..8dc482d 100644 --- a/one/docs/en-US/components/uploader.md +++ b/one/docs/en-US/components/uploader.md @@ -190,7 +190,7 @@ Default content: file upload for prompt to select a file, and image upload for u ^^^file Single file area to customize the file content. -+++ scope parameters ++++Slot props | name | type | description | | --- | --- | --- | | `name` | `string` | The name of the file. |