Skip to content

Commit f96b33d

Browse files
committed
added docstrings to the new iconRenderer stuff in Title
1 parent a6945f2 commit f96b33d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

packages/widgets/src/title.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,22 @@ class Title<T> {
175175
this._changed.emit(undefined);
176176
}
177177

178+
/**
179+
* Get the icon renderer for the title.
180+
*
181+
* #### Notes
182+
* The default value is undefined.
183+
*/
178184
get iconRenderer(): VirtualElementPass.IRenderer {
179185
return this._iconRenderer;
180186
}
181187

188+
/**
189+
* Set the icon renderer for the title.
190+
*
191+
* #### Notes
192+
* A renderer is an object that supplies a render and unrender function.
193+
*/
182194
set iconRenderer(value: VirtualElementPass.IRenderer) {
183195
if (this._iconRenderer === value) {
184196
return;
@@ -339,6 +351,10 @@ namespace Title {
339351
*/
340352
iconLabel?: string;
341353

354+
/**
355+
* An object that supplies render and unrender functions used
356+
* to create and cleanup the icon of the title.
357+
*/
342358
iconRenderer?: VirtualElementPass.IRenderer;
343359

344360
/**

0 commit comments

Comments
 (0)