carbon-react 148.0.1 → 149.0.1

package/lib/components/text-editor/text-editor.component.d.ts

@@ -1,37 +1,41 @@
 import React from "react";
 import { MarginProps } from "styled-system";
-import { ContentState, EditorState, Editor } from "draft-js";
+import { SaveCallbackProps } from "./__internal__/plugins/Toolbar/buttons/save.component";
 export interface TextEditorProps extends MarginProps {
-    /** The maximum characters that the input will accept */
+    /** The maximum number of characters allowed in the editor */
     characterLimit?: number;
-    /** The text for the editor's label */
+    /** The message to be shown when the editor is in an error state */
+    error?: string;
+    /** A hint string rendered before the editor but after the label. Intended to describe the purpose or content of the input. */
+    inputHint?: string;
+    /** Whether the content of the editor can be empty */
+    isOptional?: boolean;
+    /** The label to display above the editor */
     labelText: string;
-    /** onChange callback to control value updates */
-    onChange: (event: EditorState) => void;
-    /** Additional elements to be rendered in the Editor Toolbar, e.g. Save and Cancel Button */
-    toolbarElements?: React.ReactNode;
-    /** The value of the input, this is an EditorState immutable object */
-    value: EditorState;
-    /** Flag to configure component as mandatory. */
+    /** The identifier for the Text Editor. This allows for the using of multiple Text Editors on a screen */
+    namespace?: string;
+    /** The callback to fire when the Cancel button within the editor is pressed */
+    onCancel?: () => void;
+    /** The callback to fire when a change is registered within the editor */
+    onChange?: (value: string) => void;
+    /** The callback to fire when a link is added into the editor */
+    onLinkAdded?: (link: string, state: string) => void;
+    /** The callback to fire when the Save button within the editor is pressed */
+    onSave?: (value: SaveCallbackProps) => void;
+    /** The placeholder to display when the editor is empty */
+    placeholder?: string;
+    /** An array of link preview nodes to render in the editor */
+    previews?: React.JSX.Element[];
+    /** Whether the editor is read-only */
+    readOnly?: boolean;
+    /** Whether the content of the editor is required to have a value */
     required?: boolean;
-    /** Flag to configure component as optional. */
-    isOptional?: boolean;
-    /** Message to be displayed when there is an error */
-    error?: string;
-    /** Message to be displayed when there is a warning */
-    warning?: string;
-    /** [Legacy] Message to be displayed when there is an info */
-    info?: string;
-    /** Number greater than 2 multiplied by line-height (21px) to override the default min-height of the editor */
+    /** Number greater than 2 multiplied to override the default min-height of the editor */
     rows?: number;
-    /** The previews to display of any links added to the Editor */
-    previews?: React.ReactNode;
-    /** Callback to report a url when a link is added */
-    onLinkAdded?: (url: string) => void;
-    /** Hint text to be rendered when validationRedesignOptIn flag is set */
-    inputHint?: string;
+    /** The message to be shown when the editor is in an warning state */
+    warning?: string;
+    /** The initial value of the editor, as a HTML string, or JSON */
+    value?: string | undefined;
 }
-export declare const TextEditor: React.ForwardRefExoticComponent<TextEditorProps & React.RefAttributes<Editor>>;
-export declare const TextEditorState: typeof EditorState;
-export declare const TextEditorContentState: typeof ContentState;
+export declare const TextEditor: ({ characterLimit, error, inputHint, isOptional, labelText, namespace, onCancel, onChange, onLinkAdded, onSave, placeholder, previews, readOnly, required, rows, warning, value, }: TextEditorProps) => React.JSX.Element;
 export default TextEditor;