@hitachivantara/uikit-react-core 4.0.3 → 4.0.4

package/dist/legacy/TextArea/TextArea.js

@@ -2,11 +2,8 @@ import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
 import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
 import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
 var _excluded = ["classes", "className", "id", "name", "value", "defaultValue", "required", "readOnly", "disabled", "label", "aria-label", "aria-labelledby", "description", "aria-describedby", "onChange", "status", "statusMessage", "aria-errormessage", "placeholder", "autoFocus", "middleCountLabel", "rows", "resizable", "autoScroll", "hideCounter", "validationMessages", "maxCharQuantity", "minCharQuantity", "validation", "blockMax", "inputRef", "onBlur", "onFocus", "inputProps", "countCharProps"];
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 import "core-js/modules/es.function.name.js";
 import "core-js/modules/es.symbol.js";
 import "core-js/modules/es.symbol.description.js";
@@ -26,139 +23,135 @@ import { HvFormElement, HvBaseInput, HvLabel, HvInfoMessage, HvWarningText, HvCh
 import validationStates, { isInvalid } from "../Forms/FormElement/validationStates";
 import { DEFAULT_ERROR_MESSAGES, validationTypes, hasBuiltInValidations, validateInput, computeValidationState, computeValidationMessage } from "../BaseInput/validations";
 import styles from "./styles";
+
 /**
  * A text area is a multiline text input box, with an optional character counter when there is a length limit.
  */
-
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
-
 var HvTextArea = function HvTextArea(props) {
   var classes = props.classes,
-      className = props.className,
-      id = props.id,
-      name = props.name,
-      valueProp = props.value,
-      _props$defaultValue = props.defaultValue,
-      defaultValue = _props$defaultValue === void 0 ? "" : _props$defaultValue,
-      _props$required = props.required,
-      required = _props$required === void 0 ? false : _props$required,
-      _props$readOnly = props.readOnly,
-      readOnly = _props$readOnly === void 0 ? false : _props$readOnly,
-      _props$disabled = props.disabled,
-      disabled = _props$disabled === void 0 ? false : _props$disabled,
-      label = props.label,
-      ariaLabel = props["aria-label"],
-      ariaLabelledBy = props["aria-labelledby"],
-      description = props.description,
-      ariaDescribedBy = props["aria-describedby"],
-      onChange = props.onChange,
-      status = props.status,
-      statusMessage = props.statusMessage,
-      ariaErrorMessage = props["aria-errormessage"],
-      placeholder = props.placeholder,
-      _props$autoFocus = props.autoFocus,
-      autoFocus = _props$autoFocus === void 0 ? false : _props$autoFocus,
-      _props$middleCountLab = props.middleCountLabel,
-      middleCountLabel = _props$middleCountLab === void 0 ? "/" : _props$middleCountLab,
-      _props$rows = props.rows,
-      rows = _props$rows === void 0 ? 1 : _props$rows,
-      _props$resizable = props.resizable,
-      resizable = _props$resizable === void 0 ? false : _props$resizable,
-      _props$autoScroll = props.autoScroll,
-      autoScroll = _props$autoScroll === void 0 ? false : _props$autoScroll,
-      _props$hideCounter = props.hideCounter,
-      hideCounter = _props$hideCounter === void 0 ? false : _props$hideCounter,
-      validationMessages = props.validationMessages,
-      maxCharQuantity = props.maxCharQuantity,
-      minCharQuantity = props.minCharQuantity,
-      validation = props.validation,
-      _props$blockMax = props.blockMax,
-      blockMax = _props$blockMax === void 0 ? false : _props$blockMax,
-      inputRefProp = props.inputRef,
-      onBlur = props.onBlur,
-      onFocus = props.onFocus,
-      _props$inputProps = props.inputProps,
-      inputProps = _props$inputProps === void 0 ? {} : _props$inputProps,
-      _props$countCharProps = props.countCharProps,
-      countCharProps = _props$countCharProps === void 0 ? {} : _props$countCharProps,
-      others = _objectWithoutProperties(props, _excluded);
-
+    className = props.className,
+    id = props.id,
+    name = props.name,
+    valueProp = props.value,
+    _props$defaultValue = props.defaultValue,
+    defaultValue = _props$defaultValue === void 0 ? "" : _props$defaultValue,
+    _props$required = props.required,
+    required = _props$required === void 0 ? false : _props$required,
+    _props$readOnly = props.readOnly,
+    readOnly = _props$readOnly === void 0 ? false : _props$readOnly,
+    _props$disabled = props.disabled,
+    disabled = _props$disabled === void 0 ? false : _props$disabled,
+    label = props.label,
+    ariaLabel = props["aria-label"],
+    ariaLabelledBy = props["aria-labelledby"],
+    description = props.description,
+    ariaDescribedBy = props["aria-describedby"],
+    onChange = props.onChange,
+    status = props.status,
+    statusMessage = props.statusMessage,
+    ariaErrorMessage = props["aria-errormessage"],
+    placeholder = props.placeholder,
+    _props$autoFocus = props.autoFocus,
+    autoFocus = _props$autoFocus === void 0 ? false : _props$autoFocus,
+    _props$middleCountLab = props.middleCountLabel,
+    middleCountLabel = _props$middleCountLab === void 0 ? "/" : _props$middleCountLab,
+    _props$rows = props.rows,
+    rows = _props$rows === void 0 ? 1 : _props$rows,
+    _props$resizable = props.resizable,
+    resizable = _props$resizable === void 0 ? false : _props$resizable,
+    _props$autoScroll = props.autoScroll,
+    autoScroll = _props$autoScroll === void 0 ? false : _props$autoScroll,
+    _props$hideCounter = props.hideCounter,
+    hideCounter = _props$hideCounter === void 0 ? false : _props$hideCounter,
+    validationMessages = props.validationMessages,
+    maxCharQuantity = props.maxCharQuantity,
+    minCharQuantity = props.minCharQuantity,
+    validation = props.validation,
+    _props$blockMax = props.blockMax,
+    blockMax = _props$blockMax === void 0 ? false : _props$blockMax,
+    inputRefProp = props.inputRef,
+    onBlur = props.onBlur,
+    onFocus = props.onFocus,
+    _props$inputProps = props.inputProps,
+    inputProps = _props$inputProps === void 0 ? {} : _props$inputProps,
+    _props$countCharProps = props.countCharProps,
+    countCharProps = _props$countCharProps === void 0 ? {} : _props$countCharProps,
+    others = _objectWithoutProperties(props, _excluded);
   var elementId = useUniqueId(id, "hvtextarea");
   var inputRefOwn = useRef(null);
   var inputRef = inputRefProp || inputRefOwn;
-
   var _React$useState = React.useState(false),
-      _React$useState2 = _slicedToArray(_React$useState, 2),
-      focused = _React$useState2[0],
-      setFocused = _React$useState2[1]; // signals that the user has manually edited the input value
-
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    focused = _React$useState2[0],
+    setFocused = _React$useState2[1];
 
-  var isDirty = useRef(false); // value related state
+  // signals that the user has manually edited the input value
+  var isDirty = useRef(false);
 
+  // value related state
   var _useControlled = useControlled(valueProp, defaultValue),
-      _useControlled2 = _slicedToArray(_useControlled, 2),
-      value = _useControlled2[0],
-      setValue = _useControlled2[1];
-
-  var isEmptyValue = value == null || value === ""; // validation related state
+    _useControlled2 = _slicedToArray(_useControlled, 2),
+    value = _useControlled2[0],
+    setValue = _useControlled2[1];
+  var isEmptyValue = value == null || value === "";
 
+  // validation related state
   var _useControlled3 = useControlled(status, validationStates.standBy),
-      _useControlled4 = _slicedToArray(_useControlled3, 2),
-      validationState = _useControlled4[0],
-      setValidationState = _useControlled4[1];
-
+    _useControlled4 = _slicedToArray(_useControlled3, 2),
+    validationState = _useControlled4[0],
+    setValidationState = _useControlled4[1];
   var _useControlled5 = useControlled(statusMessage, ""),
-      _useControlled6 = _slicedToArray(_useControlled5, 2),
-      validationMessage = _useControlled6[0],
-      setValidationMessage = _useControlled6[1]; // validationMessages reference tends to change, as users will not memoize/useState for it;
+    _useControlled6 = _slicedToArray(_useControlled5, 2),
+    validationMessage = _useControlled6[0],
+    setValidationMessage = _useControlled6[1];
+
+  // validationMessages reference tends to change, as users will not memoize/useState for it;
   // dependencies must be more explicit so we set
   // eslint-disable-next-line react-hooks/exhaustive-deps
-
-
   var errorMessages = useMemo(function () {
     return _objectSpread(_objectSpread({}, DEFAULT_ERROR_MESSAGES), validationMessages);
-  }, // eslint-disable-next-line react-hooks/exhaustive-deps
+  },
+  // eslint-disable-next-line react-hooks/exhaustive-deps
   [validationMessages === null || validationMessages === void 0 ? void 0 : validationMessages.error, validationMessages === null || validationMessages === void 0 ? void 0 : validationMessages.requiredError, validationMessages === null || validationMessages === void 0 ? void 0 : validationMessages.minCharError, validationMessages === null || validationMessages === void 0 ? void 0 : validationMessages.maxCharError]);
-
   var isOverflow = function isOverflow(currentValue) {
     return isNil(maxCharQuantity) ? false : currentValue.length > maxCharQuantity;
-  }; // validates the input, sets the status and the statusMessage accordingly (if uncontrolled)
-  // and returns the validity state of the input.
-
+  };
 
+  // validates the input, sets the status and the statusMessage accordingly (if uncontrolled)
+  // and returns the validity state of the input.
   var performValidation = useCallback(function () {
-    var inputValidity = validateInput(inputRef.current, value, required, minCharQuantity, maxCharQuantity, validationTypes.none, validation); // this will only run if status is uncontrolled
+    var inputValidity = validateInput(inputRef.current, value, required, minCharQuantity, maxCharQuantity, validationTypes.none, validation);
 
-    setValidationState(computeValidationState(inputValidity, isEmptyValue)); // this will only run if statusMessage is uncontrolled
+    // this will only run if status is uncontrolled
+    setValidationState(computeValidationState(inputValidity, isEmptyValue));
 
+    // this will only run if statusMessage is uncontrolled
     setValidationMessage(computeValidationMessage(inputValidity, errorMessages));
     return inputValidity;
   }, [errorMessages, inputRef, isEmptyValue, maxCharQuantity, minCharQuantity, required, setValidationMessage, setValidationState, validation, value]);
+
   /**
    * Limit the string to the maxCharQuantity length.
    *
    * @param value - string to evaluate
    * @returns {string|*} - string according the limit
    */
-
   var limitValue = function limitValue(currentValue) {
     if (currentValue === undefined || !blockMax) return currentValue;
     return !isOverflow(currentValue) ? currentValue : currentValue.substring(0, maxCharQuantity);
   };
-
   var _useState = useState(autoScroll),
-      _useState2 = _slicedToArray(_useState, 2),
-      autoScrolling = _useState2[0],
-      setAutoScrolling = _useState2[1];
-
+    _useState2 = _slicedToArray(_useState, 2),
+    autoScrolling = _useState2[0],
+    setAutoScrolling = _useState2[1];
   var isScrolledDown = useCallback(function () {
     var el = inputRef.current;
     return el == null || el.offsetHeight + el.scrollTop >= el.scrollHeight;
   }, [inputRef]);
   var scrollDown = useCallback(function () {
     var el = inputRef.current;
-
     if (el != null) {
       el.scrollTop = el.scrollHeight - el.clientHeight;
     }
@@ -171,46 +164,45 @@ var HvTextArea = function HvTextArea(props) {
     };
     inputRef.current.addEventListener("scroll", scrollHandler);
   }, [inputRef, isScrolledDown]);
+
   /**
    * Validates the text area updating the state and modifying the warning text, also executes
    * the user provided onBlur passing the current validation status and value.
    *
    * @returns {undefined}
    */
-
   var onContainerBlurHandler = function onContainerBlurHandler(event) {
     setFocused(false);
     var inputValidity = performValidation();
     onBlur === null || onBlur === void 0 ? void 0 : onBlur(event, value, inputValidity);
   };
+
   /**
    * Updates the state putting again the value from the state because the input value is
    * not automatically manage, it also executes the onFocus function from the user passing the value
    */
-
-
   var onFocusHandler = function onFocusHandler(event) {
-    setFocused(true); // reset validation status to standBy (only when status is uncontrolled)
+    setFocused(true);
 
+    // reset validation status to standBy (only when status is uncontrolled)
     setValidationState(validationStates.standBy);
     onFocus === null || onFocus === void 0 ? void 0 : onFocus(event, value);
   };
+
   /**
    * Updates the length of the string while is being inputted, also executes the user onChange
    * allowing the customization of the input if required.
    *
    * @param {String} value - The value provided by the HvInput
    */
-
-
   var onChangeHandler = function onChangeHandler(event, currentValue) {
     isDirty.current = true;
-    var limitedValue = blockMax ? limitValue(currentValue) : currentValue; // set the input value (only when value is uncontrolled)
+    var limitedValue = blockMax ? limitValue(currentValue) : currentValue;
 
+    // set the input value (only when value is uncontrolled)
     setValue(limitedValue);
     onChange === null || onChange === void 0 ? void 0 : onChange(event, limitedValue);
   };
-
   useEffect(function () {
     if (autoScroll) {
       addScrollListener();
@@ -220,35 +212,35 @@ var HvTextArea = function HvTextArea(props) {
     if (autoScrolling) {
       scrollDown();
     }
-  }, [valueProp, autoScrolling, scrollDown]); // run initial validation after first render
-  // and also when any validation condition changes
+  }, [valueProp, autoScrolling, scrollDown]);
 
+  // run initial validation after first render
+  // and also when any validation condition changes
   useEffect(function () {
     if (focused || !isDirty.current && isEmptyValue) {
       // skip validation if currently focused or if empty and
       // the user never manually edited the input value
       return;
     }
-
     performValidation();
   }, [focused, isEmptyValue, performValidation]);
   var hasLabel = label != null;
   var hasDescription = description != null;
-  var hasCounter = maxCharQuantity != null && !hideCounter; // the error message area will only be created if:
+  var hasCounter = maxCharQuantity != null && !hideCounter;
+
+  // the error message area will only be created if:
   // - an external element that provides an error message isn't identified via aria-errormessage AND
   //   - both status and statusMessage properties are being controlled OR
   //   - status is uncontrolled and any of the built-in validations are active
-
-  var canShowError = ariaErrorMessage == null && (status !== undefined && statusMessage !== undefined || status === undefined && hasBuiltInValidations(required, validationTypes.none, minCharQuantity, // if blockMax is true maxCharQuantity will never produce an error
+  var canShowError = ariaErrorMessage == null && (status !== undefined && statusMessage !== undefined || status === undefined && hasBuiltInValidations(required, validationTypes.none, minCharQuantity,
+  // if blockMax is true maxCharQuantity will never produce an error
   // unless the value is controlled, so we can't prevent it to overflow maxCharQuantity
   maxCharQuantity != null && (blockMax !== true || value != null) ? maxCharQuantity : null, validation, inputProps));
   var isStateInvalid = isInvalid(validationState);
   var errorMessageId;
-
   if (isStateInvalid) {
     errorMessageId = canShowError ? setId(elementId, "error") : ariaErrorMessage;
   }
-
   return /*#__PURE__*/_jsxs(HvFormElement, {
     id: id,
     name: name,
@@ -313,13 +305,11 @@ var HvTextArea = function HvTextArea(props) {
     })]
   });
 };
-
 process.env.NODE_ENV !== "production" ? HvTextArea.propTypes = {
   /**
    * Class names to be applied.
    */
   className: PropTypes.string,
-
   /**
    * A Jss Object used to override or extend the component styles applied.
    */
@@ -328,83 +318,67 @@ process.env.NODE_ENV !== "production" ? HvTextArea.propTypes = {
      * Styles applied to the root container of the textarea.
      */
     root: PropTypes.string,
-
     /**
      * Style applied to the root when resizable is `true`.
      */
     disabled: PropTypes.string,
-
     /**
      * Style applied to the root when resizable is `true`.
      */
     resizable: PropTypes.string,
-
     /**
      * Style applied to the root when resizable is `true`.
      */
     invalid: PropTypes.string,
-
     /**
      * Styles applied to the base input root which is comprising of everything but the labels and descriptions.
      */
     baseInput: PropTypes.string,
-
     /**
      * Style applied on the text area element.
      */
     input: PropTypes.string,
-
     /**
      * Styles applied to text area element element when it is resizable. Can be used to set max/min width.
      */
     inputResizable: PropTypes.string,
-
     /**
      * Styles applied to text area container that holds the label, description and counter.
      */
     labelContainer: PropTypes.string,
-
     /**
      * Styles applied to the label element.
      */
     label: PropTypes.string,
-
     /**
      * Styles applied to the label element.
      */
     description: PropTypes.string,
-
     /**
      * Style applied on the character counter.
      */
     characterCounter: PropTypes.string,
-
     /**
      * Styles applied to the error area.
      */
     error: PropTypes.string
   }).isRequired,
-
   /**
    * Id to be applied to the form element root node.
    */
   id: PropTypes.string,
-
   /**
    * The form element name.
    */
   name: PropTypes.string,
-
   /**
    * The value of the form element.
    */
   value: PropTypes.string,
-
   /**
    * When uncontrolled, defines the initial input value.
    */
   defaultValue: PropTypes.string,
-
   /**
    * The label of the form element.
    *
@@ -412,42 +386,34 @@ process.env.NODE_ENV !== "production" ? HvTextArea.propTypes = {
    * If not provided, an aria-label or aria-labelledby must be inputted via inputProps.
    */
   label: PropTypes.node,
-
   /**
    * @ignore
    */
   "aria-label": PropTypes.string,
-
   /**
    * @ignore
    */
   "aria-labelledby": PropTypes.string,
-
   /**
    * Provide additional descriptive text for the form element.
    */
   description: PropTypes.node,
-
   /**
    * @ignore
    */
   "aria-describedby": PropTypes.string,
-
   /**
    * Indicates that the form element is disabled.
    */
   disabled: PropTypes.bool,
-
   /**
    * Indicates that the form element is not editable.
    */
   readOnly: PropTypes.bool,
-
   /**
    * Indicates that user input is required on the form element.
    */
   required: PropTypes.bool,
-
   /**
    * The status of the form element.
    *
@@ -457,34 +423,28 @@ process.env.NODE_ENV !== "production" ? HvTextArea.propTypes = {
    * or "invalid" after any change to `checked`, depending of the values of both `required` and `checked`.
    */
   status: PropTypes.oneOf(["standBy", "valid", "invalid"]),
-
   /**
    * The error message to show when `status` is "invalid".
    */
   statusMessage: PropTypes.string,
-
   /**
    * Identifies the element that provides an error message for the textarea.
    *
    * Will only be used when the validation status is invalid.
    */
   "aria-errormessage": PropTypes.string,
-
   /**
    * The function that will be executed onChange.
    */
   onChange: PropTypes.func,
-
   /**
    * The placeholder value of the input.
    */
   placeholder: PropTypes.string,
-
   /**
    * Text between the current char counter and max value.
    */
   middleCountLabel: PropTypes.string,
-
   /**
    * An Object containing the various texts associated with the input.
    */
@@ -493,95 +453,78 @@ process.env.NODE_ENV !== "production" ? HvTextArea.propTypes = {
      * The value when a validation fails.
      */
     error: PropTypes.string,
-
     /**
      * The message that appears when there are too many characters.
      */
     maxCharError: PropTypes.string,
-
     /**
      * The message that appears when there are too few characters.
      */
     minCharError: PropTypes.string,
-
     /**
      * The message that appears when the input is empty and required.
      */
     requiredError: PropTypes.string
   }),
-
   /**
    * Attributes applied to the input element.
    */
   inputProps: PropTypes.instanceOf(Object),
-
   /**
    * Allows passing a ref to the underlying input
    */
   inputRef: refType,
-
   /**
    * The function that will be executed onBlur, allows checking the validation state,
    * it receives the value and the validation state (`invalid`, `valid`).
    */
   onBlur: PropTypes.func,
-
   /**
    * The function that will be executed onBlur, allows checking the value state,
    * it receives the value.
    */
   onFocus: PropTypes.func,
-
   /**
    * The custom validation function, it receives the value and must return
    * either `true` for valid or `false` for invalid, default validations would only
    * occur if this function is null or undefined
    */
   validation: PropTypes.func,
-
   /**
    * If `true` it should autofocus.
    */
   autoFocus: PropTypes.bool,
-
   /**
    * The maximum allowed length of the characters, if this value is null no check
    * will be performed.
    */
   maxCharQuantity: PropTypes.number,
-
   /**
    * The minimum allowed length of the characters, if this value is null no check
    * will be perform.
    */
   minCharQuantity: PropTypes.number,
-
   /**
    * The number of rows of the text area
    */
   rows: PropTypes.number,
-
   /**
    * If `true` the component is resizable.
    */
   resizable: PropTypes.bool,
-
   /**
    * Auto-scroll: automatically scroll to the end on value changes.
    * Will stop if the user scrolls up and resume if scrolled to the bottom.
    */
   autoScroll: PropTypes.bool,
-
   /**
    * If `true` it isn't possible to have more characters than the `maxCharQuantity`
    */
   blockMax: PropTypes.bool,
-
   /**
    * If `true` the character counter isn't shown even if maxCharQuantity is set.
    */
   hideCounter: PropTypes.bool,
-
   /**
    * Props passed to the HvCharCount component.
    */