@danxbot/ui 11.0.0 → 11.1.0

package/dist/types/components/EditGutter.d.ts

@@ -0,0 +1,20 @@
+import { type ReactNode } from "react";
+/** The controlled activation pair every pencil-activated field takes. */
+export interface EditActivation {
+    editing: boolean;
+    onEditingChange: (editing: boolean) => void;
+}
+export interface EditGutterProps {
+    /**
+     * The pencil's accessible name — say WHAT it edits ("Edit title"), because
+     * a screen reader lists it among every other pencil on the page.
+     */
+    label: string;
+    /**
+     * Render the field, spreading the activation onto it:
+     * `{(edit) => <InlineEdit {...edit} … />}`.
+     */
+    children: (activation: EditActivation) => ReactNode;
+    className?: string;
+}
+export declare function EditGutter({ label, children, className }: EditGutterProps): import("react").JSX.Element;

package/dist/types/components/InlineEdit.d.ts

@@ -1,14 +1,7 @@
 import { type Ref } from "react";
 import { useRender } from "@base-ui/react/use-render";
-/**
- * The caller's refusal of a value, with the reason that will be shown.
- * Unchanged from 5.2.1 — see `InlineEditOutcome`.
- */
-export interface InlineEditRefusal {
-    refusal: string;
-}
-/** What `onCommit` may report. Returning nothing accepts the value. */
-export type InlineEditOutcome = void | InlineEditRefusal;
+import { type InlineEditCommit } from "./edit/outcome";
+export type { InlineEditCommit, InlineEditOutcome, InlineEditRefusal } from "./edit/outcome";
 export interface InlineEditProps {
     /**
      * The committed value. Controlled — this component never holds the truth,
@@ -30,7 +23,7 @@ export interface InlineEditProps {
      * it settles. Resolve/return `{ refusal }` to reject the value with a
      * reason; throw or reject to report that the save itself failed.
      */
-    onCommit: (value: string, base: string) => InlineEditOutcome | Promise<InlineEditOutcome>;
+    onCommit: InlineEditCommit;
     /**
      * The refusals that are knowable WITHOUT a request. Return the reason, or
      * `null` to accept. Runs after the unchanged check and before `onCommit`.
@@ -115,10 +108,25 @@ export interface InlineEditProps {
     /** The rejected error, handed on so it can be logged or reported. */
     onError?: (error: unknown) => void;
     /**
-     * Fires exactly when editing starts and exactly when it ends — never while a
-     * read-only control merely declines to open. Use it to suspend any
-     * re-render-from-server logic of your own for as long as someone is
-     * actually looking at the field; see the module comment.
+     * CONTROLLED ACTIVATION (DX-3372). Pass it and the control never opens
+     * ITSELF — no click, Enter or F2 — because something else (the pencil of an
+     * `EditGutter`, a menu item, a shortcut) is the way in. Setting it `true`
+     * opens the field, focused, caret at the end; the control asks to close
+     * through `onEditingChange(false)` once a commit lands or Escape cancels.
+     * Setting it `false` yourself while it is open abandons the draft exactly as
+     * Escape would — nothing is written. At rest the element leaves the tab
+     * order and drops its hover affordance, so the trigger is the one stop.
+     *
+     * Omit it for the self-opening control (click, Enter or F2).
+     */
+    editing?: boolean;
+    /**
+     * Fires exactly when the control itself starts or ends editing — never while
+     * a read-only control merely declines to open, and never for a change the
+     * caller made through `editing`. Use it to suspend any re-render-from-server
+     * logic of your own for as long as someone is actually looking at the
+     * field; see the module comment. With `editing` controlled, this is how the
+     * control hands the closed state back.
      */
     onEditingChange?: (editing: boolean) => void;
     /** Render as a different element — see `Button`'s own `render` for the shape. */
@@ -135,4 +143,4 @@ export interface InlineEditProps {
     messageClassName?: string;
     ref?: Ref<HTMLElement>;
 }
-export declare function InlineEdit({ value, onCommit, validate, liveValidate, label, placeholder, size, multiline, autosaveMs, readOnly, failureMessage, onError, onEditingChange, render, className, messageClassName, inputMode, ref, }: InlineEditProps): import("react").JSX.Element;
+export declare function InlineEdit({ value, onCommit, validate, liveValidate, label, placeholder, size, multiline, autosaveMs, readOnly, failureMessage, onError, editing: editingProp, onEditingChange, render, className, messageClassName, inputMode, ref, }: InlineEditProps): import("react").JSX.Element;

package/dist/types/components/InlineMarkdownEdit.d.ts

@@ -0,0 +1,37 @@
+import { type ReactNode } from "react";
+import type { ImageUploader } from "../lib/markdown/image-pipeline";
+import { type InlineEditCommit } from "./edit/outcome";
+export interface InlineMarkdownEditProps {
+    /** The committed markdown. Controlled — the field only ever holds a draft. */
+    value: string;
+    /**
+     * Commit a new value — the same contract as `InlineEdit.onCommit`: called
+     * only when the draft differs from `value`, with `base` = the value editing
+     * began from; return/resolve `{ refusal }` to refuse with a reason, throw or
+     * reject to report a failed save.
+     */
+    onCommit: InlineEditCommit;
+    /** Whether the editor is open. REQUIRED — see the module comment. */
+    editing: boolean;
+    /** The field asks to close through this, once a commit lands or Escape cancels. */
+    onEditingChange: (editing: boolean) => void;
+    /** The accessible name of the field and of its editor. */
+    label: string;
+    /** Shown at rest and in the editor when the value is empty. @default "Empty" */
+    placeholder?: string;
+    /** Collapse the rendered view to this many lines behind a `ReadMore`. */
+    collapsedLines?: number;
+    /** Extra toolbar content for the editor, after its built-in groups. */
+    toolbar?: ReactNode;
+    /** Stores a pasted/dropped/picked image — see `MarkdownEditorProps.uploadImage`. */
+    uploadImage?: ImageUploader;
+    /**
+     * What is shown when the commit REJECTS (never a `{ refusal }`, which
+     * renders its own text).
+     */
+    failureMessage?: string;
+    /** The rejected error, handed on so it can be logged or reported. */
+    onError?: (error: unknown) => void;
+    className?: string;
+}
+export declare function InlineMarkdownEdit({ value, onCommit, editing, onEditingChange, label, placeholder, collapsedLines, toolbar, uploadImage, failureMessage, onError, className, }: InlineMarkdownEditProps): import("react").JSX.Element;

package/dist/types/components/MarkdownEditor.d.ts

@@ -10,7 +10,13 @@ import { type ImageUploadState, type ImageUploader } from "../lib/markdown/image
  * contenteditable host, never a proxy element.
  */
 export interface MarkdownEditorHandle {
-    focus: () => void;
+    /**
+     * Focus the surface. `caret` places the caret at the document's `"start"` or
+     * `"end"` (snapped to a real caret stop); omit it to leave the caret wherever
+     * the browser puts it. DX-3372: `InlineMarkdownEdit` opens with the caret at
+     * the end, the same place `InlineEdit` puts it.
+     */
+    focus: (caret?: "start" | "end") => void;
 }
 export interface MarkdownEditorProps {
     /** The markdown. Controlled when `onChange` is given. */

package/dist/types/components/code-editor/recipe.d.ts

@@ -9,11 +9,11 @@ export declare const code: import("tailwind-variants").TVReturnType<{
             footer?: import("tailwind-variants").ClassValue;
             hint?: import("tailwind-variants").ClassValue;
             root?: import("tailwind-variants").ClassValue;
-            control?: import("tailwind-variants").ClassValue;
             rendered?: import("tailwind-variants").ClassValue;
             layers?: import("tailwind-variants").ClassValue;
             gutter?: import("tailwind-variants").ClassValue;
             fade?: import("tailwind-variants").ClassValue;
+            control?: import("tailwind-variants").ClassValue;
             scroller?: import("tailwind-variants").ClassValue;
             expand?: import("tailwind-variants").ClassValue;
         };
@@ -29,11 +29,11 @@ export declare const code: import("tailwind-variants").TVReturnType<{
             footer?: import("tailwind-variants").ClassValue;
             hint?: import("tailwind-variants").ClassValue;
             root?: import("tailwind-variants").ClassValue;
-            control?: import("tailwind-variants").ClassValue;
             rendered?: import("tailwind-variants").ClassValue;
             layers?: import("tailwind-variants").ClassValue;
             gutter?: import("tailwind-variants").ClassValue;
             fade?: import("tailwind-variants").ClassValue;
+            control?: import("tailwind-variants").ClassValue;
             scroller?: import("tailwind-variants").ClassValue;
             expand?: import("tailwind-variants").ClassValue;
         };
@@ -65,11 +65,11 @@ export declare const code: import("tailwind-variants").TVReturnType<{
             footer?: import("tailwind-variants").ClassValue;
             hint?: import("tailwind-variants").ClassValue;
             root?: import("tailwind-variants").ClassValue;
-            control?: import("tailwind-variants").ClassValue;
             rendered?: import("tailwind-variants").ClassValue;
             layers?: import("tailwind-variants").ClassValue;
             gutter?: import("tailwind-variants").ClassValue;
             fade?: import("tailwind-variants").ClassValue;
+            control?: import("tailwind-variants").ClassValue;
             scroller?: import("tailwind-variants").ClassValue;
             expand?: import("tailwind-variants").ClassValue;
         };

package/dist/types/components/edit/outcome.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The caller's refusal of a value, with the reason that will be shown.
+ */
+export interface InlineEditRefusal {
+    refusal: string;
+}
+/** What `onCommit` may report. Returning nothing accepts the value. */
+export type InlineEditOutcome = void | InlineEditRefusal;
+/** Every in-place editor's `onCommit`: the new value and the value editing began from. */
+export type InlineEditCommit = (value: string, base: string) => InlineEditOutcome | Promise<InlineEditOutcome>;
+export declare function isRefusal(outcome: InlineEditOutcome): outcome is InlineEditRefusal;
+export declare function isPromise(outcome: InlineEditOutcome | Promise<InlineEditOutcome>): outcome is Promise<InlineEditOutcome>;
+export declare const DEFAULT_FAILURE = "Could not save. Your text is still here \u2014 press Enter to try again.";
+/**
+ * A refusal nobody can read leaves the field open with nothing beside it — the
+ * exact silent failure the outcome contract exists to rule out — so an empty
+ * reason is a programming error, thrown rather than rendered.
+ */
+export declare function assertReadableRefusal(component: string, reason: string, source: "validate" | "onCommit"): void;
+/**
+ * THE MESSAGE IS AN OVERLAY, for the reason `InlineEdit` measured: in normal
+ * flow a refusal grows the control's own wrapper, which inside a fixed-height
+ * row shoves everything beside it. Absolutely positioned, it cannot contribute
+ * height. The parent must be `relative`.
+ */
+export declare function OutcomeMessage({ id, children, className, }: {
+    id?: string;
+    children: string;
+    className?: string;
+}): import("react").JSX.Element;

package/dist/types/index.d.ts

@@ -21,7 +21,9 @@ export { Skeleton, SkeletonText, LoadingOverlay, type SkeletonProps, type Skelet
 export { ErrorBoundary, type ErrorBoundaryProps } from "./components/ErrorBoundary";
 export { Field, FieldSet, type FieldProps, type FieldSetProps } from "./components/Field";
 export { Input, Textarea, type InputProps, type TextareaProps } from "./components/Input";
-export { InlineEdit, type InlineEditProps, type InlineEditRefusal, type InlineEditOutcome, } from "./components/InlineEdit";
+export { InlineEdit, type InlineEditProps, type InlineEditRefusal, type InlineEditOutcome, type InlineEditCommit, } from "./components/InlineEdit";
+export { EditGutter, type EditGutterProps, type EditActivation } from "./components/EditGutter";
+export { InlineMarkdownEdit, type InlineMarkdownEditProps } from "./components/InlineMarkdownEdit";
 export { SecretField, type SecretFieldProps, type SecretValue } from "./components/SecretField";
 export { SettingRow, SettingGroup, type SettingRowProps, type SettingGroupProps, type SettingRowControlRenderProps, } from "./components/SettingRow";
 export { DescriptionList, DescriptionListItem, type DescriptionListProps, type DescriptionListItemProps, type DescriptionListEntry, } from "./components/DescriptionList";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danxbot/ui",
-  "version": "11.0.0",
+  "version": "11.1.0",
   "type": "module",
   "description": "Danxbot — a domain-agnostic React design system with motion as a first-class primitive.",
   "license": "MIT",