Skip to content

Commit 23271ea

Browse files
authored
docs: improve virtual list item accessible name generator docs (#8356)
1 parent b402736 commit 23271ea

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

packages/virtual-list/src/vaadin-virtual-list-mixin.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ export declare class VirtualListMixinClass<TItem = VirtualListDefaultItem> {
5555

5656
/**
5757
* A function that generates accessible names for virtual list items.
58+
* The function gets the item as an argument and the
59+
* return value should be a string representing that item. The
60+
* result gets applied to the corresponding virtual list child element
61+
* as an `aria-label` attribute.
5862
*/
5963
itemAccessibleNameGenerator?: (item: TItem) => string;
6064

packages/virtual-list/src/vaadin-virtual-list-mixin.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ export const VirtualListMixin = (superClass) =>
3838

3939
/**
4040
* A function that generates accessible names for virtual list items.
41+
* The function gets the item as an argument and the
42+
* return value should be a string representing that item. The
43+
* result gets applied to the corresponding virtual list child element
44+
* as an `aria-label` attribute.
4145
*/
4246
itemAccessibleNameGenerator: {
4347
type: Function,

0 commit comments

Comments
 (0)