carbon-react 111.12.5 → 111.12.7

package/esm/components/textarea/textarea.style.d.ts

@@ -1,3 +1,9 @@
-export const MIN_HEIGHT: 64;
+export declare const MIN_HEIGHT = 64;
+export interface StyledTextAreaProps {
+    /** When true, label is placed in line an input */
+    labelInline?: boolean;
+    /** When true, adjusts padding for icon */
+    hasIcon?: boolean;
+}
+declare const StyledTextarea: import("styled-components").StyledComponent<"div", any, StyledTextAreaProps, never>;
 export default StyledTextarea;
-declare const StyledTextarea: import("styled-components").StyledComponent<"div", any, {}, never>;

package/esm/components/textbox/textbox.component.js

@@ -16,6 +16,7 @@ import { ErrorBorder, StyledHintText } from "./textbox.style";
 import ValidationMessage from "../../__internal__/validation-message";
 import { NewValidationContext } from "../carbon-provider/carbon-provider.component";
 import NumeralDateContext from "../numeral-date/numeral-date-context";
+import Box from "../box";
 
 const Textbox = ({
   align = "left",
@@ -99,38 +100,7 @@ const Textbox = ({
   });
   const labelId = label ? externalLabelId || internalLabelId : "";
   const hasIconInside = !!(inputIcon || validationIconId && !validationOnLabel);
-  return /*#__PURE__*/React.createElement(TooltipProvider, {
-    helpAriaLabel: helpAriaLabel,
-    tooltipPosition: tooltipPosition
-  }, /*#__PURE__*/React.createElement(InputBehaviour, null, /*#__PURE__*/React.createElement(FormField, _extends({
-    disabled: disabled,
-    fieldHelpId: fieldHelpId,
-    fieldHelp: computeLabelPropValues(fieldHelp),
-    error: error,
-    warning: warning,
-    info: info,
-    label: label,
-    labelId: labelId,
-    labelAlign: computeLabelPropValues(labelAlign),
-    labelHelp: computeLabelPropValues(labelHelp),
-    labelInline: computeLabelPropValues(labelInline),
-    labelSpacing: labelSpacing,
-    labelWidth: computeLabelPropValues(labelWidth),
-    id: uniqueId,
-    reverse: computeLabelPropValues(reverse),
-    isOptional: isOptional,
-    useValidationIcon: computeLabelPropValues(validationOnLabel),
-    adaptiveLabelBreakpoint: adaptiveLabelBreakpoint,
-    isRequired: required,
-    "data-component": dataComponent,
-    "data-role": dataRole,
-    "data-element": dataElement,
-    validationIconId: validationRedesignOptIn ? undefined : validationIconId,
-    validationRedesignOptIn: validationRedesignOptIn
-  }, filterStyledSystemMarginProps(props)), validationRedesignOptIn && labelHelp && /*#__PURE__*/React.createElement(StyledHintText, null, labelHelp), validationRedesignOptIn && /*#__PURE__*/React.createElement(ValidationMessage, {
-    error: error,
-    warning: warning
-  }), /*#__PURE__*/React.createElement(InputPresentation, {
+  const input = /*#__PURE__*/React.createElement(InputPresentation, {
     align: align,
     disabled: disabled,
     readOnly: readOnly,
@@ -143,9 +113,7 @@ const Textbox = ({
     hasIcon: hasIconInside
   }, leftChildren, prefix && /*#__PURE__*/React.createElement(StyledPrefix, {
     "data-element": "textbox-prefix"
-  }, prefix), validationRedesignOptIn && !disableErrorBorder && (error || warning) && /*#__PURE__*/React.createElement(ErrorBorder, {
-    warning: !!(!error && warning)
-  }), /*#__PURE__*/React.createElement(Input, _extends({}, required && {
+  }, prefix), /*#__PURE__*/React.createElement(Input, _extends({}, required && {
     required
   }, {
     align: align,
@@ -182,7 +150,43 @@ const Textbox = ({
     useValidationIcon: !(validationRedesignOptIn || validationOnLabel),
     warning: warning,
     validationIconId: validationRedesignOptIn ? undefined : validationIconId
-  }))), characterCount));
+  }));
+  return /*#__PURE__*/React.createElement(TooltipProvider, {
+    helpAriaLabel: helpAriaLabel,
+    tooltipPosition: tooltipPosition
+  }, /*#__PURE__*/React.createElement(InputBehaviour, null, /*#__PURE__*/React.createElement(FormField, _extends({
+    disabled: disabled,
+    fieldHelpId: fieldHelpId,
+    fieldHelp: computeLabelPropValues(fieldHelp),
+    error: error,
+    warning: warning,
+    info: info,
+    label: label,
+    labelId: labelId,
+    labelAlign: computeLabelPropValues(labelAlign),
+    labelHelp: computeLabelPropValues(labelHelp),
+    labelInline: computeLabelPropValues(labelInline),
+    labelSpacing: labelSpacing,
+    labelWidth: computeLabelPropValues(labelWidth),
+    id: uniqueId,
+    reverse: computeLabelPropValues(reverse),
+    isOptional: isOptional,
+    useValidationIcon: computeLabelPropValues(validationOnLabel),
+    adaptiveLabelBreakpoint: adaptiveLabelBreakpoint,
+    isRequired: required,
+    "data-component": dataComponent,
+    "data-role": dataRole,
+    "data-element": dataElement,
+    validationIconId: validationRedesignOptIn ? undefined : validationIconId,
+    validationRedesignOptIn: validationRedesignOptIn
+  }, filterStyledSystemMarginProps(props)), validationRedesignOptIn && labelHelp && /*#__PURE__*/React.createElement(StyledHintText, null, labelHelp), validationRedesignOptIn ? /*#__PURE__*/React.createElement(Box, {
+    position: "relative"
+  }, /*#__PURE__*/React.createElement(ValidationMessage, {
+    error: error,
+    warning: warning
+  }), !disableErrorBorder && (error || warning) && /*#__PURE__*/React.createElement(ErrorBorder, {
+    warning: !!(!error && warning)
+  }), input) : input), characterCount));
 };
 
 Textbox.propTypes = {
@@ -240,6 +244,7 @@ Textbox.propTypes = {
   "aria-valuemin": PropTypes.number,
   "aria-valuenow": PropTypes.number,
   "aria-valuetext": PropTypes.string,
+  "as": PropTypes.elementType,
   "autoCapitalize": PropTypes.string,
   "autoComplete": PropTypes.string,
   "autoCorrect": PropTypes.string,

package/esm/components/textbox/textbox.style.js

@@ -6,10 +6,10 @@ const ErrorBorder = styled.span`
       position: absolute;
       z-index: 6;
       width: 2px;
-      height: calc(100% + var(--spacing300));
       background-color: ${warning ? "var(--colorsSemanticCaution500)" : "var(--colorsSemanticNegative500)"};
       left: -12px;
       bottom: 0px;
+      top: 0px;
     `}
 `;
 const StyledHintText = styled.p`

package/lib/__internal__/input/input.component.d.ts

@@ -1,6 +1,8 @@
 import React from "react";
 export interface CommonInputProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, "type"> {
     align?: "right" | "left";
+    /** Override the variant component */
+    as?: React.ElementType;
     /** If true the Component will be focused when rendered */
     autoFocus?: boolean;
     /** If true, the component will be disabled */
@@ -29,10 +31,14 @@ export interface CommonInputProps extends Omit<React.InputHTMLAttributes<HTMLInp
     required?: boolean;
 }
 export interface InputProps extends CommonInputProps {
+    /** The visible width of the text control, in average character widths */
+    cols?: number;
     /** Integer to determine a timeout for the defered callback */
     deferTimeout?: number;
     /** Defered callback to be called after the onChange event */
     onChangeDeferred?: (ev: React.ChangeEvent<HTMLInputElement>) => void;
+    /** The number of visible text lines for the control */
+    rows?: number;
     /** HTML type attribute of the input */
     type?: string;
 }

package/lib/__internal__/input/input.component.js

@@ -225,6 +225,7 @@ Input.propTypes = {
   "aria-valuemin": _propTypes.default.number,
   "aria-valuenow": _propTypes.default.number,
   "aria-valuetext": _propTypes.default.string,
+  "as": _propTypes.default.elementType,
   "autoCapitalize": _propTypes.default.string,
   "autoComplete": _propTypes.default.string,
   "autoCorrect": _propTypes.default.string,
@@ -235,6 +236,7 @@ Input.propTypes = {
   "children": _propTypes.default.node,
   "className": _propTypes.default.string,
   "color": _propTypes.default.string,
+  "cols": _propTypes.default.number,
   "contentEditable": _propTypes.default.oneOfType([_propTypes.default.oneOf(["false", "inherit", "true"]), _propTypes.default.bool]),
   "contextMenu": _propTypes.default.string,
   "crossOrigin": _propTypes.default.string,
@@ -499,6 +501,7 @@ Input.propTypes = {
     "trimStart": _propTypes.default.func.isRequired,
     "valueOf": _propTypes.default.func.isRequired
   })]),
+  "rows": _propTypes.default.number,
   "security": _propTypes.default.string,
   "size": _propTypes.default.number,
   "slot": _propTypes.default.string,

package/lib/components/date/date.component.js

@@ -315,7 +315,9 @@ const DateInput = ({
     "data-component": dataComponent || "date",
     "data-element": dataElement,
     "data-role": dataRole
-  }, (0, _utils2.filterStyledSystemMarginProps)(rest)), /*#__PURE__*/_react.default.createElement(_textbox.default, _extends({}, (0, _utils2.filterOutStyledSystemSpacingProps)(rest), {
+  }, (0, _utils2.filterStyledSystemMarginProps)(rest), {
+    applyDateRangeStyling: !!inputRefMap
+  }), /*#__PURE__*/_react.default.createElement(_textbox.default, _extends({}, (0, _utils2.filterOutStyledSystemSpacingProps)(rest), {
     value: computedValue(),
     onBlur: handleBlur,
     onChange: handleChange,

package/lib/components/date/date.style.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _styledComponents = _interopRequireDefault(require("styled-components"));
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
 var _propTypes = _interopRequireDefault(require("prop-types"));
 
@@ -17,8 +17,18 @@ var _input = _interopRequireDefault(require("../../__internal__/input/input.styl
 
 var _inputPresentation = _interopRequireDefault(require("../../__internal__/input/input-presentation.style"));
 
+var _formField = require("../../__internal__/form-field/form-field.style");
+
+var _validationMessage = _interopRequireDefault(require("../../__internal__/validation-message/validation-message.style"));
+
+var _label = _interopRequireDefault(require("../../__internal__/label/label.style"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
+
+function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
 const datePickerWidth = {
   large: "140px",
   medium: "135px",
@@ -37,6 +47,20 @@ const StyledDateInput = _styledComponents.default.div`
       margin-right: -8px;
     }
   }
+
+  ${({
+  applyDateRangeStyling,
+  size,
+  labelInline
+}) => applyDateRangeStyling && !labelInline && (0, _styledComponents.css)`
+      ${_formField.FieldLineStyle} {
+        max-width: ${datePickerWidth[size]};
+      }
+
+      ${_validationMessage.default}, ${_label.default} {
+        overflow-wrap: anywhere;
+      }
+    `}
 `;
 StyledDateInput.propTypes = {
   size: _propTypes.default.oneOf(["small", "medium", "large"])

package/lib/components/decimal/decimal.component.js

@@ -278,6 +278,7 @@ Decimal.propTypes = {
   "aria-valuemin": _propTypes.default.number,
   "aria-valuenow": _propTypes.default.number,
   "aria-valuetext": _propTypes.default.string,
+  "as": _propTypes.default.elementType,
   "autoCapitalize": _propTypes.default.string,
   "autoComplete": _propTypes.default.string,
   "autoCorrect": _propTypes.default.string,

package/lib/components/dialog-full-screen/dialog-full-screen.component.js

@@ -47,6 +47,7 @@ const DialogFullScreen = ({
   "aria-labelledby": ariaLabelledBy,
   disableAutoFocus,
   focusFirstElement,
+  bespokeFocusTrap,
   open,
   children,
   title,
@@ -119,6 +120,7 @@ const DialogFullScreen = ({
   }, componentTags), /*#__PURE__*/_react.default.createElement(_focusTrap.default, {
     autoFocus: !disableAutoFocus,
     focusFirstElement: focusFirstElement,
+    bespokeTrap: bespokeFocusTrap,
     wrapperRef: dialogRef,
     isOpen: open,
     additionalWrapperRefs: focusableContainers,
@@ -174,6 +176,13 @@ DialogFullScreen.propTypes = {
   /** Disables auto focus functionality on child elements */
   disableAutoFocus: _propTypes.default.bool,
 
+  /**
+   * Function to replace focus trap
+   * @ignore
+   * @private
+   */
+  bespokeFocusTrap: _propTypes.default.func,
+
   /** Determines if the Esc Key closes the Dialog */
   disableEscKey: _propTypes.default.bool,
 

package/lib/components/grouped-character/grouped-character.component.js

@@ -191,6 +191,7 @@ GroupedCharacter.propTypes = {
   "aria-valuemin": _propTypes.default.number,
   "aria-valuenow": _propTypes.default.number,
   "aria-valuetext": _propTypes.default.string,
+  "as": _propTypes.default.elementType,
   "autoCapitalize": _propTypes.default.string,
   "autoComplete": _propTypes.default.string,
   "autoCorrect": _propTypes.default.string,

package/lib/components/sidebar/sidebar.component.d.ts

@@ -28,6 +28,15 @@ export interface SidebarProps extends PaddingProps, TagProps, WidthProps {
     disableEscKey?: boolean;
     /** Set this prop to false to hide the translucent background when the dialog is open. */
     enableBackgroundUI?: boolean;
+    /** Optional reference to an element meant to be focused on open */
+    focusFirstElement?: React.MutableRefObject<HTMLElement | null>;
+    disableAutoFocus?: boolean;
+    /**
+     * Function to replace focus trap
+     * @ignore
+     * @private
+     */
+    bespokeFocusTrap?: (ev: KeyboardEvent, firstElement?: HTMLElement, lastElement?: HTMLElement) => void;
     /** Node that will be used as sidebar header. */
     header?: React.ReactNode;
     /** A custom close event handler */

package/lib/components/sidebar/sidebar.component.js

@@ -50,6 +50,8 @@ const Sidebar = /*#__PURE__*/_react.default.forwardRef(({
   "aria-label": ariaLabel,
   "aria-labelledby": ariaLabelledBy,
   open,
+  bespokeFocusTrap,
+  disableAutoFocus = false,
   disableEscKey = false,
   enableBackgroundUI = false,
   header,
@@ -58,6 +60,7 @@ const Sidebar = /*#__PURE__*/_react.default.forwardRef(({
   children,
   onCancel,
   role = "dialog",
+  focusFirstElement,
   focusableContainers,
   focusableSelectors,
   width,
@@ -135,7 +138,10 @@ const Sidebar = /*#__PURE__*/_react.default.forwardRef(({
     wrapperRef: sidebarRef,
     isOpen: open,
     additionalWrapperRefs: focusableContainers,
-    focusableSelectors: focusableSelectors
+    focusableSelectors: focusableSelectors,
+    focusFirstElement: focusFirstElement,
+    autoFocus: !disableAutoFocus,
+    bespokeTrap: bespokeFocusTrap
   }, sidebar));
 });
 
@@ -144,10 +150,12 @@ Sidebar.propTypes = {
   "aria-describedby": _propTypes.default.string,
   "aria-label": _propTypes.default.string,
   "aria-labelledby": _propTypes.default.string,
+  "bespokeFocusTrap": _propTypes.default.func,
   "children": _propTypes.default.node,
   "data-component": _propTypes.default.string,
   "data-element": _propTypes.default.string,
   "data-role": _propTypes.default.string,
+  "disableAutoFocus": _propTypes.default.bool,
   "disableEscKey": _propTypes.default.bool,
   "enableBackgroundUI": _propTypes.default.bool,
   "focusableContainers": _propTypes.default.arrayOf(_propTypes.default.shape({
@@ -160,6 +168,15 @@ Sidebar.propTypes = {
     }
   })),
   "focusableSelectors": _propTypes.default.string,
+  "focusFirstElement": _propTypes.default.shape({
+    "current": _propTypes.default.oneOfType([_propTypes.default.oneOf([null]), function (props, propName) {
+      if (props[propName] == null) {
+        return new Error("Prop '" + propName + "' is required but wasn't specified");
+      } else if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {
+        return new Error("Expected prop '" + propName + "' to be of type Element");
+      }
+    }]).isRequired
+  }),
   "header": _propTypes.default.node,
   "onCancel": _propTypes.default.func,
   "open": _propTypes.default.bool.isRequired,

package/lib/components/textarea/index.d.ts

@@ -1 +1,2 @@
-export { default } from "./textarea";
+export { default } from "./textarea.component";
+export type { TextareaProps } from "./textarea.component";

package/lib/components/textarea/textarea.component.d.ts

@@ -0,0 +1,94 @@
+import React from "react";
+import { MarginProps } from "styled-system";
+import { IconType } from "../icon";
+import { ValidationProps } from "../../__internal__/validations";
+import { CommonInputProps } from "../../__internal__/input";
+export interface TextareaProps extends ValidationProps, MarginProps, Omit<CommonInputProps, "size"> {
+    /** Identifier used for testing purposes, applied to the root element of the component. */
+    "data-component"?: string;
+    /** Identifier used for testing purposes, applied to the root element of the component. */
+    "data-element"?: string;
+    /** Identifier used for testing purposes, applied to the root element of the component. */
+    "data-role"?: string;
+    /** id of the input */
+    id?: string;
+    /** Breakpoint for adaptive label (inline labels change to top aligned). Enables the adaptive behaviour when set */
+    adaptiveLabelBreakpoint?: number;
+    /** Automatically focus the input on component mount */
+    autoFocus?: boolean;
+    /** Character limit of the textarea */
+    characterLimit?: string | number;
+    /** Type of the icon that will be rendered next to the input */
+    children?: React.ReactNode;
+    /** The visible width of the text control, in average character widths */
+    cols?: number;
+    /** If true, the component will be disabled */
+    disabled?: boolean;
+    /** Stop the user typing over the characterLimit */
+    enforceCharacterLimit?: boolean;
+    /** Indicate that error has occurred
+    Pass string to display icon, tooltip and red border
+    Pass true boolean to only display red border */
+    error?: boolean | string;
+    /** Allows the Textareas Height to change based on user input */
+    expandable?: boolean;
+    /** Help content to be displayed under an input */
+    fieldHelp?: React.ReactNode;
+    /** Aria label for rendered help component */
+    helpAriaLabel?: string;
+    /** Indicate additional information
+    Pass string to display icon, tooltip and blue border
+    Pass true boolean to only display blue border */
+    info?: boolean | string;
+    /**
+     * <a href="https://brand.sage.com/d/NdbrveWvNheA/foundations#/icons/icons" target="_blank">List of supported icons</a>
+     *
+     * Icon to display inside of the Textarea
+     */
+    inputIcon?: IconType;
+    /** Width of an input in percentage. Works only when labelInline is true */
+    inputWidth?: number;
+    /** The content of the label for the input */
+    label?: string;
+    /** Inline label alignment */
+    labelAlign?: "left" | "right";
+    /** Text applied to label help tooltip */
+    labelHelp?: React.ReactNode;
+    /** When true, label is placed in line an input */
+    labelInline?: boolean;
+    /** Spacing between label and a field for inline label, given number will be multiplied by base spacing unit (8) */
+    labelSpacing?: 1 | 2;
+    /** Width of a label in percentage. Works only when labelInline is true */
+    labelWidth?: number;
+    /** Name of the input */
+    name?: string;
+    /** Callback fired when the user types in the Textarea */
+    onChange?: (ev: React.ChangeEvent<HTMLInputElement>) => void;
+    /** Placeholder text for the component */
+    placeholder?: string;
+    /** Adds readOnly property */
+    readOnly?: boolean;
+    /** Flag to configure component as mandatory */
+    required?: boolean;
+    /** The number of visible text lines for the control */
+    rows?: number;
+    /** One of type of size to apply to the textarea */
+    size?: "small" | "medium" | "large";
+    /** Message to be displayed in a Tooltip when the user hovers over the help icon */
+    tooltipMessage?: string;
+    /** Overrides the default tooltip position */
+    tooltipPosition?: "top" | "bottom" | "left" | "right";
+    /** When true, validation icon will be placed on label instead of being placed on the input */
+    validationOnLabel?: boolean;
+    /** The value of the Textbox */
+    value?: string;
+    /** Whether to display the character count message in red */
+    warnOverLimit?: boolean;
+    /** Indicate that warning has occurred
+    Pass string to display icon, tooltip and orange border
+    Pass true boolean to only display orange border */
+    warning?: boolean | string;
+}
+export declare const Textarea: ({ autoFocus, fieldHelp, label, size, children, characterLimit, enforceCharacterLimit, warnOverLimit, onChange, disabled, labelInline, labelAlign, labelHelp, labelSpacing, inputIcon, id: idProp, error, warning, info, name, readOnly, placeholder, expandable, rows, cols, validationOnLabel, adaptiveLabelBreakpoint, inputWidth, labelWidth, tooltipPosition, value, "data-component": dataComponent, "data-element": dataElement, "data-role": dataRole, helpAriaLabel, ...props }: TextareaProps) => JSX.Element;
+export { Textarea as OriginalTextarea };
+export default Textarea;