Function surface

surface<
    Props = void,
    Options = Props,
    const Requires extends readonly AnyTag[] = readonly [],
    const Extra extends readonly AnyTag[] = readonly [],
>(
    loader: LoadModule<
        Props,
        Requires,
        readonly [
            MultiTag<any, "org.dxos.app-framework.capability.reactSurface">,
            Extra,
        ],
    >,
    options?: MakerOptions<Requires, Extra, Props, Options> & {
        roles?: readonly Role<any>[];
    },
): Module<Options>
Module maker contributing React surfaces. Declaring roles (the role tokens the module's surfaces bind, e.g. AppSurface.Article or a plugin's <Plugin>Surface tokens) gates the module on those roles' demand events (ActivationEvents.SurfacesRequested) — it loads when a Surface for one of its roles first renders instead of at startup. Modules without declared roles stay eager; an explicit activatesOn wins over the derived gate.
Type Parameters
- Props = void
- Options = Props
- const Requires extends readonly AnyTag[] = readonly []
- const Extra extends readonly AnyTag[] = readonly []
Parameters
- loader: LoadModule<
      Props,
      Requires,
      readonly [
          MultiTag<any, "org.dxos.app-framework.capability.reactSurface">,
          Extra,
      ],
  >
- Optionaloptions: MakerOptions<Requires, Extra, Props, Options> & { roles?: readonly Role<any>[] }
Returns Module<Options>
- Defined in packages/sdk/app-toolkit/src/app-framework/AppCapability.ts:212