Skip to content

Commit 41d351c

Browse files
authored
docs: do not mention dom-repeat and combo-box in items JSDoc (#10048)
1 parent 989b77b commit 41d351c

File tree

4 files changed

+4
-20
lines changed

4 files changed

+4
-20
lines changed

packages/a11y-base/src/list-mixin.d.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,9 @@ export declare class ListMixinClass {
3636
orientation: 'horizontal' | 'vertical';
3737

3838
/**
39-
* The list of items from which a selection can be made.
39+
* A read-only list of items from which a selection can be made.
4040
* It is populated from the elements passed to the light DOM,
4141
* and updated dynamically when adding or removing items.
42-
*
43-
* The item elements must implement `Vaadin.ItemMixin`.
44-
*
45-
* Note: unlike `<vaadin-combo-box>`, this property is read-only,
46-
* so if you want to provide items by iterating array of data,
47-
* you have to use `dom-repeat` and place it to the light DOM.
4842
*/
4943
readonly items: Element[] | undefined;
5044

packages/a11y-base/src/list-mixin.js

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,9 @@ export const ListMixin = (superClass) =>
5656
},
5757

5858
/**
59-
* The list of items from which a selection can be made.
59+
* A read-only list of items from which a selection can be made.
6060
* It is populated from the elements passed to the light DOM,
6161
* and updated dynamically when adding or removing items.
62-
*
63-
* The item elements must implement `Vaadin.ItemMixin`.
64-
*
65-
* Note: unlike `<vaadin-combo-box>`, this property is read-only,
66-
* so if you want to provide items by iterating array of data,
67-
* you have to use `dom-repeat` and place it to the light DOM.
6862
* @type {!Array<!Element> | undefined}
6963
*/
7064
items: {

packages/tabsheet/src/vaadin-tabsheet-mixin.d.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@ export declare class TabSheetMixinClass<Tab extends HTMLElement> {
2121
selected: number | null | undefined;
2222

2323
/**
24-
* The list of `<vaadin-tab>`s from which a selection can be made.
24+
* A read-only list of `<vaadin-tab>`s from which a selection can be made.
2525
* It is populated from the elements passed inside the slotted
2626
* `<vaadin-tabs>`, and updated dynamically when adding or removing items.
27-
*
28-
* Note: unlike `<vaadin-combo-box>`, this property is read-only.
2927
*/
3028
readonly items: Tab[] | undefined;
3129
}

packages/tabsheet/src/vaadin-tabsheet-mixin.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,9 @@ export const TabSheetMixin = (superClass) =>
7979
static get properties() {
8080
return {
8181
/**
82-
* The list of `<vaadin-tab>`s from which a selection can be made.
82+
* A read-only list of `<vaadin-tab>`s from which a selection can be made.
8383
* It is populated from the elements passed inside the slotted
8484
* `<vaadin-tabs>`, and updated dynamically when adding or removing items.
85-
*
86-
* Note: unlike `<vaadin-combo-box>`, this property is read-only.
8785
* @type {!Array<!Tab> | undefined}
8886
*/
8987
items: {

0 commit comments

Comments
 (0)