Skip to content

Commit 7d25fe8

Browse files
authored
docs(tokens): consistency pass for new component descriptions (#12148)
**Related Issue:** n/a ## Summary Updates token documentation for the following components: - `input-number` - `shell-panel` - `stepper-item` - `stepper` - `tabs` - `time-picker`
1 parent 9597394 commit 7d25fe8

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

packages/calcite-components/src/components/input-number/input-number.scss

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
* These properties can be overridden using the component's tag as selector.
55
*
66
* @prop --calcite-input-actions-background-color: Specifies the background color of the component's `clearable` and `number-button-type` elements.
7-
* @prop --calcite-input-actions-background-color-hover: Specifies the background color of the component's `clearable` and `number-button-type` elements. when hovered.
8-
* @prop --calcite-input-actions-background-color-press: Specifies the background color of the component's `clearable` and `number-button-type` elements. when pressed.
7+
* @prop --calcite-input-actions-background-color-hover: Specifies the background color of the component's `clearable` and `number-button-type` elements when hovered.
8+
* @prop --calcite-input-actions-background-color-press: Specifies the background color of the component's `clearable` and `number-button-type` elements when pressed.
99
* @prop --calcite-input-actions-icon-color: Specifies the icon color of the component's `clearable` and `number-button-type` elements.
10-
* @prop --calcite-input-actions-icon-color-hover: Specifies the icon color of the component's `clearable` and `number-button-type` elements. when hovered.
11-
* @prop --calcite-input-actions-icon-color-press: Specifies the icon color of the component's `clearable` and `number-button-type` elements. when pressed.
10+
* @prop --calcite-input-actions-icon-color-hover: Specifies the icon color of the component's `clearable` and `number-button-type` elements when hovered.
11+
* @prop --calcite-input-actions-icon-color-press: Specifies the icon color of the component's `clearable` and `number-button-type` elements when pressed.
1212
* @prop --calcite-input-loading-background-color: Specifies the background color of the `loading` element.
1313
* @prop --calcite-input-loading-fill-color: Specifies the fill color of the `loading` element.
1414
* @prop --calcite-input-number-background-color: Specifies the background color of the component.

packages/calcite-components/src/components/shell-panel/shell-panel.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*
66
* @prop --calcite-shell-panel-background-color: Specifies the background color of the component.
77
* @prop --calcite-shell-panel-border-color: When `displayMode` is `"float-all"`, specifies the component's border color.
8-
* @prop --calcite-shell-panel-corner-radius: When `displayMode` is `"float-all"`, specifies the component's corner radius
8+
* @prop --calcite-shell-panel-corner-radius: When `displayMode` is `"float-all"`, specifies the component's corner radius.
99
* @prop --calcite-shell-panel-height: When `layout` is `horizontal`, or `layout` is `vertical` and `displayMode` is `float-content` or `float`, specifies the height of the component.
1010
* @prop --calcite-shell-panel-max-height: When `layout` is `horizontal`, or `layout` is `vertical` and `displayMode` is `float-content` or `float`, specifies the maximum height of the component.
1111
* @prop --calcite-shell-panel-max-width: Specifies the maximum width of the component.

packages/calcite-components/src/components/stepper-item/stepper-item.scss

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
* @prop --calcite-stepper-bar-fill-color: Specifies the component's fill color.
1818
* @prop --calcite-stepper-bar-fill-color-hover: Specifies the component's fill color when hovered or focused.
1919
* @prop --calcite-stepper-bar-complete-fill-color: Specifies the component's fill color when complete.
20-
* @prop --calcite-stepper-bar-complete-fill-color-hover: When item is complete, specifies the component's fill color when hovered or focused.
20+
* @prop --calcite-stepper-bar-complete-fill-color-hover: When the component is `complete`, specifies the component's fill color when hovered or focused.
2121
* @prop --calcite-stepper-bar-error-fill-color: Specifies the component's fill color when in error.
22-
* @prop --calcite-stepper-bar-error-fill-color-hover: When item is error, specifies the component's fill color when hovered or focused.
22+
* @prop --calcite-stepper-bar-error-fill-color-hover: When the component contains an `error`, specifies the component's fill color when hovered or focused.
2323
* @prop --calcite-stepper-bar-selected-fill-color: Specifies the component's fill color when selected.
2424
*/
2525

packages/calcite-components/src/components/stepper/stepper.scss

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
*
44
* These properties can be overridden using the component's tag as selector.
55
*
6-
* @prop --calcite-stepper-bar-gap: Specifies the space between items in the step bar.
7-
* @prop --calcite-stepper-bar-inactive-fill-color: Specifies the fill color of items in the step bar.
8-
* @prop --calcite-stepper-bar-active-fill-color: Specifies the fill color of active items in the step bar.
9-
* @prop --calcite-stepper-bar-complete-fill-color: Specifies the fill color of complete items in the step bar.
10-
* @prop --calcite-stepper-bar-error-fill-color: Specifies the fill color of error items in the step bar.
6+
* @prop --calcite-stepper-bar-gap: Specifies the space between items in the component.
7+
* @prop --calcite-stepper-bar-inactive-fill-color: Specifies the fill color of items in the component.
8+
* @prop --calcite-stepper-bar-active-fill-color: Specifies the fill color of active items in the component.
9+
* @prop --calcite-stepper-bar-complete-fill-color: Specifies the fill color of complete items in the component.
10+
* @prop --calcite-stepper-bar-error-fill-color: Specifies the fill color of error items in the component.
1111
*/
1212

1313
:host([scale="s"]) {

packages/calcite-components/src/components/tabs/tabs.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* These properties can be overridden using the component's tag as selector.
55
*
6-
* @prop --calcite-tab-background-color: When `bordered`, specifies the component's background color.
6+
* @prop --calcite-tab-background-color: When `bordered`, specifies the component's background color when `bordered`.
77
* @prop --calcite-tab-border-color: Specifies the component's border color.
88
*/
99

packages/calcite-components/src/components/time-picker/time-picker.scss

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
*
44
* These properties can be overridden using the component's tag as selector.
55
*
6-
* @prop --calcite-time-picker-background-color: The background color of the time picker.
7-
* @prop --calcite-time-picker-corner-radius: The border radius of the time picker.
6+
* @prop --calcite-time-picker-background-color: Specifies the background color of the time picker.
7+
* @prop --calcite-time-picker-corner-radius: Specifies the border radius of the time picker.
88
* @prop --calcite-time-picker-button-background-color-hover: Specifies the button's background color when hovered or focused.
99
* @prop --calcite-time-picker-button-background-color-press: Specifies the button's background color when active.
1010
* @prop --calcite-time-picker-color: Specifies the component's text color.

0 commit comments

Comments
 (0)