@keboola/design 2.0.1 → 3.0.0

package/dist/markdown-editor.d.cts

@@ -0,0 +1,74 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+type MarkdownEditorProps = {
+    /** Markdown string (controlled) */
+    value: string;
+    onChange?: (markdown: string) => void;
+    /**
+     * Renders content but never accepts input. Use for permanent view-only contexts
+     * (e.g. a current user lacks edit permission). Toolbar is hidden.
+     */
+    readOnly?: boolean;
+    /**
+     * Temporarily blocks input but signals intent to re-enable
+     * (e.g. while a save is in flight). Functionally identical to `readOnly` today.
+     */
+    disabled?: boolean;
+    placeholder?: string;
+    autoFocus?: boolean;
+    /** Invoked on Cmd/Ctrl+Enter — typically used to commit a form. */
+    onSave?: () => void;
+    /**
+     * Invoked on Escape in inline-edit mode (`singleLine || saveOnBlur`). Per the
+     * inline-editable-text pattern spec, Esc reverts the in-progress edit — callers
+     * reset `value` to the last-committed state inside this handler.
+     */
+    onCancel?: () => void;
+    /**
+     * Async image upload. Resolved URL is embedded as the image src
+     * (`![alt](url)` in the underlying markdown).
+     */
+    onImageUpload?: (file: File) => Promise<{
+        url: string;
+    }>;
+    className?: string;
+    imageRenderer?: (props: {
+        src: string;
+        alt: string;
+    }) => ReactNode;
+    showToolbar?: boolean;
+    /**
+     * Strips the prose typography wrapper, removes the min-height, and tightens padding so
+     * the editor visually blends with surrounding text. Use for inline / Linear-style edit
+     * affordances inside headings, list rows, or table cells. Pair with `className` to set
+     * the caller's typography.
+     */
+    compact?: boolean;
+    /**
+     * Calls `onSave` when focus leaves the editor (and is not moved into the toolbar).
+     * `onChange` already keeps the caller's value in sync — `onSave` is the "commit" signal.
+     */
+    saveOnBlur?: boolean;
+    /**
+     * Disables block-level markdown (lists, headings, code blocks, HR) and makes a plain
+     * Enter press trigger `onSave` and blur the editor. Shift+Enter still inserts a soft
+     * line break. Use for editable titles.
+     */
+    singleLine?: boolean;
+    /**
+     * Clamps content to ~2 lines with a bottom fade in the display (not-focused) state;
+     * focus expands the editor to full height (no clamp). Per the inline-editable-text
+     * pattern spec for description-style slots — fade replaces truncation/ellipsis.
+     */
+    clampDisplay?: boolean;
+    /**
+     * Minimum visible height in lines. `1` renders as a single line that grows with
+     * content (Linear/Slack/GitHub-PR-comment pattern); `0` removes the floor entirely.
+     * Omit to keep the default ~4-line floor. Ignored in `compact` mode (which has no floor).
+     */
+    minRows?: number;
+};
+declare const MarkdownEditor: ({ value, onChange, readOnly, placeholder, autoFocus, disabled, onSave, onCancel, onImageUpload, className, imageRenderer, showToolbar, compact, saveOnBlur, singleLine, clampDisplay, minRows, }: MarkdownEditorProps) => react_jsx_runtime.JSX.Element;
+
+export { MarkdownEditor, type MarkdownEditorProps };

package/dist/markdown-editor.d.ts

@@ -0,0 +1,74 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+type MarkdownEditorProps = {
+    /** Markdown string (controlled) */
+    value: string;
+    onChange?: (markdown: string) => void;
+    /**
+     * Renders content but never accepts input. Use for permanent view-only contexts
+     * (e.g. a current user lacks edit permission). Toolbar is hidden.
+     */
+    readOnly?: boolean;
+    /**
+     * Temporarily blocks input but signals intent to re-enable
+     * (e.g. while a save is in flight). Functionally identical to `readOnly` today.
+     */
+    disabled?: boolean;
+    placeholder?: string;
+    autoFocus?: boolean;
+    /** Invoked on Cmd/Ctrl+Enter — typically used to commit a form. */
+    onSave?: () => void;
+    /**
+     * Invoked on Escape in inline-edit mode (`singleLine || saveOnBlur`). Per the
+     * inline-editable-text pattern spec, Esc reverts the in-progress edit — callers
+     * reset `value` to the last-committed state inside this handler.
+     */
+    onCancel?: () => void;
+    /**
+     * Async image upload. Resolved URL is embedded as the image src
+     * (`![alt](url)` in the underlying markdown).
+     */
+    onImageUpload?: (file: File) => Promise<{
+        url: string;
+    }>;
+    className?: string;
+    imageRenderer?: (props: {
+        src: string;
+        alt: string;
+    }) => ReactNode;
+    showToolbar?: boolean;
+    /**
+     * Strips the prose typography wrapper, removes the min-height, and tightens padding so
+     * the editor visually blends with surrounding text. Use for inline / Linear-style edit
+     * affordances inside headings, list rows, or table cells. Pair with `className` to set
+     * the caller's typography.
+     */
+    compact?: boolean;
+    /**
+     * Calls `onSave` when focus leaves the editor (and is not moved into the toolbar).
+     * `onChange` already keeps the caller's value in sync — `onSave` is the "commit" signal.
+     */
+    saveOnBlur?: boolean;
+    /**
+     * Disables block-level markdown (lists, headings, code blocks, HR) and makes a plain
+     * Enter press trigger `onSave` and blur the editor. Shift+Enter still inserts a soft
+     * line break. Use for editable titles.
+     */
+    singleLine?: boolean;
+    /**
+     * Clamps content to ~2 lines with a bottom fade in the display (not-focused) state;
+     * focus expands the editor to full height (no clamp). Per the inline-editable-text
+     * pattern spec for description-style slots — fade replaces truncation/ellipsis.
+     */
+    clampDisplay?: boolean;
+    /**
+     * Minimum visible height in lines. `1` renders as a single line that grows with
+     * content (Linear/Slack/GitHub-PR-comment pattern); `0` removes the floor entirely.
+     * Omit to keep the default ~4-line floor. Ignored in `compact` mode (which has no floor).
+     */
+    minRows?: number;
+};
+declare const MarkdownEditor: ({ value, onChange, readOnly, placeholder, autoFocus, disabled, onSave, onCancel, onImageUpload, className, imageRenderer, showToolbar, compact, saveOnBlur, singleLine, clampDisplay, minRows, }: MarkdownEditorProps) => react_jsx_runtime.JSX.Element;
+
+export { MarkdownEditor, type MarkdownEditorProps };