Skip to main content

@modular/sdk

511 exports in 5 groups.

Interfaces251

Types210

Functions41

adjustHuefunctionAdjust the hue of a color. Rotates the hue on the color wheel.
agentfunctionDeclare a reusable agent: a name, a system prompt, and optionally a model. This describes an agent, it does not run one.
alphafunctionSet the alpha/opacity of a color.
authProviderfunctionDeclare a sign-in provider for a service this mod talks to. Put the result in the mod's `auth` array.
canvasElementfunctionDeclare a new kind of element the user can place on a document canvas. Renderer-native, like `editorExtension`.
canvasTemplatefunctionDeclare a ready-made canvas element, filled in and named, for the insert menu. A template carries no renderer of its own.
checkfunctionDeclare a self-verification the host runs before it activates the mod. Checks are a gate, not a report.
commandfunctionDeclare an action the user runs from the command palette or a keybinding. Reach for this when a person triggers the behavior.
commandActionIdfunctionTurns a command id into its host action id by adding the `command:` prefix.
commandIdFromActionIdfunctionRecovers the command id from a host action id. Returns `undefined` for a host owned action, which is how you tell the two kinds of id apart.
conditionfunctionDefine a rule that gates whether something is enabled and visible. Declare it once, list it in `defineMod`'s `conditions` slot, and reference the same value from every `when` that needs it.
conditionContextKeyfunctionBuild the workbench context key a mod's condition is published under. The host calls this while registering contributions so `when` clauses in the manifest can name the condition.
contrastfunctionGet a contrasting color (black or white) for text readability. Uses WCAG relative luminance calculation to determine the best contrast.
darkenfunctionDarken a color by a percentage. Works in HSL space for perceptually uniform results.
defineModfunctionThe entry point of the SDK.
defineThemefunctionDefine a theme with full type safety. Creates a theme from a definition where tokens can be: - Literal values (`'#007bff'`, `16`) - References to other tokens (`'$color.brand'`) - Computed functions (`(t) => t.spacing.base * 4`) The returned Theme object provides: - `tokens`: Fully resolved token values with autocomplete - `css`: Generated CSS custom properties string - `extend()`: Method to create derived themes with overrides
editorExtensionfunctionDeclare a node that lives inside the document editor. This is the renderer-native lane.
effectfunctionDeclare background behavior that starts when the mod activates. The body runs once at activation, then again whenever any state or signal it read has changed.
eventfunctionDeclare an event your mod can publish. The payload type is read off `TPayload` by the authoring compiler, so the host validates every emit and every subscriber sees the shape it expects. Use this when your mod is the thing that happened.
eventSchemaNamefunctionName of the generated payload contract behind a declaration. The host reads this when folding a mod's events into its manifest.
eventStabilityfunctionEffective stability of a declaration, falling back to `experimental` when the author left it unset. Registration machinery uses this, not mod code.
keybindingfunctionBind a keyboard shortcut to a command. Pass the `command` value itself when the command lives in the same mod, so the id is written once and a rename cannot break the binding.
keybindingCommandIdfunctionResolve the command id a binding points at, whether it was given a command value or a bare id. Registration machinery uses this while folding the mod.
lightenfunctionLighten a color by a percentage. Works in HSL space for perceptually uniform results.
mixfunctionMix two colors together. Uses linear interpolation in RGB space.
normalizeHostActionIdfunctionResolves a written reference to the canonical id the host dispatches on. A known host action id is returned as is.
promptfunctionDeclare reusable prompt text the user can drop into the composer. Put the result in the mod's top-level `prompts` array.
readModfunction(value: unknown) => Mod
saturatefunctionAdjust the saturation of a color. Works in HSL space.
slashCommandfunctionDeclare a command the user types inside a chat session. The `id` is the name typed after the slash, `description` is the line shown in the typeahead, and `argumentHint` is the placeholder for whatever the user types after the name.
themefunctionRegister a theme so it appears in the workbench theme picker. Purely declarative.
tokenAccessorfunctionCreate a typed token accessor helper for computed functions. This enables autocomplete on the `t` parameter in callbacks. The accessor returns an identity function that preserves the callback type while providing full type inference for the tokens parameter.
toolfunctionDeclare a capability the AI agent can call during a turn. This is the one member of the trio the user does not trigger.
transcriptToEditorPartsfunction(stream: AsyncIterable<AiTranscriptionStreamPart>, options: TranscriptToEditorPartsOptions) => AsyncIterable<{ text: string; type: 'replace' } | { delta: string; type: 'append' } | { text: string; type: 'commit' }>
treeViewfunctionDeclare a panel whose content is a tree the host renders. You supply a data provider, `getChildren` and `getTreeItem`, and the host draws the rows, handles selection, and places any inline actions.
viewfunctionDeclare a panel that docks into a workbench container. You hand the host a module reference, not a mount callback.
walkthroughfunctionDeclare a guided set of onboarding steps the host presents. Declarative, like `theme`: no handler, no code path of yours runs.
widgetfunctionDeclare a floating surface: a heads-up panel, an overlay, or a detached window of its own. Same runtime as `view`.
defineModularThemefunction(definition: ModularThemeDefinition) => ModularTheme
stateSchemaNamefunctionName of the generated type contract behind a declaration. The host reads this when folding a mod's state into its manifest.
stateStabilityfunctionEffective stability of a declaration, falling back to `experimental` when the author left it unset. Registration machinery uses this, not mod code.

Classes4

Values5