Skip to content
This repository was archived by the owner on Nov 6, 2019. It is now read-only.

Commit 5a6b022

Browse files
committed
Add documentation for createTabKey.
1 parent 8abf54a commit 5a6b022

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

packages/widgets/src/tabbar.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1318,6 +1318,17 @@ namespace TabBar {
13181318
*/
13191319
renderTab(data: IRenderData<T>): VirtualElement;
13201320

1321+
/**
1322+
* Create a stable unique id for a tab based on the title.
1323+
*
1324+
* @param data - The data to use for the tab.
1325+
*
1326+
* @returns The unique id for a tab.
1327+
*
1328+
* #### Notes
1329+
* This method returns a stable unique id for a tab, depending only on the
1330+
* title. The tab DOM `id` is set to this value.
1331+
*/
13211332
createTabKey(data: IRenderData<T>): string;
13221333
}
13231334

0 commit comments

Comments
 (0)