Bootstrap

API widget

useWidget

function

useWidget<W>(createWidget, props, propsConfig?): WidgetSlotContext<W>

The useWidget function.

Allows to create and attach an agnos-ui/core widget to the current react component.

Type Parameters

W extends Widget<object, object, object, object>

The type of the widget.

Parameters

createWidget: WidgetFactory<W>

the widget factory

props: Partial<WidgetProps<W>> = {}

the props

propsConfig?: PropsConfig<WidgetProps<W>>

the props config

Returns

WidgetSlotContext<W>

the state and api to track and interact with the widget