@servicetitan/anvil2 3.15.0 → 3.15.1

package/dist/src/beta/components/Page/PagePanelContent.d.ts

@@ -1,46 +1,14 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the PagePanelContent component
- * @extends ComponentPropsWithoutRef<"div">
- */
+/** @extends ComponentPropsWithoutRef<"div"> */
 export type PagePanelContentProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * When true, the content will stick below the header during scroll, acting as a second header.
-     * @default false
-     */
+    /** Pins this region below Panel.Header while the panel scrolls. Defaults to `false`. */
     sticky?: boolean;
 };
 /**
- * Content container for the panel that holds the main scrollable content area.
- *
- * Features:
- * - Grows to fill the space between the panel's header and footer
- * - Scrolls independently of the header and footer once content overflows
- * - Optional sticky positioning below the header, for a second sticky region (e.g. a filter bar)
- * - Proper semantic HTML structure
- * - Consistent padding and styling with the design system
- * - Supports all standard div element props
- *
- * @example
- * // Basic content
- * <Page.Panel.Content>
- *   <Text>Panel content goes here</Text>
- * </Page.Panel.Content>
- *
- * @example
- * // Sticky content (e.g., a search field that remains visible while scrolling)
- * <Page.Panel.Header>Panel Title</Page.Panel.Header>
- * <Page.Panel.Content sticky>
- *   <TextField placeholder="Filter results..." />
- * </Page.Panel.Content>
- * <Page.Panel.Content>
- *   <Text>Scrollable results</Text>
- * </Page.Panel.Content>
+ * Panel content region. Sticky regions offset themselves by the current
+ * Panel.Header height.
  */
 export declare const PagePanelContent: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    /**
-     * When true, the content will stick below the header during scroll, acting as a second header.
-     * @default false
-     */
+    /** Pins this region below Panel.Header while the panel scrolls. Defaults to `false`. */
     sticky?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/beta/components/Page/PagePanelFooter.d.ts

@@ -1,34 +1,11 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the PagePanelFooter component
- * @extends ComponentPropsWithoutRef<"footer">
- */
+/** @extends ComponentPropsWithoutRef<"footer"> */
 export type PagePanelFooterProps = ComponentPropsWithoutRef<"footer"> & {
-    /**
-     * When true, the footer will stick to the bottom of the panel's scrollable area.
-     * @default false
-     */
+    /** Pins the footer to the bottom of the panel. Defaults to `false`. */
     sticky?: boolean;
 };
-/**
- * Footer component for the panel that displays action buttons and controls.
- *
- * Features:
- * - Flex layout that right-aligns action buttons and wraps on overflow
- * - Optional sticky positioning at the bottom of the panel
- * - Proper semantic HTML structure
- * - Consistent padding and styling with the design system
- * - Supports all standard footer element props
- *
- * @example
- * <Page.Panel.Footer sticky>
- *   <Button appearance="primary" onClick={handleSave}>Save</Button>
- * </Page.Panel.Footer>
- */
+/** Panel footer that right-aligns and wraps controls, with optional pinning. */
 export declare const PagePanelFooter: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & {
-    /**
-     * When true, the footer will stick to the bottom of the panel's scrollable area.
-     * @default false
-     */
+    /** Pins the footer to the bottom of the panel. Defaults to `false`. */
     sticky?: boolean;
 } & import('react').RefAttributes<HTMLElement>>;

package/dist/src/beta/components/Page/PagePanelHeader.d.ts

@@ -1,21 +1,8 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the PagePanelHeader component
- * @extends ComponentPropsWithoutRef<"header">
- */
+/** @extends ComponentPropsWithoutRef<"header"> */
 export type PagePanelHeaderProps = ComponentPropsWithoutRef<"header">;
 /**
- * Header component for the panel that stays pinned to the top of the panel's scrollable area.
- *
- * Features:
- * - Sticky positioning at the top of the panel's scrollable content
- * - Proper semantic HTML structure
- * - Consistent padding and styling with the design system
- * - Supports all standard header element props
- *
- * @example
- * <Page.Panel.Header>
- *   <Text variant="headline" el="h3">Panel Title</Text>
- * </Page.Panel.Header>
+ * Panel header pinned above its scrolling regions. Its measured height offsets
+ * sticky Panel.Content regions.
  */
 export declare const PagePanelHeader: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & import('react').RefAttributes<HTMLElement>>;

package/dist/src/beta/components/Page/PageSidebar.d.ts

@@ -1,57 +1,24 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the PageSidebar component
  * @extends ComponentPropsWithoutRef<"div">
  */
 export type PageSidebarProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * Key for storing sidebar collapsed state in localStorage
-     * @default "sidebar-collapsed"
-     */
+    /** Persists desktop collapsed state under this localStorage key. Defaults to `"sidebar-collapsed"`. */
     localStorageKey?: string;
-    /**
-     * Custom tracking ID for analytics
-     */
+    /** Overrides the generated tracking ID on the desktop toggle button. */
     ["data-tracking-id"]?: string;
-    /**
-     * Title to display in the adaptive trigger button
-     */
+    /** Smaller-page trigger text. Defaults to `"Menu"`. */
     currentPageTitle?: string;
 };
 /**
- * PageSidebar component for creating collapsible navigation sidebars.
- *
- * Features:
- * - Collapsible sidebar with localStorage persistence
- * - Responsive design with adaptive popover on mobile
- * - Automatic tracking ID generation for analytics
- * - Keyboard navigation and accessibility support
- * - Toggle button with tooltip
- * - Context provider for sidebar state
- * - Mobile-friendly popover navigation
- *
- * @example
- * <Page.Sidebar currentPageTitle="Navigation">
- *   <Page.SidebarHeader>
- *     <Text variant="headline" el="h2">Sidebar Title</Text>
- *   </Page.SidebarHeader>
- *   <SideNav>
- *     <SideNavLink pathname="/">Home</SideNavLink>
- *   </SideNav>
- * </Page.Sidebar>
+ * Collapsible desktop sidebar with persisted state. On smaller pages it
+ * becomes a popover whose trigger shows `currentPageTitle`.
  */
 export declare const PageSidebar: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    /**
-     * Key for storing sidebar collapsed state in localStorage
-     * @default "sidebar-collapsed"
-     */
+    /** Persists desktop collapsed state under this localStorage key. Defaults to `"sidebar-collapsed"`. */
     localStorageKey?: string;
-    /**
-     * Custom tracking ID for analytics
-     */
+    /** Overrides the generated tracking ID on the desktop toggle button. */
     "data-tracking-id"?: string;
-    /**
-     * Title to display in the adaptive trigger button
-     */
+    /** Smaller-page trigger text. Defaults to `"Menu"`. */
     currentPageTitle?: string;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/beta/components/Page/PageSidebarHeader.d.ts

@@ -1,23 +1,5 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the PageSidebarHeader component
- * @extends ComponentPropsWithoutRef<"div">
- */
+/** @extends ComponentPropsWithoutRef<"div"> */
 export type PageSidebarHeaderProps = ComponentPropsWithoutRef<"div">;
-/**
- * PageSidebarHeader component for creating header sections within sidebars.
- *
- * Features:
- * - Container for sidebar header content
- * - Automatic visibility handling based on sidebar collapsed state
- * - Supports all standard div props
- * - Context-aware styling
- *
- * @example
- * <Page.SidebarHeader>
- *   <Text variant="headline" el="h2" size="medium">
- *     Sidebar Title
- *   </Text>
- * </Page.SidebarHeader>
- */
+/** Sidebar heading region hidden from accessibility when the sidebar collapses. */
 export declare const PageSidebarHeader: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/beta/components/Page/internal/PagePanelContext.d.ts

@@ -1,11 +1,6 @@
 import { RefObject } from 'react';
-/**
- * Context props for the PagePanel component
- */
 export type PagePanelContextProps = {
-    /**
-     * Reference to the panel header element for sticky content positioning.
-     */
+    /** Header element measured to offset sticky content. */
     headerRef?: RefObject<HTMLElement>;
 };
 export declare const PagePanelContext: import('react').Context<PagePanelContextProps>;

package/dist/src/beta/components/Page/pageBreakpoint.d.ts

@@ -1,25 +1,12 @@
 /**
- * The Page's `lg` breakpoint width in px — the boundary between the stacked
- * "mobile" layout (sidebar collapses to a popover trigger, panel becomes a
- * dialog) and the desktop layout. Parsed once from the design token; falls
- * back to `0` if the token is unavailable.
- *
- * Single source of truth for every width-driven layout decision in Page
- * (`PageSidebar`, `PagePanel`, `PageContent`) so they can never drift apart.
+ * Shared Page boundary between the adaptive and desktop layouts. Parsing once
+ * keeps Sidebar, Panel, and Content decisions aligned.
  */
 export declare const PAGE_LG_BREAKPOINT: number;
-/**
- * Whether the given page width should use the mobile layout (below `lg`).
- * Used by `PageSidebar`/`PagePanel` to swap to their popover/dialog forms.
- */
+/** Whether the page width uses the adaptive Sidebar and Panel forms. */
 export declare const isPageMobileWidth: (pageWidth: number | undefined) => boolean;
 /**
- * Whether `Page`'s content wrapper — the `main` landmark every `Page.Content`
- * portals into — is a native scroll container (desktop, `lg` and above). Below
- * `lg`, `Page` is stacked into a single mobile column and the whole document
- * scrolls together, so the wrapper stays in normal flow instead of becoming an
- * independently-scrolling, keyboard-focusable region — matching when `Page`'s
- * stylesheet switches `.sidebar`/`.panel` into their own sticky, self-scrolling
- * desktop layout.
+ * Whether Page's main landmark is an independent keyboard-focusable scroll
+ * region. Requires a parsed breakpoint and a measured desktop width.
  */
 export declare const isPageContentScrollContainerActive: (pageWidth: number | undefined) => boolean;

package/dist/src/beta/components/RichTextEditor/RichTextEditor.d.ts

@@ -1,29 +1,6 @@
 import { RichTextEditorProps } from './types';
 /**
- * RichTextEditor component for authoring formatted content.
- *
- * Features:
- * - Supports both controlled (`value`) and uncontrolled (`defaultValue`) modes
- * - Emits content as HTML (`onChange`), TipTap JSON (`onJsonChange`), and markdown (`onMarkdownChange`)
- * - Accepts markdown as input via `contentType="markdown"`
- * - Extensible via `extensions` for custom nodes/marks not covered by the built-in toolbar
- * - Text formatting toolbar: bold, italic, underline, strikethrough, inline code, blockquote
- * - Headings (H1–H3), paragraph, font size, text alignment, and indentation
- * - Bullet lists, ordered lists, and checklists
- * - Link insertion and removal via popover
- * - Image upload and YouTube video embedding via Insert dropdown (`allowMedia`), with `src` restricted to `http`/`https` by default (`isAllowedImageSrc`)
- * - Drag handle for reordering content blocks (`allowDragDrop`)
- * - @mention typeahead with hover card support (`allowMention`)
- * - Disabled state disables both toolbar and editor content
- * - Field-level label, hint, description, and error messaging
- * - Accessible toolbar with ARIA roles, `aria-pressed` toggles, and keyboard navigation
- * - Built on TipTap (ProseMirror) with Shadow DOM support
- *
- * @example
- * <RichTextEditor
- *   label="Notes"
- *   defaultValue="<p>Hello world</p>"
- *   onChange={(html) => console.log(html)}
- * />
+ * Formatted text field with controlled and uncontrolled document modes.
+ * Emits HTML after each update, with optional TipTap JSON and markdown output.
  */
 export declare const RichTextEditor: import('react').ForwardRefExoticComponent<RichTextEditorProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/beta/components/RichTextEditor/internal/LinkPopover.d.ts

@@ -7,6 +7,7 @@ type LinkPopoverProps = {
     onRemove: () => void;
     onCancel: () => void;
 };
+/** Link fields anchored by a hidden, zero-height trigger at `anchorRect`. */
 export declare const LinkPopover: {
     ({ open, anchorRect, initialHref, initialDisplayText, onSave, onRemove, onCancel, }: LinkPopoverProps): import("react/jsx-runtime").JSX.Element;
     displayName: string;

package/dist/src/beta/components/RichTextEditor/internal/MentionList.d.ts

@@ -10,5 +10,6 @@ type MentionListProps = {
     command: (item: RichTextEditorMentionOption) => void;
     renderOption?: (option: RichTextEditorMentionOption) => ReactNode;
 };
+/** Suggestion rows; Arrow/Enter arrive through the ref from TipTap, not DOM. */
 export declare const MentionList: import('react').ForwardRefExoticComponent<MentionListProps & import('react').RefAttributes<MentionListRef>>;
 export {};

package/dist/src/beta/components/RichTextEditor/internal/MentionPopover.d.ts

@@ -12,5 +12,6 @@ type MentionPopoverProps = {
     command: ((item: RichTextEditorMentionOption) => void) | null;
     renderOption?: (option: RichTextEditorMentionOption) => ReactNode;
 };
+/** Typeahead list anchored by a hidden, zero-height trigger at the caret rect. */
 export declare const MentionPopover: import('react').ForwardRefExoticComponent<MentionPopoverProps & import('react').RefAttributes<MentionPopoverRef>>;
 export {};

package/dist/src/beta/components/RichTextEditor/internal/RichTextEditorToolbar.d.ts

@@ -1 +1,2 @@
+/** Formatting toolbar from editor context. Returns null when no section flag is enabled. */
 export declare const RichTextEditorToolbar: () => import("react/jsx-runtime").JSX.Element | null;

package/dist/src/beta/components/RichTextEditor/internal/YouTubeEmbedPrompt.d.ts

@@ -4,6 +4,7 @@ type YouTubeEmbedPromptProps = {
     onEmbed: () => void;
     onDismiss: () => void;
 };
+/** Confirm converting a pasted YouTube URL into an embed. */
 export declare const YouTubeEmbedPrompt: {
     ({ open, anchorRect, onEmbed, onDismiss, }: YouTubeEmbedPromptProps): import("react/jsx-runtime").JSX.Element;
     displayName: string;

package/dist/src/beta/components/RichTextEditor/internal/YouTubePopover.d.ts

@@ -4,6 +4,7 @@ type YouTubePopoverProps = {
     onSave: (url: string) => void;
     onCancel: () => void;
 };
+/** YouTube URL field anchored by a hidden trigger at `anchorRect`. */
 export declare const YouTubePopover: {
     ({ open, anchorRect, onSave, onCancel, }: YouTubePopoverProps): import("react/jsx-runtime").JSX.Element;
     displayName: string;

package/dist/src/beta/components/RichTextEditor/internal/extensions/ImageUploadExtension.d.ts

@@ -1,3 +1,4 @@
 import { MutableRefObject } from 'react';
 export declare const DEFAULT_ALLOWED_MIME_TYPES: `image/${string}`[];
+/** Paste/drop images through `onImageUploadRef` and insert the returned URLs. */
 export declare const createImageUploadExtension: (onImageUploadRef: MutableRefObject<((files: File[], onComplete: (srcs: string[]) => void) => void) | undefined>, allowedMimeTypes?: `image/${string}`[]) => import('@tiptap/core').Extension<Omit<import('@tiptap/extension-file-handler').FileHandlePluginOptions, "key" | "editor">, any>;

package/dist/src/beta/components/RichTextEditor/internal/extensions/LinkKeyboardShortcutExtension.d.ts

@@ -5,4 +5,5 @@ export type OpenLinkPopover = (params: {
     href: string;
     displayText: string;
 }) => void;
+/** Mod-k opens the link popover at the selection; it does not set the mark. */
 export declare const createLinkKeyboardShortcutExtension: (openLinkPopoverRef: MutableRefObject<OpenLinkPopover | null>) => Extension<any, any>;

package/dist/src/beta/components/RichTextEditor/internal/extensions/MentionExtension.d.ts

@@ -1,5 +1,6 @@
 import { MutableRefObject, Dispatch, SetStateAction, ReactNode } from 'react';
 import { RichTextEditorMentionOption } from '../../types';
+/** Insert-mention spacing; includes C0 and U+2000–U+2029, not a JS `\s` alias. */
 export declare const UNICODE_WHITESPACE_PATTERN = "[\0- \u00A0\u1680\u180E\u2000-\u2029\u205F\u3000]";
 export declare const UNICODE_WHITESPACE_REGEX: RegExp;
 export type MentionState = {
@@ -15,4 +16,8 @@ export type MentionCallbacks = {
     onKeyDown: (event: KeyboardEvent) => boolean;
     getRenderHoverContent: () => ((option: RichTextEditorMentionOption) => ReactNode) | undefined;
 };
+/**
+ * `onQueryChange` may refresh options later; this `items` pass still filters
+ * the current `getOptions()` snapshot.
+ */
 export declare const createMentionExtension: (callbacksRef: MutableRefObject<MentionCallbacks>) => import('@tiptap/core').Node<import('@tiptap/extension-mention').MentionOptions<any, import('@tiptap/extension-mention').MentionNodeAttrs>, any>;

package/dist/src/beta/components/RichTextEditor/internal/extensions/SafeImageExtension.d.ts

@@ -1,13 +1,6 @@
 /**
- * Wraps TipTap's Image extension to restrict `src` to an allowed set of URI
- * schemes/hosts (http/https only by default). `@tiptap/extension-image` only
- * blocks `data:` at HTML-parse time and otherwise allows any scheme or host,
- * including third-party tracking-pixel hosts.
- *
- * Disallowed `src` values are stripped from the document model (set to `null`)
- * on every entry path — HTML (`parseHTML`), markdown (`parseMarkdown`), and
- * programmatic insert/JSON (`appendTransaction`) — so they never reach
- * `onJsonChange` / `onMarkdownChange`. `renderHTML` still paints a blocked
- * placeholder for nodes whose `src` was cleared.
+ * Image node that runs `src` through `isAllowedSrc` (http/https by default).
+ * HTML parse drops a disallowed `img`; markdown and programmatic inserts keep
+ * the node with `src` cleared so `renderHTML` can show a blocked placeholder.
  */
 export declare const createSafeImageExtension: (isAllowedSrc?: (src: string) => boolean) => import('@tiptap/core').Node<import('@tiptap/extension-image').ImageOptions, any>;

package/dist/src/beta/components/RichTextEditor/internal/extensions/YoutubeExtension.d.ts

@@ -5,4 +5,8 @@ export type OnYoutubePaste = (params: {
     from: number;
     to: number;
 }) => void;
+/**
+ * Pasted YouTube URLs stay as linked text and open the embed prompt instead of
+ * inserting an iframe immediately.
+ */
 export declare const createYoutubeExtension: (onYoutubePasteRef: MutableRefObject<OnYoutubePaste>) => import('@tiptap/core').Node<import('@tiptap/extension-youtube').YoutubeOptions, any>;

package/dist/src/beta/components/RichTextEditor/internal/useRichTextEditor.d.ts

@@ -4,12 +4,8 @@ import { OnYoutubePaste } from './extensions/YoutubeExtension';
 import { OpenLinkPopover } from './extensions/LinkKeyboardShortcutExtension';
 import { RichTextEditorProps } from '../types';
 /**
- * Parameters for the useRichTextEditor hook.
- * @property {MutableRefObject<RichTextEditorProps["onImageUpload"]>} onImageUploadRef - Stable ref to the image upload callback, used by extensions without re-creating the editor.
- * @property {MutableRefObject<MentionCallbacks>} mentionCallbacksRef - Stable ref to mention event callbacks (input change, item select).
- * @property {MutableRefObject<OnYoutubePaste>} onYoutubePasteRef - Stable ref to the YouTube paste handler used by the YouTube extension.
- * @property {MutableRefObject<OpenLinkPopover | null>} openLinkPopoverRef - Stable ref to the function that opens the link popover, wired to the `Ctrl/Cmd+K` keyboard shortcut extension.
- * @property {`image/${string}`[]} [allowedMimeTypes] - MIME types accepted for image upload via paste and drop.
+ * Public editor props plus refs so TipTap extensions see the latest callbacks
+ * without remounting the editor.
  */
 export type UseRichTextEditorParams = Pick<RichTextEditorProps, "value" | "defaultValue" | "onChange" | "onJsonChange" | "contentType" | "onMarkdownChange" | "extensions" | "placeholder" | "disabled" | "allowTextFormat" | "allowTextAlignment" | "allowLists" | "allowChecklist" | "allowCode" | "allowBlockquote" | "allowLink" | "allowMedia" | "allowMention" | "onImageUpload" | "isAllowedImageSrc"> & {
     allowedMimeTypes?: `image/${string}`[];
@@ -18,15 +14,5 @@ export type UseRichTextEditorParams = Pick<RichTextEditorProps, "value" | "defau
     onYoutubePasteRef: MutableRefObject<OnYoutubePaste>;
     openLinkPopoverRef: MutableRefObject<OpenLinkPopover | null>;
 };
-/**
- * Internal hook that initializes and manages the TipTap editor instance for RichTextEditor.
- *
- * Conditionally registers TipTap extensions based on the `allow*` feature flags so that
- * only the capabilities needed for a given editor configuration are included. Handles both
- * controlled mode (via `value` + `onChange`) and uncontrolled mode (via `defaultValue`),
- * and syncs the `disabled` prop to the editor's editable state.
- *
- * @param params - Configuration derived from RichTextEditorProps plus stable callback refs.
- * @returns The TipTap `Editor` instance, or `null` during SSR / before mount.
- */
+/** TipTap instance for RichTextEditor. `null` until mount. */
 export declare const useRichTextEditor: ({ value, defaultValue, onChange, onJsonChange, contentType, onMarkdownChange, extensions, placeholder, disabled, allowTextFormat, allowTextAlignment, allowLists, allowChecklist, allowCode, allowBlockquote, allowLink, allowMedia, allowMention, allowedMimeTypes, isAllowedImageSrc, onImageUploadRef, mentionCallbacksRef, onYoutubePasteRef, openLinkPopoverRef, }: UseRichTextEditorParams) => import('@tiptap/core').Editor;

package/dist/src/beta/components/RichTextEditor/types.d.ts

@@ -5,137 +5,112 @@ import { FieldLabelProps } from '../../../components/FieldLabel';
 import { LayoutUtilProps } from '../../../types';
 import { DataTrackingId } from '../../../types/DataTrackingId';
 /**
- * A single option displayed in the @mention typeahead dropdown.
- * @property {string} id - Unique identifier for the mention option, stored in the mention node's attributes.
- * @property {string} label - Display name shown in the dropdown and rendered inside the inserted mention node.
+ * Candidate that can be inserted by the mention typeahead.
  */
 export type RichTextEditorMentionOption = {
+    /** Persisted in the mention node so the referenced entity can be recovered. */
     id: string;
+    /** Used for typeahead matching and rendered as the inserted mention. */
     label: string;
 };
 type RichTextEditorBaseProps = {
+    /** Applied to the contenteditable element rather than the outer wrapper. */
     id?: string;
+    /** Controlled document string, parsed according to `contentType`. */
     value?: string;
+    /** Initial document string when the editor is uncontrolled. */
     defaultValue?: string;
+    /** Receives an HTML serialization after each document update. */
     onChange?: (html: string) => void;
+    /** Receives the TipTap document after each update. */
     onJsonChange?: (json: JSONContent) => void;
-    /**
-     * How `value`/`defaultValue` are parsed. Defaults to HTML. Set once — the
-     * editor instance is created on mount, so changing this afterwards
-     * re-parses the current string under the new assumption instead of
-     * converting existing content.
-     */
+    /** Parser for `value` and `defaultValue`. Defaults to `html`. */
     contentType?: "html" | "markdown";
     /**
-     * Fires with the TipTap-markdown-serialized content on every update,
-     * alongside `onChange`/`onJsonChange`, regardless of `contentType`. Uses
-     * TipTap's official `@tiptap/markdown` extension, which is BETA upstream:
-     * known limitations are single-child-per-cell tables and possible loss of
-     * HTML comments on round-trip. In markdown mode, a controlled `value`
-     * should be the exact string previously emitted here — serialization
-     * normalizes formatting and isn't guaranteed to round-trip arbitrary
-     * hand-written markdown. Markdown syntax for a feature disabled via an
-     * `allow*` flag (e.g. `- item` when `allowLists` is false) is parsed into
-     * whatever the configured schema supports; unsupported nodes are dropped
-     * or flattened rather than causing an error.
+     * Receives normalized markdown after each update, regardless of
+     * `contentType`. For a controlled markdown editor, feed this serialized
+     * string back as `value`; arbitrary markdown may not round-trip exactly.
      */
     onMarkdownChange?: (markdown: string) => void;
     /**
-     * Extra TipTap extensions appended after the built-in ones (e.g. a custom
-     * node type). An extension sharing a built-in's name overrides it. Toolbar
-     * controls don't automatically wire up to custom nodes — build any needed
-     * UI yourself.
+     * TipTap extensions appended after the built-ins. A same-named extension
+     * overrides the built-in, but does not add matching toolbar controls.
      */
     extensions?: Extensions;
+    /** Shown only while the document is empty. */
     placeholder?: string;
+    /** Makes the document non-editable and disables toolbar controls. */
     disabled?: boolean;
+    /** `true` marks the field invalid; strings also render below the editor. */
     error?: boolean | string | string[];
+    /** Primary guidance rendered below the editor. */
     hint?: HelperProps["hint"];
+    /** Secondary guidance rendered below the hint. */
     description?: HelperProps["description"];
+    /** Accessible field label; clicking it focuses the editor. */
     label?: FieldLabelProps["children"];
+    /** Forwarded to the field label; `onClick` runs before editor focus. */
     labelProps?: FieldLabelProps;
+    /** Marks and announces the field as required without enforcing validation. */
     required?: boolean;
+    /** Additional label guidance rendered through {@link FieldLabel}. */
     moreInfo?: ReactNode;
+    /** Enables text type, font size, bold, italic, underline, and strike. Defaults to `true`. */
     allowTextFormat?: boolean;
+    /** Enables left, center, right, and justify controls. Defaults to `true`. */
     allowTextAlignment?: boolean;
+    /** Enables ordered/bullet lists and their indent controls. Defaults to `false`. */
     allowLists?: boolean;
+    /** Enables nested task lists. Defaults to `false`. */
     allowChecklist?: boolean;
+    /** Enables inline code. Defaults to `false`. */
     allowCode?: boolean;
+    /** Enables blockquotes. Defaults to `false`. */
     allowBlockquote?: boolean;
+    /** Enables link editing from the toolbar and keyboard shortcut. Defaults to `false`. */
     allowLink?: boolean;
+    /** Enables mention insertion and typeahead. Defaults to `false`. */
     allowMention?: boolean;
+    /** Shows a handle for reordering document blocks. Defaults to `false`. */
     allowDragDrop?: boolean;
+    /** Candidates filtered by label prefix; at most five are shown. */
     mentionOptions?: RichTextEditorMentionOption[];
+    /** Fires with the typeahead query so callers can load or replace `mentionOptions`. */
     onMentionInputChange?: (query: string) => void;
+    /** Customizes each option in the mention typeahead. */
     renderMentionOption?: (option: RichTextEditorMentionOption) => ReactNode;
+    /** Supplies popover content for mentions already inserted in the document. */
     renderMentionHoverContent?: (option: RichTextEditorMentionOption) => ReactNode;
 };
 type RichTextEditorWithMedia = {
-    /**
-     * Enables the Insert dropdown with Image and YouTube options. Requires `onImageUpload`.
-     */
+    /** Enables image and YouTube insertion. */
     allowMedia: true;
     /**
-     * Called when the user selects, pastes, or drops image files into the editor.
-     * Receive the files and a callback — invoke it with the resulting URLs once upload is complete.
+     * Handles selected, pasted, or dropped images. Invoke `onComplete` with the
+     * uploaded URLs to insert them.
      */
     onImageUpload: (files: File[], onComplete: (srcs: string[]) => void) => void;
     /**
-     * MIME types accepted by the file picker and paste/drop handler.
-     * e.g. `["image/jpeg", "image/png"]`. When omitted, defaults to common image types.
+     * Accepted picker, paste, and drop image types. Defaults to JPEG, PNG, GIF,
+     * and WebP.
      */
     allowedMimeTypes?: `image/${string}`[];
     /**
-     * Validates an image's `src` before it's kept in the document (and thus
-     * before it can render or be emitted via `onJsonChange`/`onMarkdownChange`),
-     * for any input path (typed, pasted, dropped/uploaded, markdown, or set via
-     * `value`/`defaultValue`). Defaults to allowing `http:`/`https:` only.
-     * Pass a custom validator to loosen or further restrict.
+     * Determines which image sources may remain in the document for every input
+     * path. Defaults to `http:` and `https:` URLs.
      */
     isAllowedImageSrc?: (src: string) => boolean;
 };
 type RichTextEditorWithoutMedia = {
+    /** Keeps image and YouTube insertion unavailable. Defaults to `false`. */
     allowMedia?: false;
     onImageUpload?: never;
     allowedMimeTypes?: never;
     isAllowedImageSrc?: never;
 };
 /**
- * Props for the RichTextEditor component.
- * @property {string} [id] - HTML id applied to the editor's contenteditable element.
- * @property {string} [value] - Controlled HTML string value. When provided, the editor operates in controlled mode.
- * @property {string} [defaultValue] - Default HTML string value for uncontrolled mode.
- * @property {(html: string) => void} [onChange] - Callback fired with the HTML string on each content change.
- * @property {(json: JSONContent) => void} [onJsonChange] - Callback fired with the TipTap JSON representation on each content change.
- * @property {"html" | "markdown"} [contentType] - How `value`/`defaultValue` are parsed. Default: "html". Set once at mount.
- * @property {(markdown: string) => void} [onMarkdownChange] - Callback fired with the markdown representation on each content change, regardless of `contentType`.
- * @property {Extensions} [extensions] - Extra TipTap extensions appended after the built-in ones; same-named extensions override a built-in.
- * @property {string} [placeholder] - Placeholder text shown when the editor is empty.
- * @property {boolean} [disabled] - Disables the editor and toolbar when true.
- * @property {boolean | string | string[]} [error] - Error state. Pass `true` for error styling only, or a string/string[] for error messages.
- * @property {HelperProps["hint"]} [hint] - Hint text displayed below the editor.
- * @property {HelperProps["description"]} [description] - Description text displayed below the editor.
- * @property {FieldLabelProps["children"]} [label] - Label for the editor field.
- * @property {FieldLabelProps} [labelProps] - Additional props passed to the label element.
- * @property {boolean} [required] - Marks the field as required.
- * @property {ReactNode} [moreInfo] - Additional info rendered alongside the label.
- * @property {boolean} [allowTextFormat] - Enables text formatting toolbar section: text type dropdown, font size, bold, italic, underline, strikethrough. Default: true.
- * @property {boolean} [allowTextAlignment] - Enables text alignment toolbar section: left, center, right, justify. Default: true.
- * @property {boolean} [allowLists] - Enables list toolbar section: ordered list, unordered list, indent controls. Default: false.
- * @property {boolean} [allowChecklist] - Enables checklist toolbar section. Default: false.
- * @property {boolean} [allowCode] - Enables inline code toolbar button. Default: false.
- * @property {boolean} [allowBlockquote] - Enables blockquote toolbar button. Default: false.
- * @property {boolean} [allowLink] - Enables link insert/remove toolbar button. Default: false.
- * @property {boolean} [allowMedia] - Enables the Insert dropdown (Image + YouTube). Requires `onImageUpload`. Default: false.
- * @property {boolean} [allowMention] - Enables @mention toolbar button. Requires `mentionOptions`. Default: false.
- * @property {boolean} [allowDragDrop] - Enables drag handle for reordering blocks. Default: false.
- * @property {RichTextEditorMentionOption[]} [mentionOptions] - List of mention options to display in the dropdown.
- * @property {(query: string) => void} [onMentionInputChange] - Fired when the user types after `@`. Use to filter or async-load `mentionOptions`.
- * @property {(option: RichTextEditorMentionOption) => ReactNode} [renderMentionOption] - Custom render function for each option in the mention dropdown.
- * @property {(option: RichTextEditorMentionOption) => ReactNode} [renderMentionHoverContent] - Render function for the hover card shown when hovering over an inserted mention.
- * @property {(files: File[], onComplete: (srcs: string[]) => void) => void} [onImageUpload] - Required when `allowMedia` is true. Called when the user selects, pastes, or drops image files. Invoke the callback with the resulting URLs once upload is complete.
- * @property {`image/${string}`[]} [allowedMimeTypes] - MIME types accepted by the file picker and paste/drop handler when `allowMedia` is true. Defaults to common image types when omitted.
- * @property {(src: string) => boolean} [isAllowedImageSrc] - Validates an image's `src` before it's allowed to render when `allowMedia` is true. Defaults to allowing `http:`/`https:` only.
+ * Media upload props are available only when `allowMedia` is `true`.
+ *
  * @extends Omit<ComponentPropsWithoutRef<"div">, "onChange">
  * @extends LayoutUtilProps
  * @extends DataTrackingId