Type alias UseCustomWidgetsResult
UseCustomWidgetsResult:
object
Result of the useCustomWidgets hook.
Type declaration
getCustomWidget
getCustomWidget: (customWidgetType) => CustomWidgetComponent | undefined
Gets a custom widget.
Parameters
| Parameter | Type |
|---|---|
customWidgetType | string |
Returns
CustomWidgetComponent | undefined
hasCustomWidget
hasCustomWidget: (customWidgetType) => boolean
Checks if a custom widget is registered.
Parameters
| Parameter | Type |
|---|---|
customWidgetType | string |
Returns
boolean
registerCustomWidget
registerCustomWidget: <T>(customWidgetType, customWidget) => void
Registers a custom widget.
Type parameters
| Parameter | Default |
|---|---|
T | CustomWidgetComponentProps |
Parameters
| Parameter | Type |
|---|---|
customWidgetType | string |
customWidget | CustomWidgetComponent< T > |
Returns
void
unregisterCustomWidget
unregisterCustomWidget: (customWidgetType) => void
Unregisters a legacy custom widget for the given type name.
Parameters
| Parameter | Type |
|---|---|
customWidgetType | string |
Returns
void