zidane-ui/extensions

Draws an extension component behind an error boundary, with the item's fallback in its place when it can't.

Supplies the loader ExtensionComponent resolves components through. ExtensionsProvider's loadModule mounts one.

Shows routed dialogs on the modal layer and toasts in place. Renders nothing without host.dialogs.

One dialog's surface, in a ModalShell (render it on the modal layer). Toasts aren't drawn here.

Draws for with the first extension renderer that draws it, else the default view or the markdown fallback.

Marks the subtree as an extension's UI, for the author hooks. ExtensionComponent sets it; set it yourself to host an extension's UI some other way.

Draws one extension screen's body, or why there is none.

Draws one extension settings page. Draws nothing when no extension offers id.

Draws the extension settings pages and the settings.section slot.

Renders the extensions' locked settings, catalog changes and integrations for the folder in view, over the nearest extensions host (settings, integrations; one left out shows nothing of its part).

One page of an extension's settings: a definition page's rows (its sections, in order), or a SettingsPage item (its component, else its own rows). Draws nothing without an extensions host.

Draws the extension items of one slot. Draws nothing when there are none.

Provides an ExtensionsHost, the ui.tsx loader and optional label overrides to the extension components below it.

The extensions' app.titlebar items: small chips, lowest order first, at most eight per extension. The desktop app puts it in its title bar right of the window controls and the sidebar toggle, the web app in its header. Each item takes clicks inside a window drag region (zg-no-drag), so the bar around it still moves the window. Draws nothing when there are none.

Draws one extension webview with its RPC bridge. Draws nothing when no extension offers id or its URL resolves to null.

Names the session the links below were clicked in, for the extensions' link handlers.

An anchor that opens href in a new tab, offered to the extensions' link handlers first.

Draws settings rows over the settings wire.

The section id of an extension's entry under the Extensions section.

The section id of an extension's own group.

The section id of one page of an extension's own group.

Returns wrap(node), which puts this tree's extensions host, ui.tsx loader and labels around a node rendered elsewhere: the app's modal layer sits above the providers, so a dialog or screen opened on it carries them in.

The extension whose UI renders here. Throws outside an extension's component.

The effect router of the nearest ExtensionsProvider, or null (no provider, or a host without effects).

The component an extension exports under name, once its module loaded: undefined while loading, null when there is none (no loader, a failed load, a missing export).

The items of one token, re-rendering when they change. Empty outside an ExtensionsProvider.

The loader from the nearest ExtensionComponentsProvider, or null.

The extension whose UI renders here, or null outside one.

Returns open(id), which shows an extension screen (or webview) on the modal layer. false when there is no such screen or webview, or no modal layer.

This extension's settings: values, locked keys and a setter.

The extensions' settings entries, groups and search entries for SettingsShell (see the module comment). Empty without an extensions host, or one without settings.

The ExtensionsHost from the nearest ExtensionsProvider, or null outside one.

Returns the extensions components' strings: the defaults merged with any overrides.

The LinkRouter of the nearest extensions host.

A client for one RPC contract: each property is a method (await rpc.add({ n: 1 })). Calls run as this extension's UI, so its own internal methods are allowed. A method's error rejects as an ExtensionsHostError with { code: 'rpc', type, message, data }; without RPC here, unavailable.

A typed store of this extension (ctx.storage.store(name, …) on the backend): its value, and a setter the backend validates. Every window and client sees a write.

The priority of the kit's own effect handlers: above an app's default 0.

Props for ExtensionComponent.

Props for ExtensionComponentsProvider.

Props for ExtensionDialogHost.

Props for ExtensionDialogView.

Options of useExtensionEffects.

What useExtension returns.

Props for ExtensionRenderer.

Props for ExtensionScope.

Props for ExtensionScreen.

Props for ExtensionSettingsPage.

Props for ExtensionSettingsPages.

Props for ExtensionSettingsSection.

What useExtensionSettingsSections returns.

Options of useExtensionSettingsSections.

What useExtensionSettings returns.

Props for ExtensionSettingsWirePage.

Props for ExtensionSlot.

Props for ExtensionsProvider.

Props for ExtensionWebview.

Where a link was opened, as LinkRouter takes it.

Opens links through the extensions' link handlers.

Props for LinkSessionScope.

Props for RoutedLink: an anchor's, plus where it is.

An action row's outcome, as the parent reports it.

Props for SettingsWireForm.

Options of useStore.

Applies one effect: whether it did (or the open panel ids for panel-state; nothing for notify).

Loads an extension's ui.tsx module: its exports by name.

Props for ExtensionTitlebar.

Where a link is, for the router: a source the link handlers see, or 'auth', a sign-in page the router never offers to them.

A contract's methods by name. Type it with your contract's method signatures.

A method of an RPC contract, as useRpc gives it.