callout

Important contextual warnings

Install

docsloth component add @docsloth/callout@1.0.0

Live package: sha256:584792d30684ff49b50b69c8535eab21256c68c9a43ce20bff7cd02f4122235b with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

Props

The prop schema is normative in packages/contracts/component-props/callout.schema.json.

Example props generated from this schema:

{
  "title": "example-title",
  "tone": "note",
  "body": "example-body",
  "dismissible": true
}

Required props: tone, body.

Example

Example document IR (the block the renderer consumes):

{
  "type": "callout",
  "props": {
    "text": "Important contextual warning kept visible to agents and readers.",
    "tone": "info"
  }
}

Renderer HTML (entities decoded and wrapped for display):

<aside class="ds-callout" data-tone="info">Important contextual warning kept visible to agents and readers.</aside>

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

Specification

Generated from packages/contracts/component-specs/callout.md.

Contract

Production props are normative in ../contracts/component-props/callout.schema.json. The corresponding component-fixtures manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated component-package.json manifest plus props.schema.json (the production props schema, copied byte-for-byte) and spec.md (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

Intended behavior

The React component renders title, body and an explicit tone label, so meaning does not depend on color. Warning and danger notices are always persistent: the current schema does not carry required-step context. Note and success callouts may be dismissed only when dismissible: true. Dismissal is local to the current content; changing title, body, tone or effective permission resets it. No network, model or executor call occurs.

Failure and fallback

Unknown tones use Note. Missing or malformed body has a readable content-unavailable fallback. Author text is escaped. Server output keeps the content visible and omits dismissal controls until hydration, so no-JS readers see the complete notice. The native document renderer remains a static aside; dismissal is provided by the hydrated React component.

Required acceptance cases

Keyboard dismissal only when permitted; danger remains visible. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

Package manifest

Protocol fixture: packages/contracts/component-fixtures/callout.json.

Sources