@kerfjs/ui 5.0.0-beta.11 → 5.0.0-beta.110

package/dist/button.d.ts

@@ -0,0 +1,121 @@
+import * as kerfjs from 'kerfjs';
+import { K as KerfUiContent } from './semantic-content-BbzjvSu9.js';
+import { BadgeTone } from './badge.js';
+import './css-values.js';
+import './semantic-tone-CdW013KF.js';
+
+/** The color family: `neutral` (default), `brand` for the main action, `success` for a positive one, `danger` for a destructive one. */
+type ButtonTone = 'neutral' | 'brand' | 'success' | 'danger';
+/**
+ * How loudly it asks: `primary` (default) fills the button, `secondary`
+ * outlines it, and `plain` shows only its text until hovered.
+ */
+type ButtonEmphasis = 'primary' | 'secondary' | 'plain';
+/** `default` is the 44px control height; `compact` is 33px with smaller text. */
+type ButtonSize = 'default' | 'compact';
+/** Corner shape: the shared `rounded` control radius (default) or a full `pill`. */
+type ButtonShape = 'rounded' | 'pill';
+/** What a form button does: `button` (default), `submit`, or `reset`. */
+type ButtonType = 'button' | 'submit' | 'reset';
+/** Application `data-*` metadata; the Button's own markers stay protected. */
+type ButtonRootAttributes = Readonly<Record<`data-${string}`, string | undefined>>;
+/** A Button's visible label: text or rendered content, never empty. */
+type ButtonLabel = string | Exclude<KerfUiContent, null | undefined | boolean>;
+/**
+ * A labeled button (its label names it; `ariaLabel` only when the label is
+ * not enough), or an icon-only square named by `ariaLabel`.
+ */
+type ButtonContent = {
+    /** The label. */
+    children: ButtonLabel;
+    /** A leading icon, such as a `LucideIcon`; it is decorative. */
+    icon?: KerfUiContent;
+    ariaLabel?: string;
+} | {
+    children?: undefined;
+    /** The icon of an icon-only square button. */
+    icon: KerfUiContent;
+    /** The accessible name an icon-only button needs. */
+    ariaLabel: string;
+};
+type ButtonProps = ButtonContent & ButtonOptions;
+interface ButtonOptions {
+    tone?: ButtonTone;
+    emphasis?: ButtonEmphasis;
+    size?: ButtonSize;
+    /** Corner shape (default `rounded`). */
+    shape?: ButtonShape;
+    /**
+     * Span the full width of the parent instead of sizing to the label, as on
+     * `SplitButton`. The label stays centered and ellipsizes when it no longer
+     * fits.
+     */
+    fill?: boolean;
+    /**
+     * Make it a toggle: `aria-pressed` reports the state, and a pressed look is
+     * drawn on top of the tone and emphasis. The application owns the state and
+     * flips it in its `action` handler. A link (`href`) cannot be a toggle.
+     */
+    pressed?: boolean;
+    /**
+     * Busy: a spinner replaces the label (which still names it) and the button
+     * reports `aria-busy`. Presses still reach it; the application decides
+     * what a press does while it is busy.
+     */
+    loading?: boolean;
+    disabled?: boolean;
+    /** A form button's behavior (default `button`, which never submits). */
+    type?: ButtonType;
+    name?: string;
+    value?: string;
+    /** The id of the form it belongs to, when it sits outside that form. */
+    form?: string;
+    /** Render a link with button styling instead of a `<button>`. */
+    href?: string;
+    /** Where a link opens. */
+    target?: '_self' | '_blank' | '_parent' | '_top';
+    /** Delegated `data-action` the application handles. */
+    action?: string;
+    /**
+     * Keep the button's focus ring inside its box when an ancestor clips
+     * overflow. The inset ring is two-tone, a surface-colored line inside the
+     * ring color, so it stays visible on a loud fill of the ring's own hue.
+     */
+    focusRingInset?: boolean;
+    /**
+     * A count, short text, or `true` for a text-free dot over the button's
+     * top-trailing corner, such as how many items a filter hides. It stays out
+     * of the accessible name unless `badgeLabel` names it.
+     */
+    badge?: number | string | true;
+    /** Words for the badge ("3 hidden"), added to the button's name. */
+    badgeLabel?: string;
+    /** The badge's tone (default `danger`). */
+    badgeTone?: BadgeTone;
+    /**
+     * Native hover text that says more than the name, such as "More Actions
+     * for report.pdf". An icon-only Button already gets a help tag with its
+     * `ariaLabel` (with `@kerfjs/ui/help-tags-register`); a `title` replaces
+     * that tag.
+     */
+    title?: string;
+    id?: string;
+    className?: string;
+    /** Safe `data-*` metadata (a `data-key`, `data-dialog-close`). */
+    rootAttributes?: ButtonRootAttributes;
+    /** Native named-slot assignment when composed inside a web component. */
+    slot?: string;
+}
+/**
+ * A standalone action button: a native `<button>` (or a link with `href`)
+ * in one of four tones and three emphases, at the 44px control height or
+ * compact, with a label or as an icon-only square, rounded or pill-shaped,
+ * sized to its label or filling its parent's width, and optionally a
+ * `pressed` toggle. Inside a
+ * `ToolbarControlGroup`, use a plain `<button>`, which the group styles; use
+ * Button for a dialog footer, a form, or a standalone action beside other
+ * content.
+ */
+declare function Button({ children, tone, emphasis, size, shape, fill, pressed, icon, loading, disabled, type, name, value, form, href, target, action, focusRingInset, badge, badgeLabel, badgeTone, ariaLabel, title, id, className, rootAttributes, slot, }: ButtonProps): kerfjs.SafeHtml;
+
+export { Button, type ButtonContent, type ButtonEmphasis, type ButtonLabel, type ButtonOptions, type ButtonProps, type ButtonRootAttributes, type ButtonShape, type ButtonSize, type ButtonTone, type ButtonType };

package/dist/button.js

@@ -0,0 +1,7 @@
+export { Button } from './chunk-KPINJHIC.js';
+
+
+
+
+
+//# sourceMappingURL=button.js.map

package/dist/button.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"button.js"}

package/dist/catalog-resources.d.ts

@@ -0,0 +1,50 @@
+import { C as CatalogResource } from './types-DmHWkSd6.js';
+import './toolbar.js';
+import 'kerfjs';
+import './semantic-content-BbzjvSu9.js';
+import './sides-BPSWde0A.js';
+import './pane.js';
+import './scroll-clearance-BikHljTc.js';
+import './css-values.js';
+import './workbench.js';
+import './nav-stack-CU_0dKtI.js';
+import './list.js';
+import './extension-attributes-mu8MFUl0.js';
+import './flex-alignment-4ms8ZbV8.js';
+import './panel-toolbar-vg6Ir5Dy.js';
+import './lucide-icon.js';
+import 'lucide';
+import './toolbar-text.js';
+import './resizable-region.js';
+
+/**
+ * Standard resource labels for a Kerf catalog detail footer. Keep these labels
+ * stable across catalogs so people and AI-generated integrations see the same
+ * choices in the same vocabulary.
+ */
+type CatalogResourceKind = 'demoSource' | 'componentSource' | 'designTemplate' | 'guidance' | 'integrationGuidance';
+type CatalogGuidanceKind = 'guidance' | 'integrationGuidance';
+interface CatalogResourceTarget {
+    href: string;
+    /** Optional monospace detail, normally the repository-relative source path. */
+    detail?: string;
+}
+interface CatalogResourcesInput {
+    /** Required source for the runnable demonstration. */
+    demoSource: CatalogResourceTarget;
+    /** Source for the production component; omit for recipes and integrations. */
+    componentSource?: CatalogResourceTarget;
+    /** Optional design-tool template associated with the component. */
+    designTemplate?: CatalogResourceTarget;
+    /** Required UI or integration guidance. */
+    guidance: CatalogResourceTarget;
+    /** Use `integrationGuidance` when the component implementation is upstream. */
+    guidanceKind?: CatalogGuidanceKind;
+}
+/**
+ * Build the standard catalog resource group in its canonical order: demo,
+ * component, optional design template, then guidance.
+ */
+declare function catalogResources(input: CatalogResourcesInput): CatalogResource[];
+
+export { type CatalogGuidanceKind, type CatalogResourceKind, type CatalogResourceTarget, type CatalogResourcesInput, catalogResources };

package/dist/catalog-resources.js

@@ -0,0 +1,22 @@
+// src/catalog/resources/catalog-resources.ts
+function catalogResources(input) {
+  const resources = [
+    { label: "Demo Source", ...input.demoSource }
+  ];
+  if (input.componentSource)
+    resources.push({
+      label: "Component Source",
+      ...input.componentSource
+    });
+  if (input.designTemplate)
+    resources.push({ label: "Design Template", ...input.designTemplate });
+  resources.push({
+    label: input.guidanceKind === "integrationGuidance" ? "Integration Guidance" : "Guidance",
+    ...input.guidance
+  });
+  return resources;
+}
+
+export { catalogResources };
+
+//# sourceMappingURL=catalog-resources.js.map

package/dist/catalog-resources.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/catalog/resources/catalog-resources.ts"],"names":[],"mappings":";AAuCO,SAAS,iBACd,KAAA,EACmB;AACnB,EAAA,MAAM,SAAA,GAA+B;AAAA,IACnC,EAAE,KAAA,EAAO,aAAA,EAAe,GAAG,MAAM,UAAA;AAAW,GAC9C;AACA,EAAA,IAAI,KAAA,CAAM,eAAA;AACR,IAAA,SAAA,CAAU,IAAA,CAAK;AAAA,MACb,KAAA,EAAO,kBAAA;AAAA,MACP,GAAG,KAAA,CAAM;AAAA,KACV,CAAA;AACH,EAAA,IAAI,KAAA,CAAM,cAAA;AACR,IAAA,SAAA,CAAU,KAAK,EAAE,KAAA,EAAO,mBAAmB,GAAG,KAAA,CAAM,gBAAgB,CAAA;AACtE,EAAA,SAAA,CAAU,IAAA,CAAK;AAAA,IACb,KAAA,EACE,KAAA,CAAM,YAAA,KAAiB,qBAAA,GACnB,sBAAA,GACA,UAAA;AAAA,IACN,GAAG,KAAA,CAAM;AAAA,GACV,CAAA;AACD,EAAA,OAAO,SAAA;AACT","file":"catalog-resources.js","sourcesContent":["import type { CatalogResource } from '../../catalog.js';\n\n/**\n * Standard resource labels for a Kerf catalog detail footer. Keep these labels\n * stable across catalogs so people and AI-generated integrations see the same\n * choices in the same vocabulary.\n */\nexport type CatalogResourceKind =\n  | 'demoSource'\n  | 'componentSource'\n  | 'designTemplate'\n  | 'guidance'\n  | 'integrationGuidance';\n\nexport type CatalogGuidanceKind = 'guidance' | 'integrationGuidance';\n\nexport interface CatalogResourceTarget {\n  href: string;\n  /** Optional monospace detail, normally the repository-relative source path. */\n  detail?: string;\n}\n\nexport interface CatalogResourcesInput {\n  /** Required source for the runnable demonstration. */\n  demoSource: CatalogResourceTarget;\n  /** Source for the production component; omit for recipes and integrations. */\n  componentSource?: CatalogResourceTarget;\n  /** Optional design-tool template associated with the component. */\n  designTemplate?: CatalogResourceTarget;\n  /** Required UI or integration guidance. */\n  guidance: CatalogResourceTarget;\n  /** Use `integrationGuidance` when the component implementation is upstream. */\n  guidanceKind?: CatalogGuidanceKind;\n}\n\n/**\n * Build the standard catalog resource group in its canonical order: demo,\n * component, optional design template, then guidance.\n */\nexport function catalogResources(\n  input: CatalogResourcesInput,\n): CatalogResource[] {\n  const resources: CatalogResource[] = [\n    { label: 'Demo Source', ...input.demoSource },\n  ];\n  if (input.componentSource)\n    resources.push({\n      label: 'Component Source',\n      ...input.componentSource,\n    });\n  if (input.designTemplate)\n    resources.push({ label: 'Design Template', ...input.designTemplate });\n  resources.push({\n    label:\n      input.guidanceKind === 'integrationGuidance'\n        ? 'Integration Guidance'\n        : 'Guidance',\n    ...input.guidance,\n  });\n  return resources;\n}\n"]}

package/dist/catalog.d.ts

@@ -1,119 +1,152 @@
+import * as kerfjs from 'kerfjs';
 import { SafeHtml } from 'kerfjs';
+import { b as CatalogProps } from './types-DmHWkSd6.js';
+export { a as CatalogBackgroundStyle, c as CatalogBrand, d as CatalogEntry, e as CatalogRelated, C as CatalogResource, f as CatalogSecondaryGroup, g as CatalogSection, h as CatalogSettingsConfig, i as CatalogStageRootAttributes, j as CatalogTagFilter, k as CatalogUxReview } from './types-DmHWkSd6.js';
+import { K as KerfUiContent } from './semantic-content-BbzjvSu9.js';
+import './toolbar.js';
+import './sides-BPSWde0A.js';
+import './pane.js';
+import './scroll-clearance-BikHljTc.js';
+import './css-values.js';
+import './workbench.js';
+import './nav-stack-CU_0dKtI.js';
+import './list.js';
+import './extension-attributes-mu8MFUl0.js';
+import './flex-alignment-4ms8ZbV8.js';
+import './panel-toolbar-vg6Ir5Dy.js';
+import './lucide-icon.js';
+import 'lucide';
+import './toolbar-text.js';
+import './resizable-region.js';
 
-/** A reference link shown in the detail footer for the active entry. */
-interface CatalogResource {
-    label: string;
-    href: string;
-    /** Optional monospace detail (e.g. a file path) shown after the label. */
-    detail?: string;
-}
-/** A related entry offered in the detail footer's "Related entries" popup menu. */
-interface CatalogRelated {
-    id: string;
-    name: string;
-    /** Group heading in the menu, e.g. "Uses" / "Used by". */
-    group: string;
-}
-interface CatalogEntry {
-    id: string;
-    name: string;
-    description?: string;
-    resources?: readonly CatalogResource[];
-    related?: readonly CatalogRelated[];
-}
-interface CatalogSection {
-    category: string;
-    entries: readonly CatalogEntry[];
-}
 /**
- * A secondary group of sections shown below the primary sidebar sections with a
- * quieter "ecosystem" treatment (e.g. third-party components). Optionally
- * collapsible — the app owns `expanded` and toggles it from `wireCatalog`'s
- * `onToggleSecondary`.
+ * Controlled, stateless component-catalog shell: a `Workbench` whose left rail
+ * is the catalog navigation and whose work area is the active entry — its
+ * toolbar, description, preview stage, and resource footer. The sidebar's
+ * standard toggle moves into the entry toolbar while it is collapsed, and on
+ * a small screen the sidebar overlays the stage like any Workbench rail.
+ * An entry's `settings` render in a right-rail settings pane beside the stage,
+ * with the same toggle relocation and small-screen overlay.
  */
-interface CatalogSecondaryGroup {
-    label: string;
-    sections: readonly CatalogSection[];
-    /** When true, the group's label is a disclosure toggle controlling `expanded`. */
-    collapsible?: boolean;
-    /** Whether the group is expanded (controlled). Ignored unless `collapsible`. */
-    expanded?: boolean;
-}
-interface CatalogBrand {
-    title: string;
-    subtitle?: string;
-    /** Logo image URL (rendered decorative). Omit for a text-only brand. */
-    logoUrl?: string;
-}
-interface CatalogProps {
-    brand: CatalogBrand;
-    sections: readonly CatalogSection[];
-    /** The controlled active entry id — the app owns this signal. */
-    active: string;
-    /** The rendered preview for the active entry; the app computes it from `active`. */
-    content: SafeHtml;
-    /** Whether the sidebar is collapsed (controlled). */
-    collapsed?: boolean;
-    /** Current theme; when set, a theme toggle is shown that switches to the opposite. Omit to hide it. */
-    theme?: 'light' | 'dark';
-    /** Extra header controls placed before the theme toggle (each a `ToolbarControlGroup`). */
-    headerActions?: SafeHtml;
-    /** A secondary "ecosystem" group of sections below the primary category groups. */
-    secondarySections?: CatalogSecondaryGroup;
-    /** Extra sidebar content below the category groups (and the secondary group). */
-    sidebarFooter?: SafeHtml;
-    /** Status line content shown at the start of the detail footer. */
-    status?: SafeHtml;
-    selectAction?: string;
-    toggleSidebarAction?: string;
-    toggleThemeAction?: string;
-    /** Action fired by the secondary group's disclosure toggle (when collapsible). */
-    toggleSecondaryAction?: string;
-    className?: string;
+declare function Catalog({ id, brand, sections, active, content, collapsed, theme, increasedContrast, reducedMotion, backgroundControl, headerActions, settings, settingsCollapsed, settingsPanel, uxReview, secondarySections, sidebarFooter, status, backgroundStyle, stageRootAttributes, selectAction, toggleSidebarAction, toggleThemeAction, toggleContrastAction, toggleMotionAction, selectBackgroundAction, toggleSecondaryAction, toggleSecondaryFilterAction, toggleSettingsAction, headerPlacement, footerPlacement, sidebar, mainToolbar, footerToolbar, className, slot, }: CatalogProps): kerfjs.SafeHtml;
+
+/** How a specimen aligns its visible edge with its `ListHeader` label. */
+type CatalogExampleAlign = 'glyph' | 'inline-control' | 'text-trigger' | 'none';
+interface CatalogExampleViewport {
+    layout?: 'grid' | 'flex' | 'flex-column';
+    /** Specimen width. `sidebar` (272px, capped at the stage) shows a sidebar
+     *  pane's content at a production rail's width. */
+    width?: 'full' | 'sidebar' | 'compact' | 'medium' | 'wide' | 'text' | 'control';
+    /** Fixed specimen height; `app` frames an application-sized recipe or layout.
+     *  A fixed height is definite, so a child that fills with `height: 100%`
+     *  (a horizontal `ResizableRegion`, say) spans the whole frame. */
+    height?: 'short' | 'reduced' | 'medium' | 'tall' | 'app';
+    /** A minimum the frame may grow past. It is not a definite height: a child
+     *  sized with `height: 100%` falls back to its content height, so use
+     *  `height` when the specimen must fill the frame. `app` (592px) is the
+     *  application frame's height as a floor, for a stage that hosts a
+     *  frame-anchored top-layer specimen above in-flow content. */
+    minHeight?: 'short' | 'medium' | 'app';
+    /** Names the frame as a CSS anchor (`anchor-name`), so a top-layer
+     *  specimen whose own CSS sets `position-anchor` to this dashed-ident
+     *  positions against the frame as it would against its production anchor.
+     *  Anchor names are document-wide: give each frame on a page its own. */
+    anchorName?: `--${string}`;
+    /** Caps each in-flow child at a centered-or-start content column:
+     *  `compact` (440px), `medium` (640px), or `wide` (864px), each capped at
+     *  the frame. `[popover]` children keep their own geometry. Applies to
+     *  block, `grid`, and `flex-column` flows. */
+    contentWidth?: 'compact' | 'medium' | 'wide';
+    /** Where a `contentWidth` column sits in the frame; default `start`. */
+    contentAlign?: 'start' | 'center';
+    frame?: 'solid' | 'dashed';
+    surface?: 'default' | 'lowered';
+    overflow?: 'hidden' | 'auto-x';
+    responsive?: 'roomy-only';
+    shadow?: boolean;
+    /** Public component custom properties applied to the specimen viewport. */
+    tokens?: Readonly<Record<`--${string}`, string>>;
 }
-/**
- * A reusable component-catalog shell: a collapsible category sidebar, a titled
- * detail stage that renders the active entry's preview, and a footer with
- * reference links and a related-entry popup menu. Built entirely from public
- * `@kerfjs/ui` primitives. Controlled and stateless — the app owns the `active`,
- * `collapsed`, and `theme` signals and computes `content` from `active` in its own
- * render; wire the sidebar/collapse/theme actions with `wireCatalog`.
- */
-declare function Catalog({ brand, sections, active, content, collapsed, theme, headerActions, secondarySections, sidebarFooter, status, selectAction, toggleSidebarAction, toggleThemeAction, toggleSecondaryAction, className, }: CatalogProps): SafeHtml;
-/**
- * How a {@link CatalogExample}'s content aligns its visible left edge with the
- * example's `ListHeader` label (which sits 16px in — 8px title + 8px label):
- * - `'glyph'` — a bare glyph/text specimen with no inline geometry insets the full 16px.
- * - `'inline-control'` — a control that already carries ~8px of its own inline padding insets 8px so its content lands on the same line.
- * - `'none'` — a content-item / composition that owns its geometry and already aligns; no inset (default).
- */
-type CatalogExampleAlign = 'glyph' | 'inline-control' | 'none';
+type CatalogExampleRootAttributes = Readonly<Record<`data-${string}`, string | undefined> & {
+    'data-catalog-example'?: never;
+    'data-catalog-example-stack'?: never;
+    'data-catalog-example-label'?: never;
+    'data-catalog-example-note'?: never;
+    'data-align'?: never;
+}>;
 interface CatalogExampleProps {
-    /** The example's label, shown as a `ListHeader` above the specimen. Omit for a bare specimen. */
     label?: string;
-    /** Optional explanatory note between the label and the specimen. */
     note?: SafeHtml | string;
-    /** Alignment inset for the specimen — see {@link CatalogExampleAlign}. Default `'none'`. */
     align?: CatalogExampleAlign;
+    /** Optional catalog-owned constraints for demonstrating layout components. */
+    viewport?: CatalogExampleViewport;
+    /** Replacement guidance shown when a roomy-only viewport is hidden. */
+    compactFallback?: SafeHtml | string;
+    rootAttributes?: CatalogExampleRootAttributes;
     className?: string;
-    children?: SafeHtml | readonly SafeHtml[];
+    children?: KerfUiContent;
+    /** Native named-slot assignment when composed inside a web component. */
+    slot?: string;
 }
 /**
- * One labeled example in a catalog preview: a `ListHeader` label, an optional
- * note, and the specimen. `align` insets the specimen so its visible left edge
- * lines up with the label text, encoding the catalog's alignment rules as a
- * first-class prop instead of per-demo CSS. The inset is published as the
- * `--kui-catalog-example-align` custom property so a debug overlay can exclude it
- * from a specimen's measured margin.
+ * A labeled catalog specimen with optional explanatory text and alignment. A
+ * supplied `label` also names the rendered `section`, so each specimen is an
+ * addressable region; an unlabeled example stays an ordinary grouping.
+ */
+declare function CatalogExample({ label, note, align, viewport, compactFallback, rootAttributes, className, children, slot, }: CatalogExampleProps): SafeHtml;
+
+type CatalogExampleStackRootAttributes = Readonly<Record<`data-${string}`, string | undefined> & {
+    'data-catalog-example'?: never;
+    'data-catalog-example-stack'?: never;
+    'data-catalog-example-label'?: never;
+    'data-catalog-example-note'?: never;
+    'data-align'?: never;
+    'data-width'?: never;
+}>;
+/**
+ * How wide a stack may grow: `reading` (default) caps it at a 736px reading
+ * measure for component specimens; `full` lets it span the stage for
+ * application-width compositions such as boards, app shells, drawers, and
+ * split views.
  */
-declare function CatalogExample({ label, note, align, className, children }: CatalogExampleProps): SafeHtml;
+type CatalogExampleStackWidth = 'reading' | 'full';
 interface CatalogExampleStackProps {
-    /** Accessible label for the stack region. */
     label?: string;
+    /** Maximum width of the stack (default `reading`). */
+    width?: CatalogExampleStackWidth;
+    rootAttributes?: CatalogExampleStackRootAttributes;
     className?: string;
-    children?: SafeHtml | readonly SafeHtml[];
+    children?: KerfUiContent;
+    /** Native named-slot assignment when composed inside a web component. */
+    slot?: string;
 }
-/** A vertically-stacked group of {@link CatalogExample}s with the catalog's example rhythm. */
-declare function CatalogExampleStack({ label, className, children }: CatalogExampleStackProps): SafeHtml;
+/** A vertically stacked group of catalog examples. */
+declare function CatalogExampleStack({ label, width, rootAttributes, className, children, slot, }: CatalogExampleStackProps): kerfjs.SafeHtml;
+
+/**
+ * Browser helpers for UX Review region captures from a catalog. The local
+ * project directory comes from `uxReviewPlugin` (`@kerfjs/ui/vite-ux-review`),
+ * which serves it to the catalog page on a Vite dev or preview server; static
+ * hosting has no such endpoint, so a catalog there shows no capture link.
+ */
+/** Where `uxReviewPlugin` serves `{ projectDirectory }`, relative to the catalog page. */
+declare const UX_REVIEW_PROJECT_PATH = "__ux-review/project.json";
+/** What a UX Review region capture is preset with. */
+interface UxReviewCapture {
+    /** The absolute project directory UX Review files the review under. */
+    projectDirectory: string;
+    /** The review title. */
+    title: string;
+    /** Review context: what was selected and where. */
+    context: string;
+}
+/** A `uxreview://capture` link that starts a region screenshot for a project. */
+declare function uxReviewCaptureUrl({ projectDirectory, title, context, }: UxReviewCapture): string;
+/**
+ * Ask the server that served `pageUrl` for its UX Review project directory.
+ * Resolves `null` when there is none (static hosting, a server without the
+ * plugin, a malformed answer, or a network failure); never rejects.
+ */
+declare function loadUxReviewProject(pageUrl: string | URL, fetchImpl?: typeof globalThis.fetch): Promise<string | null>;
 
-export { Catalog, type CatalogBrand, type CatalogEntry, CatalogExample, type CatalogExampleAlign, type CatalogExampleProps, CatalogExampleStack, type CatalogExampleStackProps, type CatalogProps, type CatalogRelated, type CatalogResource, type CatalogSecondaryGroup, type CatalogSection };
+export { Catalog, CatalogExample, type CatalogExampleAlign, type CatalogExampleProps, CatalogExampleStack, type CatalogExampleStackProps, type CatalogExampleStackWidth, type CatalogExampleViewport, CatalogProps, UX_REVIEW_PROJECT_PATH, type UxReviewCapture, loadUxReviewProject, uxReviewCaptureUrl };