defineWidget - Fluid

defineWidget(options: DefineWidgetOptions<Name, Props>): SourceWidget<Name, Props>

Defines one widget and derives its enforced capability declarations.

const greeting = defineWidget({
  name: "greeting",
  displayName: "Greeting",
  component: Greeting,
  defaultProps: { message: "Hello" },
  uses: [getUserAccount],
});

Parameters

DefineWidgetOptions<Name, Props>

required

Type: DefineWidgetOptionsComponent, builder metadata, defaults, property schema, and typed capability uses.

Returns

SourceWidget The normalized widget used by defineWidgetPackage.