sisense.com
✅ You are viewing documentation for the latest version of Compose SDK.
Version:

Type alias UseCustomWidgetsResult

UseCustomWidgetsResult: object

Result of the useCustomWidgets hook.

Type declaration

getCustomWidget

getCustomWidget: (customWidgetType) => CustomWidgetComponent | undefined

Gets a custom widget.

Parameters

ParameterType
customWidgetTypestring

Returns

CustomWidgetComponent | undefined


hasCustomWidget

hasCustomWidget: (customWidgetType) => boolean

Checks if a custom widget is registered.

Parameters

ParameterType
customWidgetTypestring

Returns

boolean


registerCustomWidget

registerCustomWidget: <T>(customWidgetType, customWidget) => void

Registers a custom widget.

Type parameters

ParameterDefault
TCustomWidgetComponentProps

Parameters

ParameterType
customWidgetTypestring
customWidgetCustomWidgetComponent< T >

Returns

void


unregisterCustomWidget

unregisterCustomWidget: (customWidgetType) => void

Unregisters a legacy custom widget for the given type name.

Parameters

ParameterType
customWidgetTypestring

Returns

void

Last Updated: