Skip to content

Commit e690020

Browse files
vaadin-botvaadin-bot
authored
docs: update state attributes docs to not list part names (#10000) (#10070)
1 parent ab0b47c commit e690020

28 files changed

+192
-192
lines changed

‎packages/checkbox-group/src/vaadin-checkbox-group.d.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,16 @@ export interface CheckboxGroupEventMap extends HTMLElementEventMap, CheckboxGrou
5858
*
5959
* The following state attributes are available for styling:
6060
*
61-
* Attribute | Description | Part name
62-
* --------------------|-------------------------------------------|------------
63-
* `disabled` | Set when the element is disabled | :host
64-
* `readonly` | Set when the element is readonly | :host
65-
* `invalid` | Set when the element is invalid | :host
66-
* `focused` | Set when the element is focused | :host
67-
* `has-label` | Set when the element has a label | :host
68-
* `has-value` | Set when the element has a value | :host
69-
* `has-helper` | Set when the element has helper text | :host
70-
* `has-error-message` | Set when the element has an error message | :host
61+
* Attribute | Description
62+
* --------------------|---------------------------------
63+
* `disabled` | Set when the element is disabled
64+
* `readonly` | Set when the element is readonly
65+
* `invalid` | Set when the element is invalid
66+
* `focused` | Set when the element is focused
67+
* `has-label` | Set when the element has a label
68+
* `has-value` | Set when the element has a value
69+
* `has-helper` | Set when the element has helper text
70+
* `has-error-message` | Set when the element has an error message
7171
*
7272
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
7373
*

‎packages/checkbox-group/src/vaadin-checkbox-group.js‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ registerStyles('vaadin-checkbox-group', checkboxGroupStyles, { moduleId: 'vaadin
3939
*
4040
* The following state attributes are available for styling:
4141
*
42-
* Attribute | Description | Part name
43-
* --------------------|-------------------------------------------|------------
44-
* `disabled` | Set when the element is disabled | :host
45-
* `readonly` | Set when the element is readonly | :host
46-
* `invalid` | Set when the element is invalid | :host
47-
* `focused` | Set when the element is focused | :host
48-
* `has-label` | Set when the element has a label | :host
49-
* `has-value` | Set when the element has a value | :host
50-
* `has-helper` | Set when the element has helper text | :host
51-
* `has-error-message` | Set when the element has an error message | :host
42+
* Attribute | Description
43+
* --------------------|---------------------------------
44+
* `disabled` | Set when the element is disabled
45+
* `readonly` | Set when the element is readonly
46+
* `invalid` | Set when the element is invalid
47+
* `focused` | Set when the element is focused
48+
* `has-label` | Set when the element has a label
49+
* `has-value` | Set when the element has a value
50+
* `has-helper` | Set when the element has helper text
51+
* `has-error-message` | Set when the element has an error message
5252
*
5353
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
5454
*

‎packages/combo-box/src/vaadin-combo-box.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -185,10 +185,10 @@ export interface ComboBoxEventMap<TItem> extends HTMLElementEventMap {
185185
*
186186
* In addition to `<vaadin-text-field>` state attributes, the following state attributes are available for theming:
187187
*
188-
* Attribute | Description | Part name
189-
* ----------|-------------|------------
190-
* `opened` | Set when the combo box dropdown is open | :host
191-
* `loading` | Set when new items are expected | :host
188+
* Attribute | Description
189+
* ----------|----------------------------------------
190+
* `opened` | Set when the combo box dropdown is open
191+
* `loading` | Set when new items are expected
192192
*
193193
* If you want to replace the default `<input>` and its container with a custom implementation to get full control
194194
* over the input field, consider using the [`<vaadin-combo-box-light>`](#/elements/vaadin-combo-box-light) element.

‎packages/combo-box/src/vaadin-combo-box.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,10 @@ registerStyles('vaadin-combo-box', inputFieldShared, { moduleId: 'vaadin-combo-b
116116
*
117117
* In addition to `<vaadin-text-field>` state attributes, the following state attributes are available for theming:
118118
*
119-
* Attribute | Description | Part name
120-
* ----------|-------------|------------
121-
* `opened` | Set when the combo box dropdown is open | :host
122-
* `loading` | Set when new items are expected | :host
119+
* Attribute | Description
120+
* ----------|----------------------------------------
121+
* `opened` | Set when the combo box dropdown is open
122+
* `loading` | Set when new items are expected
123123
*
124124
* If you want to replace the default `<input>` and its container with a custom implementation to get full control
125125
* over the input field, consider using the [`<vaadin-combo-box-light>`](#/elements/vaadin-combo-box-light) element.

‎packages/custom-field/src/vaadin-custom-field.d.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ export interface CustomFieldEventMap extends HTMLElementEventMap, CustomFieldCus
7777
*
7878
* The following state attributes are available for styling:
7979
*
80-
* Attribute | Description | Part name
81-
* --------------------|-------------------------------------------|------------
82-
* `invalid` | Set when the element is invalid | :host
83-
* `focused` | Set when the element is focused | :host
84-
* `has-label` | Set when the element has a label | :host
85-
* `has-value` | Set when the element has a value | :host
86-
* `has-helper` | Set when the element has helper text | :host
87-
* `has-error-message` | Set when the element has an error message | :host
80+
* Attribute | Description
81+
* --------------------|--------------------------------
82+
* `invalid` | Set when the element is invalid
83+
* `focused` | Set when the element is focused
84+
* `has-label` | Set when the element has a label
85+
* `has-value` | Set when the element has a value
86+
* `has-helper` | Set when the element has helper text
87+
* `has-error-message` | Set when the element has an error message
8888
*
8989
* You may also manually set `disabled` or `readonly` attribute on this component to make the label
9090
* part look visually the same as on a `<vaadin-text-field>` when it is disabled or readonly.

‎packages/custom-field/src/vaadin-custom-field.js‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ registerStyles('vaadin-custom-field', customFieldStyles, { moduleId: 'vaadin-cus
3636
*
3737
* The following state attributes are available for styling:
3838
*
39-
* Attribute | Description | Part name
40-
* --------------------|-------------------------------------------|------------
41-
* `invalid` | Set when the element is invalid | :host
42-
* `focused` | Set when the element is focused | :host
43-
* `has-label` | Set when the element has a label | :host
44-
* `has-value` | Set when the element has a value | :host
45-
* `has-helper` | Set when the element has helper text | :host
46-
* `has-error-message` | Set when the element has an error message | :host
39+
* Attribute | Description
40+
* --------------------|--------------------------------
41+
* `invalid` | Set when the element is invalid
42+
* `focused` | Set when the element is focused
43+
* `has-label` | Set when the element has a label
44+
* `has-value` | Set when the element has a value
45+
* `has-helper` | Set when the element has helper text
46+
* `has-error-message` | Set when the element has an error message
4747
*
4848
* You may also manually set `disabled` or `readonly` attribute on this component to make the label
4949
* part look visually the same as on a `<vaadin-text-field>` when it is disabled or readonly.

‎packages/date-time-picker/src/vaadin-date-time-picker.d.ts‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,17 +69,17 @@ export interface DateTimePickerEventMap extends DateTimePickerCustomEventMap, HT
6969
*
7070
* The following state attributes are available for styling:
7171
*
72-
* Attribute | Description | Part name
73-
* --------------------|-------------------------------------------|------------
74-
* `disabled` | Set when the element is disabled | :host
75-
* `focused` | Set when the element is focused | :host
76-
* `focus-ring` | Set when the element is keyboard focused | :host
77-
* `readonly` | Set when the element is readonly | :host
78-
* `invalid` | Set when the element is invalid | :host
79-
* `has-label` | Set when the element has a label | :host
80-
* `has-value` | Set when the element has a value | :host
81-
* `has-helper` | Set when the element has helper text | :host
82-
* `has-error-message` | Set when the element has an error message | :host
72+
* Attribute | Description
73+
* --------------------|---------------------------------
74+
* `disabled` | Set when the element is disabled
75+
* `focused` | Set when the element is focused
76+
* `focus-ring` | Set when the element is keyboard focused
77+
* `readonly` | Set when the element is readonly
78+
* `invalid` | Set when the element is invalid
79+
* `has-label` | Set when the element has a label
80+
* `has-value` | Set when the element has a value
81+
* `has-helper` | Set when the element has helper text
82+
* `has-error-message` | Set when the element has an error message
8383
*
8484
* ### Internal components
8585
*

‎packages/date-time-picker/src/vaadin-date-time-picker.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,17 @@ registerStyles('vaadin-date-time-picker', inputFieldShared, { moduleId: 'vaadin-
4040
*
4141
* The following state attributes are available for styling:
4242
*
43-
* Attribute | Description | Part name
44-
* --------------------|-------------------------------------------|------------
45-
* `disabled` | Set when the element is disabled | :host
46-
* `focused` | Set when the element is focused | :host
47-
* `focus-ring` | Set when the element is keyboard focused | :host
48-
* `readonly` | Set when the element is readonly | :host
49-
* `invalid` | Set when the element is invalid | :host
50-
* `has-label` | Set when the element has a label | :host
51-
* `has-value` | Set when the element has a value | :host
52-
* `has-helper` | Set when the element has helper text | :host
53-
* `has-error-message` | Set when the element has an error message | :host
43+
* Attribute | Description
44+
* --------------------|---------------------------------
45+
* `disabled` | Set when the element is disabled
46+
* `focused` | Set when the element is focused
47+
* `focus-ring` | Set when the element is keyboard focused
48+
* `readonly` | Set when the element is readonly
49+
* `invalid` | Set when the element is invalid
50+
* `has-label` | Set when the element has a label
51+
* `has-value` | Set when the element has a value
52+
* `has-helper` | Set when the element has helper text
53+
* `has-error-message` | Set when the element has an error message
5454
*
5555
* ### Internal components
5656
*

‎packages/grid/src/vaadin-grid-sorter.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ export * from './vaadin-grid-sorter-mixin.js';
4141
*
4242
* The following state attributes are available for styling:
4343
*
44-
* Attribute | Description | Part name
45-
* -------------|-------------|------------
46-
* `direction` | Sort direction of a sorter | :host
44+
* Attribute | Description
45+
* -------------|---------------------------
46+
* `direction` | Sort direction of a sorter
4747
*
4848
* @fires {CustomEvent} direction-changed - Fired when the `direction` property changes.
4949
* @fires {CustomEvent} sorter-changed - Fired when the `path` or `direction` property changes.

‎packages/grid/src/vaadin-grid-sorter.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ import { GridSorterMixin } from './vaadin-grid-sorter-mixin.js';
4141
*
4242
* The following state attributes are available for styling:
4343
*
44-
* Attribute | Description | Part name
45-
* -------------|-------------|------------
46-
* `direction` | Sort direction of a sorter | :host
44+
* Attribute | Description
45+
* -------------|---------------------------
46+
* `direction` | Sort direction of a sorter
4747
*
4848
* @fires {CustomEvent} direction-changed - Fired when the `direction` property changes.
4949
* @fires {CustomEvent} sorter-changed - Fired when the `path` or `direction` property changes.

0 commit comments

Comments
 (0)