carbon-react 154.3.2 → 154.4.0

package/esm/components/text-editor/index.d.ts

@@ -1,3 +1,3 @@
 export { default } from "./text-editor.component";
 export { createEmpty, createFromHTML } from "./utils";
-export type { TextEditorProps, EditorFormattedValues, } from "./text-editor.component";
+export type { TextEditorHandle, TextEditorProps, EditorFormattedValues, } from "./text-editor.component";

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

@@ -2,6 +2,10 @@ import React from "react";
 import { MarginProps } from "styled-system";
 import { EditorFormattedValues as SaveCallbackProps } from "./__internal__/plugins/Toolbar/buttons/save.component";
 import { TagProps } from "../../__internal__/utils/helpers/tags";
+export interface TextEditorHandle {
+    /** Programmatically focus on the text editor. */
+    focus: () => void;
+}
 export type EditorFormattedValues = SaveCallbackProps;
 export interface TextEditorProps extends MarginProps, TagProps {
     /** The maximum number of characters allowed in the editor */
@@ -50,5 +54,5 @@ export interface TextEditorProps extends MarginProps, TagProps {
     /** The initial value of the editor, as a HTML string, or JSON */
     value?: string | undefined;
 }
-export declare const TextEditor: ({ characterLimit, error, footer, header, inputHint, isOptional, labelText, namespace, onBlur, onCancel, onChange, onFocus, onLinkAdded, onSave, placeholder, previews, readOnly, required, rows, warning, value, ...rest }: TextEditorProps) => React.JSX.Element;
+export declare const TextEditor: React.ForwardRefExoticComponent<TextEditorProps & React.RefAttributes<TextEditorHandle>>;
 export default TextEditor;

package/esm/components/text-editor/text-editor.component.js

@@ -10,7 +10,7 @@ import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin";
 import { LinkPlugin } from "@lexical/react/LexicalLinkPlugin";
 import { ListPlugin } from "@lexical/react/LexicalListPlugin";
 import { $getRoot } from "lexical";
-import React, { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import React, { useCallback, useEffect, useImperativeHandle, useMemo, useRef, useState, forwardRef } from "react";
 import { SerializeLexical, validateUrl } from "./__internal__/helpers";
 import Label from "../../__internal__/label";
 import useLocale from "../../hooks/__internal__/useLocale";
@@ -24,7 +24,7 @@ import HintText from "../../__internal__/hint-text";
 import { filterStyledSystemMarginProps } from "../../style/utils";
 import tagComponent from "../../__internal__/utils/helpers/tags";
 let deprecateOptionalWarnTriggered = false;
-export const TextEditor = ({
+export const TextEditor = /*#__PURE__*/forwardRef(({
   characterLimit = 3000,
   error,
   footer,
@@ -47,7 +47,7 @@ export const TextEditor = ({
   warning,
   value,
   ...rest
-}) => {
+}, ref) => {
   if (!deprecateOptionalWarnTriggered && isOptional) {
     deprecateOptionalWarnTriggered = true;
     Logger.deprecate("`isOptional` is deprecated in TextEditor and support will soon be removed. If the value of this component is not required, use the `required` prop and set it to false instead.");
@@ -58,6 +58,11 @@ export const TextEditor = ({
   const hasWarningOrError = Boolean(error || characterLimitWarning || warning);
   const contentEditorRef = useRef(null);
   const [isFocused, setIsFocused] = useState(false);
+  useImperativeHandle(ref, () => ({
+    focus() {
+      contentEditorRef.current?.focus();
+    }
+  }), []);
   useEffect(() => {
     const editorElement = contentEditorRef?.current;
     const handleFocus = () => {
@@ -206,5 +211,5 @@ export const TextEditor = ({
     maxChars: characterLimit,
     namespace: namespace
   })))));
-};
+});
 export default TextEditor;

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

@@ -1,3 +1,3 @@
 export { default } from "./text-editor.component";
 export { createEmpty, createFromHTML } from "./utils";
-export type { TextEditorProps, EditorFormattedValues, } from "./text-editor.component";
+export type { TextEditorHandle, TextEditorProps, EditorFormattedValues, } from "./text-editor.component";

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

@@ -2,6 +2,10 @@ import React from "react";
 import { MarginProps } from "styled-system";
 import { EditorFormattedValues as SaveCallbackProps } from "./__internal__/plugins/Toolbar/buttons/save.component";
 import { TagProps } from "../../__internal__/utils/helpers/tags";
+export interface TextEditorHandle {
+    /** Programmatically focus on the text editor. */
+    focus: () => void;
+}
 export type EditorFormattedValues = SaveCallbackProps;
 export interface TextEditorProps extends MarginProps, TagProps {
     /** The maximum number of characters allowed in the editor */
@@ -50,5 +54,5 @@ export interface TextEditorProps extends MarginProps, TagProps {
     /** The initial value of the editor, as a HTML string, or JSON */
     value?: string | undefined;
 }
-export declare const TextEditor: ({ characterLimit, error, footer, header, inputHint, isOptional, labelText, namespace, onBlur, onCancel, onChange, onFocus, onLinkAdded, onSave, placeholder, previews, readOnly, required, rows, warning, value, ...rest }: TextEditorProps) => React.JSX.Element;
+export declare const TextEditor: React.ForwardRefExoticComponent<TextEditorProps & React.RefAttributes<TextEditorHandle>>;
 export default TextEditor;

package/lib/components/text-editor/text-editor.component.js

@@ -32,7 +32,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); } /* eslint-disable no-console */
 let deprecateOptionalWarnTriggered = false;
-const TextEditor = ({
+const TextEditor = exports.TextEditor = /*#__PURE__*/(0, _react.forwardRef)(({
   characterLimit = 3000,
   error,
   footer,
@@ -55,7 +55,7 @@ const TextEditor = ({
   warning,
   value,
   ...rest
-}) => {
+}, ref) => {
   if (!deprecateOptionalWarnTriggered && isOptional) {
     deprecateOptionalWarnTriggered = true;
     _logger.default.deprecate("`isOptional` is deprecated in TextEditor and support will soon be removed. If the value of this component is not required, use the `required` prop and set it to false instead.");
@@ -66,6 +66,11 @@ const TextEditor = ({
   const hasWarningOrError = Boolean(error || characterLimitWarning || warning);
   const contentEditorRef = (0, _react.useRef)(null);
   const [isFocused, setIsFocused] = (0, _react.useState)(false);
+  (0, _react.useImperativeHandle)(ref, () => ({
+    focus() {
+      contentEditorRef.current?.focus();
+    }
+  }), []);
   (0, _react.useEffect)(() => {
     const editorElement = contentEditorRef?.current;
     const handleFocus = () => {
@@ -214,6 +219,5 @@ const TextEditor = ({
     maxChars: characterLimit,
     namespace: namespace
   })))));
-};
-exports.TextEditor = TextEditor;
+});
 var _default = exports.default = TextEditor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carbon-react",
-  "version": "154.3.2",
+  "version": "154.4.0",
   "description": "A library of reusable React components for easily building user interfaces.",
   "files": [
     "lib",