Skip to content

Commit 8f1cca8

Browse files
authored
docs: update JSDoc for internal Lit based custom elements (#9199)
1 parent 8f59653 commit 8f1cca8

File tree

4 files changed

+83
-20
lines changed

4 files changed

+83
-20
lines changed

packages/combo-box/src/vaadin-lit-combo-box-item.js

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,31 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
1111
import { ComboBoxItemMixin } from './vaadin-combo-box-item-mixin.js';
1212

1313
/**
14-
* LitElement based version of `<vaadin-combo-box-item>` web component.
14+
* An item element used by the `<vaadin-combo-box>` dropdown.
1515
*
16-
* ## Disclaimer
16+
* ### Styling
1717
*
18-
* This component is an experiment and not yet a part of Vaadin platform.
19-
* There is no ETA regarding specific Vaadin version where it'll land.
20-
* Feel free to try this code in your apps as per Apache 2.0 license.
18+
* The following shadow DOM parts are available for styling:
19+
*
20+
* Part name | Description
21+
* ------------|--------------
22+
* `checkmark` | The graphical checkmark shown for a selected item
23+
* `content` | The element that wraps the item content
24+
*
25+
* The following state attributes are exposed for styling:
26+
*
27+
* Attribute | Description
28+
* -------------|-------------
29+
* `selected` | Set when the item is selected
30+
* `focused` | Set when the item is focused
31+
*
32+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
33+
*
34+
* @customElement
35+
* @mixes ComboBoxItemMixin
36+
* @mixes ThemableMixin
37+
* @mixes DirMixin
38+
* @private
2139
*/
2240
export class ComboBoxItem extends ComboBoxItemMixin(ThemableMixin(DirMixin(PolylitMixin(LitElement)))) {
2341
static get is() {

packages/multi-select-combo-box/src/vaadin-lit-multi-select-combo-box-chip.js

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,22 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
1010
import { multiSelectComboBoxChip } from './vaadin-multi-select-combo-box-styles.js';
1111

1212
/**
13-
* LitElement based version of `<vaadin-multi-select-combo-box-chip>` web component.
13+
* An element used by `<vaadin-multi-select-combo-box>` to display selected items.
1414
*
15-
* ## Disclaimer
15+
* ### Styling
1616
*
17-
* This component is an experiment and not yet a part of Vaadin platform.
18-
* There is no ETA regarding specific Vaadin version where it'll land.
19-
* Feel free to try this code in your apps as per Apache 2.0 license.
17+
* The following shadow DOM parts are available for styling:
18+
*
19+
* Part name | Description
20+
* -----------------|-------------
21+
* `label` | Element containing the label
22+
* `remove-button` | Remove button
23+
*
24+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
25+
*
26+
* @customElement
27+
* @extends HTMLElement
28+
* @private
2029
*/
2130
class MultiSelectComboBoxChip extends ThemableMixin(PolylitMixin(LitElement)) {
2231
static get is() {

packages/multi-select-combo-box/src/vaadin-lit-multi-select-combo-box-item.js

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,31 @@ import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
1111
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
1212

1313
/**
14-
* LitElement based version of `<vaadin-multi-select-combo-box-item>` web component.
14+
* An item element used by the `<vaadin-multi-select-combo-box>` dropdown.
1515
*
16-
* ## Disclaimer
16+
* ### Styling
1717
*
18-
* This component is an experiment and not yet a part of Vaadin platform.
19-
* There is no ETA regarding specific Vaadin version where it'll land.
20-
* Feel free to try this code in your apps as per Apache 2.0 license.
18+
* The following shadow DOM parts are available for styling:
19+
*
20+
* Part name | Description
21+
* ------------|--------------
22+
* `checkmark` | The graphical checkmark shown for a selected item
23+
* `content` | The element that wraps the item content
24+
*
25+
* The following state attributes are exposed for styling:
26+
*
27+
* Attribute | Description
28+
* -------------|-------------
29+
* `selected` | Set when the item is selected
30+
* `focused` | Set when the item is focused
31+
*
32+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
33+
*
34+
* @customElement
35+
* @mixes ComboBoxItemMixin
36+
* @mixes ThemableMixin
37+
* @mixes DirMixin
38+
* @private
2139
*/
2240
export class MultiSelectComboBoxItem extends ComboBoxItemMixin(ThemableMixin(DirMixin(PolylitMixin(LitElement)))) {
2341
static get is() {

packages/time-picker/src/vaadin-lit-time-picker-item.js

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,31 @@ import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
1111
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
1212

1313
/**
14-
* LitElement based version of `<vaadin-time-picker-item>` web component.
14+
* An item element used by the `<vaadin-time-picker>` dropdown.
1515
*
16-
* ## Disclaimer
16+
* ### Styling
1717
*
18-
* This component is an experiment and not yet a part of Vaadin platform.
19-
* There is no ETA regarding specific Vaadin version where it'll land.
20-
* Feel free to try this code in your apps as per Apache 2.0 license.
18+
* The following shadow DOM parts are available for styling:
19+
*
20+
* Part name | Description
21+
* ------------|--------------
22+
* `checkmark` | The graphical checkmark shown for a selected item
23+
* `content` | The element that wraps the item content
24+
*
25+
* The following state attributes are exposed for styling:
26+
*
27+
* Attribute | Description
28+
* -------------|-------------
29+
* `selected` | Set when the item is selected
30+
* `focused` | Set when the item is focused
31+
*
32+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
33+
*
34+
* @customElement
35+
* @mixes ComboBoxItemMixin
36+
* @mixes ThemableMixin
37+
* @mixes DirMixin
38+
* @private
2139
*/
2240
export class TimePickerItem extends ComboBoxItemMixin(ThemableMixin(DirMixin(PolylitMixin(LitElement)))) {
2341
static get is() {

0 commit comments

Comments
 (0)