Skip to content

Interface: MakaioWebUiRoute<TLoaderData, TActions>

Makaio Framework


Makaio Framework / contracts / MakaioWebUiRoute

Interface: MakaioWebUiRoute<TLoaderData, TActions>

Section titled “Interface: MakaioWebUiRoute<TLoaderData, TActions>”

Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:101

WebUI route definition for packages.

Defines a route with path, optional loader/actions, and a lazy-loaded React component. Provides full TypeScript inference for component props.

TLoaderData = unknown

Type of data returned by the loader.

TActions extends MakaioWebUiActions | undefined = undefined

Record of available actions (or undefined if none).

optional actions?: TActions

Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:107

Optional action handlers.


component: () => Promise<{ default: ComponentType<MakaioWebUiComponentProps<TLoaderData, TActions extends MakaioWebUiActions ? TActions : Record<string, never>>>; }>

Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:114

Lazy component loader — called only browser-side.

Must return a module with a default export of a React component that accepts the inferred MakaioWebUiComponentProps.

Promise<{ default: ComponentType<MakaioWebUiComponentProps<TLoaderData, TActions extends MakaioWebUiActions ? TActions : Record<string, never>>>; }>


optional loader?: MakaioWebUiLoader<TLoaderData>

Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:105

Optional data loader.


path: string

Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:103

Route path relative to the package mount point.