@cmgfi/clear-ds 1.1.8 → 1.2.0

package/dist/index.d.ts

@@ -1185,6 +1185,11 @@ export declare interface LoanBannerNavToolbar {
     right?: React.ReactNode;
 }
 
+export declare interface MentionItem {
+    id: string;
+    label: string;
+}
+
 export declare function MiscChip({ label, color, dismissible, onDismiss }: MiscChipProps): JSX_2.Element;
 
 export declare namespace MiscChip {
@@ -1653,6 +1658,91 @@ export declare interface RadioButtonProps extends Omit<React.InputHTMLAttributes
     size?: 'sm' | 'md' | 'lg';
 }
 
+export declare const RichTextEditor: ForwardRefExoticComponent<RichTextEditorProps & RefAttributes<HTMLDivElement>>;
+
+export declare interface RichTextEditorProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange' | 'defaultValue'> {
+    /** Label shown above the editor. */
+    label?: string;
+    /** When false, hides the label visually and falls back to aria-label on the editor. Defaults to true. */
+    showLabel?: boolean;
+    /** Adds a red asterisk and sets aria-required. */
+    required?: boolean;
+    /** Show or hide the helper text area below the editor. */
+    helperText?: boolean;
+    /** Text displayed in the helper text area. Defaults to 'Helper text' when not provided. Turns red when invalid is true. */
+    helperTextContent?: string;
+    /** Renders the invalid/error state with red border and red helper text. */
+    invalid?: boolean;
+    /** Disables the editor and all toolbar buttons. */
+    disabled?: boolean;
+    /** Placeholder text shown when the editor is empty. */
+    placeholder?: string;
+    /** Initial HTML content (uncontrolled). */
+    defaultValue?: string;
+    /** Called with the current HTML string on every change. */
+    onChange?: (html: string) => void;
+    /** When set, shows a character counter. */
+    maxLength?: number;
+    /** Where the character counter appears. Defaults to 'outside'. */
+    counterPlacement?: 'inside' | 'outside';
+    /**
+     * Controls when the toolbar is visible.
+     * - `'always'` (default) — toolbar is always shown when any button prop is true.
+     * - `'on-focus'` — toolbar appears when the editor is focused and hides on blur.
+     */
+    toolbarMode?: 'always' | 'on-focus';
+    /** Show Bold button. */
+    showBold?: boolean;
+    /** Show Italic button. */
+    showItalic?: boolean;
+    /** Show Underline button. */
+    showUnderline?: boolean;
+    /** Show Strikethrough button. */
+    showStrike?: boolean;
+    /** Show inline Code button. */
+    showCode?: boolean;
+    /** Show Highlight button. */
+    showHighlight?: boolean;
+    /** Show Subscript button. */
+    showSubscript?: boolean;
+    /** Show Superscript button. */
+    showSuperscript?: boolean;
+    /** Show Heading buttons. Renders H1/H2/H3 by default; use headingLevels to customise. */
+    showHeading?: boolean;
+    /** Which heading levels to show. Defaults to [1, 2, 3]. */
+    headingLevels?: (1 | 2 | 3 | 4 | 5 | 6)[];
+    /** Show Blockquote button. */
+    showBlockquote?: boolean;
+    /** Show Code Block button. */
+    showCodeBlock?: boolean;
+    /** Show Bullet List button. */
+    showBulletList?: boolean;
+    /** Show Ordered List button. */
+    showOrderedList?: boolean;
+    /** Show Task List button. */
+    showTaskList?: boolean;
+    /** Show Horizontal Rule button. */
+    showHorizontalRule?: boolean;
+    /** Show text-alignment buttons (left / center / right / justify). */
+    showTextAlign?: boolean;
+    /** Show Link button. Toggles an inline URL bar for adding/removing links. */
+    showLink?: boolean;
+    /** Show Image button. Toggles an inline URL bar for inserting images. */
+    showImage?: boolean;
+    /** Show Mention (@) button. Also activates the @ trigger in the editor. */
+    showMention?: boolean;
+    /** Show Undo button. */
+    showUndo?: boolean;
+    /** Show Redo button. */
+    showRedo?: boolean;
+    /**
+     * Items shown in the @ mention dropdown.
+     * Pass an array for static data, or a (sync or async) function for dynamic data.
+     * Falls back to built-in mock loan-party data if omitted.
+     */
+    mentionSuggestions?: MentionItem[] | ((query: string) => MentionItem[] | Promise<MentionItem[]>);
+}
+
 export declare interface RuleFilterValue {
     operator: 'and' | 'or';
     rules: FilterRule[];
@@ -2073,6 +2163,8 @@ export declare const TextArea: ForwardRefExoticComponent<TextAreaProps & RefAttr
 export declare interface TextAreaProps extends Omit<React.TextareaHTMLAttributes<HTMLTextAreaElement>, 'children'> {
     /** Label shown above the textarea. */
     label?: string;
+    /** When false, hides the label visually and falls back to aria-label on the textarea. Defaults to true. */
+    showLabel?: boolean;
     /** Adds a red asterisk to the label and sets aria-required. */
     required?: boolean;
     /** Helper text shown below the textarea. Turns red when `invalid` is true. */
@@ -2086,6 +2178,8 @@ export declare interface TextAreaProps extends Omit<React.TextareaHTMLAttributes
      * instead of showing a scrollbar.
      */
     autoGrow?: boolean;
+    /** Controls where the character counter renders. 'inside' pins it to the bottom-right of the field; 'outside' (default) places it below the field in the bottom row. */
+    counterPlacement?: 'inside' | 'outside';
 }
 
 /**