Skip to content

Commit 36d4286

Browse files
committed
Restore missing docstring for id prop in all components
1 parent c0729a2 commit 36d4286

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

dash/dash-renderer/src/types/component.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@ import {
1111
useDevtoolMenuButtonClassName
1212
} from '../components/error/menu/DevtoolContext';
1313

14+
// Caution: These docstrings appear in the published documentation!
1415
export type BaseDashProps = {
16+
/**
17+
* The ID of this component, used to identify dash components in callbacks.
18+
* The ID needs to be unique across all of the components in an app.
19+
*/
1520
id?: string;
1621
componentPath?: DashLayoutPath;
1722
[key: string]: any;

0 commit comments

Comments
 (0)