@dxc-technology/halstack-react 0.0.0-c5f6a2f → 0.0.0-c796a1b

package/textarea/Textarea.js

@@ -0,0 +1,314 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof3 = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+
+var _utils = require("../common/utils.js");
+
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _variables = require("../common/variables.js");
+
+var _uuid = require("uuid");
+
+var _BackgroundColorContext = _interopRequireDefault(require("../BackgroundColorContext"));
+
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6;
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof3(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && 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; }
+
+var getNotOptionalErrorMessage = function getNotOptionalErrorMessage() {
+  return "This field is required. Please, enter a value.";
+};
+
+var getPatternErrorMessage = function getPatternErrorMessage() {
+  return "Please match the format requested.";
+};
+
+var patternMatch = function patternMatch(pattern, value) {
+  return new RegExp(pattern).test(value);
+};
+
+var DxcTextarea = /*#__PURE__*/_react["default"].forwardRef(function (_ref, ref) {
+  var label = _ref.label,
+      _ref$name = _ref.name,
+      name = _ref$name === void 0 ? "" : _ref$name,
+      value = _ref.value,
+      helperText = _ref.helperText,
+      _ref$placeholder = _ref.placeholder,
+      placeholder = _ref$placeholder === void 0 ? "" : _ref$placeholder,
+      _ref$disabled = _ref.disabled,
+      disabled = _ref$disabled === void 0 ? false : _ref$disabled,
+      _ref$optional = _ref.optional,
+      optional = _ref$optional === void 0 ? false : _ref$optional,
+      _ref$verticalGrow = _ref.verticalGrow,
+      verticalGrow = _ref$verticalGrow === void 0 ? "auto" : _ref$verticalGrow,
+      _ref$rows = _ref.rows,
+      rows = _ref$rows === void 0 ? 4 : _ref$rows,
+      onChange = _ref.onChange,
+      onBlur = _ref.onBlur,
+      error = _ref.error,
+      pattern = _ref.pattern,
+      minLength = _ref.minLength,
+      maxLength = _ref.maxLength,
+      _ref$autocomplete = _ref.autocomplete,
+      autocomplete = _ref$autocomplete === void 0 ? "off" : _ref$autocomplete,
+      margin = _ref.margin,
+      _ref$size = _ref.size,
+      size = _ref$size === void 0 ? "medium" : _ref$size,
+      _ref$tabIndex = _ref.tabIndex,
+      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
+
+  var _useState = (0, _react.useState)(""),
+      _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+      innerValue = _useState2[0],
+      setInnerValue = _useState2[1];
+
+  var _useState3 = (0, _react.useState)("textarea-".concat((0, _uuid.v4)())),
+      _useState4 = (0, _slicedToArray2["default"])(_useState3, 1),
+      textareaId = _useState4[0];
+
+  var colorsTheme = (0, _useTheme["default"])();
+  var backgroundType = (0, _react.useContext)(_BackgroundColorContext["default"]);
+  var textareaRef = (0, _react.useRef)(null);
+  var errorId = "error-message-".concat(textareaId);
+
+  var getLengthErrorMessage = function getLengthErrorMessage() {
+    return "Min length ".concat(minLength, ", max length ").concat(maxLength, ".");
+  };
+
+  var isNotOptional = function isNotOptional(value) {
+    return value === "" && !optional;
+  };
+
+  var isLengthIncorrect = function isLengthIncorrect(value) {
+    return value !== "" && minLength && maxLength && (value.length < minLength || value.length > maxLength);
+  };
+
+  var changeValue = function changeValue(newValue) {
+    value !== null && value !== void 0 ? value : setInnerValue(newValue);
+    if (isNotOptional(newValue)) onChange === null || onChange === void 0 ? void 0 : onChange({
+      value: newValue,
+      error: getNotOptionalErrorMessage()
+    });else if (isLengthIncorrect(newValue)) onChange === null || onChange === void 0 ? void 0 : onChange({
+      value: newValue,
+      error: getLengthErrorMessage()
+    });else if (newValue && pattern && !patternMatch(pattern, newValue)) onChange === null || onChange === void 0 ? void 0 : onChange({
+      value: newValue,
+      error: getPatternErrorMessage()
+    });else onChange === null || onChange === void 0 ? void 0 : onChange({
+      value: newValue,
+      error: null
+    });
+  };
+
+  var handleTOnBlur = function handleTOnBlur(event) {
+    if (isNotOptional(event.target.value)) onBlur === null || onBlur === void 0 ? void 0 : onBlur({
+      value: event.target.value,
+      error: getNotOptionalErrorMessage()
+    });else if (isLengthIncorrect(event.target.value)) onBlur === null || onBlur === void 0 ? void 0 : onBlur({
+      value: event.target.value,
+      error: getLengthErrorMessage()
+    });else if (event.target.value && pattern && !patternMatch(pattern, event.target.value)) onBlur === null || onBlur === void 0 ? void 0 : onBlur({
+      value: event.target.value,
+      error: getPatternErrorMessage()
+    });else onBlur === null || onBlur === void 0 ? void 0 : onBlur({
+      value: event.target.value,
+      error: null
+    });
+  };
+
+  var handleTOnChange = function handleTOnChange(event) {
+    changeValue(event.target.value);
+  };
+
+  (0, _react.useLayoutEffect)(function () {
+    if (verticalGrow === "auto") {
+      var textareaLineHeight = parseInt(window.getComputedStyle(textareaRef.current)["line-height"]);
+      var textareaPaddingTopBottom = parseInt(window.getComputedStyle(textareaRef.current)["padding-top"]) * 2;
+      textareaRef.current.style.height = "".concat(textareaLineHeight * rows, "px");
+      var newHeight = textareaRef.current.scrollHeight - textareaPaddingTopBottom;
+      textareaRef.current.style.height = "".concat(newHeight, "px");
+    }
+  }, [value, verticalGrow, rows, innerValue]);
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.textarea
+  }, /*#__PURE__*/_react["default"].createElement(TextareaContainer, {
+    margin: margin,
+    size: size,
+    ref: ref
+  }, label && /*#__PURE__*/_react["default"].createElement(Label, {
+    htmlFor: textareaId,
+    disabled: disabled,
+    backgroundType: backgroundType,
+    helperText: helperText
+  }, label, " ", optional && /*#__PURE__*/_react["default"].createElement(OptionalLabel, null, "(Optional)")), helperText && /*#__PURE__*/_react["default"].createElement(HelperText, {
+    disabled: disabled,
+    backgroundType: backgroundType
+  }, helperText), /*#__PURE__*/_react["default"].createElement(Textarea, {
+    id: textareaId,
+    name: name,
+    value: value !== null && value !== void 0 ? value : innerValue,
+    placeholder: placeholder,
+    verticalGrow: verticalGrow,
+    rows: rows,
+    onChange: handleTOnChange,
+    onBlur: handleTOnBlur,
+    disabled: disabled,
+    error: error,
+    minLength: minLength,
+    maxLength: maxLength,
+    autoComplete: autocomplete,
+    backgroundType: backgroundType,
+    ref: textareaRef,
+    tabIndex: tabIndex,
+    "aria-invalid": error ? "true" : "false",
+    "aria-describedby": error ? errorId : undefined,
+    "aria-required": optional ? "false" : "true"
+  }), !disabled && typeof error === "string" && /*#__PURE__*/_react["default"].createElement(Error, {
+    id: errorId,
+    backgroundType: backgroundType
+  }, error)));
+});
+
+var sizes = {
+  small: "240px",
+  medium: "360px",
+  large: "480px",
+  fillParent: "100%"
+};
+
+var calculateWidth = function calculateWidth(margin, size) {
+  return size === "fillParent" ? "calc(".concat(sizes[size], " - ").concat((0, _utils.getMargin)(margin, "left"), " - ").concat((0, _utils.getMargin)(margin, "right"), ")") : sizes[size];
+};
+
+var TextareaContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-direction: column;\n\n  width: ", ";\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n"])), function (props) {
+  return calculateWidth(props.margin, props.size);
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) !== "object" ? _variables.spaces[props.margin] : "0px";
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.top ? _variables.spaces[props.margin.top] : "";
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.right ? _variables.spaces[props.margin.right] : "";
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.bottom ? _variables.spaces[props.margin.bottom] : "";
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.left ? _variables.spaces[props.margin.left] : "";
+});
+
+var Label = _styledComponents["default"].label(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: ", ";\n  ", "\n"])), function (props) {
+  return props.disabled ? props.backgroundType === "dark" ? props.theme.disabledLabelFontColorOnDark : props.theme.disabledLabelFontColor : props.backgroundType === "dark" ? props.theme.labelFontColorOnDark : props.theme.labelFontColor;
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.labelFontSize;
+}, function (props) {
+  return props.theme.labelFontStyle;
+}, function (props) {
+  return props.theme.labelFontWeight;
+}, function (props) {
+  return props.theme.labelLineHeight;
+}, function (props) {
+  return !props.helperText && "margin-bottom: 0.25rem";
+});
+
+var OptionalLabel = _styledComponents["default"].span(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  font-weight: ", ";\n"])), function (props) {
+  return props.theme.optionalLabelFontWeight;
+});
+
+var HelperText = _styledComponents["default"].span(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: ", ";\n  margin-bottom: 0.25rem;\n"])), function (props) {
+  return props.disabled ? props.backgroundType === "dark" ? props.theme.disabledHelperTextFontColorOnDark : props.theme.disabledHelperTextFontColor : props.backgroundType === "dark" ? props.theme.helperTextFontColorOnDark : props.theme.helperTextFontColor;
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.helperTextFontSize;
+}, function (props) {
+  return props.theme.helperTextFontStyle;
+}, function (props) {
+  return props.theme.helperTextFontWeight;
+}, function (props) {
+  return props.theme.helperTextLineHeight;
+});
+
+var Textarea = _styledComponents["default"].textarea(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  ", ";\n  ", "\n\n  padding: 0.5rem 1rem;\n  box-shadow: 0 0 0 2px transparent;\n  border-radius: 0.25rem;\n  border: 1px solid\n    ", ";\n  ", "\n\n  ", ";\n  ", ";\n\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: 1.5em;\n\n  ::placeholder {\n    color: ", ";\n  }\n"])), function (props) {
+  if (props.verticalGrow === "none") return "resize: none;";else if (props.verticalGrow === "auto") return "resize: none; overflow: hidden;";else if (props.verticalGrow === "manual") return "resize: vertical;";else return "resize: none;";
+}, function (props) {
+  if (props.disabled) return props.backgroundType === "dark" ? "background-color: ".concat(props.theme.disabledContainerFillColorOnDark, ";") : "background-color: ".concat(props.theme.disabledContainerFillColor, ";");else return "background-color: transparent;";
+}, function (props) {
+  if (props.disabled) return props.backgroundType === "dark" ? props.theme.disabledBorderColorOnDark : props.theme.disabledBorderColor;else return props.backgroundType === "dark" ? props.theme.enabledBorderColorOnDark : props.theme.enabledBorderColor;
+}, function (props) {
+  return props.error && !props.disabled && "border-color: transparent;\n     box-shadow: 0 0 0 2px ".concat(props.backgroundType === "dark" ? props.theme.errorBorderColorOnDark : props.theme.errorBorderColor, ";\n  ");
+}, function (props) {
+  return props.disabled && "cursor: not-allowed;";
+}, function (props) {
+  return !props.disabled && "\n      &:hover {\n        border-color: ".concat(props.error ? "transparent" : props.backgroundType === "dark" ? props.theme.hoverBorderColorOnDark : props.theme.hoverBorderColor, ";\n        ").concat(props.error && "box-shadow: 0 0 0 2px ".concat(props.backgroundType === "dark" ? props.theme.hoverErrorBorderColorOnDark : props.theme.hoverErrorBorderColor, ";"), "\n      }\n      &:focus {\n        outline: none;\n        border-color: transparent;\n        box-shadow: 0 0 0 2px ").concat(props.backgroundType === "dark" ? props.theme.focusBorderColorOnDark : props.theme.focusBorderColor, ";\n      }\n      &:focus-within {\n        outline: none;\n        border-color: transparent;\n        box-shadow: 0 0 0 2px ").concat(props.backgroundType === "dark" ? props.theme.focusBorderColorOnDark : props.theme.focusBorderColor, ";\n      }\n    ");
+}, function (props) {
+  return props.disabled ? props.backgroundType === "dark" ? props.theme.disabledValueFontColorOnDark : props.theme.disabledValueFontColor : props.backgroundType === "dark" ? props.theme.valueFontColorOnDark : props.theme.valueFontColor;
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.valueFontSize;
+}, function (props) {
+  return props.theme.valueFontStyle;
+}, function (props) {
+  return props.theme.valueFontWeight;
+}, function (props) {
+  return props.disabled ? props.backgroundType === "dark" ? props.theme.disabledPlaceholderFontColorOnDark : props.theme.disabledPlaceholderFontColor : props.backgroundType === "dark" ? props.theme.placeholderFontColorOnDark : props.theme.placeholderFontColor;
+});
+
+var Error = _styledComponents["default"].span(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  font-family: ", ";\n  font-size: 0.75rem;\n  font-weight: 400;\n  min-height: 1.5em;\n  line-height: 1.5em;\n  margin-top: 0.25rem;\n"])), function (props) {
+  return props.backgroundType === "dark" ? props.theme.errorMessageColorOnDark : props.theme.errorMessageColor;
+}, function (props) {
+  return props.theme.fontFamily;
+});
+
+DxcTextarea.propTypes = {
+  label: _propTypes["default"].string,
+  name: _propTypes["default"].string,
+  value: _propTypes["default"].string,
+  helperText: _propTypes["default"].string,
+  placeholder: _propTypes["default"].string,
+  verticalGrow: _propTypes["default"].oneOf(["auto", "none", "manual"]),
+  rows: _propTypes["default"].number,
+  minLength: _propTypes["default"].number,
+  maxLength: _propTypes["default"].number,
+  pattern: _propTypes["default"].string,
+  disabled: _propTypes["default"].bool,
+  optional: _propTypes["default"].bool,
+  onChange: _propTypes["default"].func,
+  onBlur: _propTypes["default"].func,
+  error: _propTypes["default"].string,
+  autocomplete: _propTypes["default"].string,
+  margin: _propTypes["default"].oneOfType([_propTypes["default"].shape({
+    top: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
+    bottom: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
+    left: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
+    right: _propTypes["default"].oneOf(Object.keys(_variables.spaces))
+  }), _propTypes["default"].oneOf((0, _toConsumableArray2["default"])(Object.keys(_variables.spaces)))]),
+  size: _propTypes["default"].oneOf((0, _toConsumableArray2["default"])(Object.keys(sizes))),
+  tabIndex: _propTypes["default"].number
+};
+var _default = DxcTextarea;
+exports["default"] = _default;

package/textarea/Textarea.stories.jsx

@@ -0,0 +1,135 @@
+import React from "react";
+import DxcTextarea from "./Textarea";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import { BackgroundColorProvider } from "../BackgroundColorContext";
+import DarkContainer from "../../.storybook/components/DarkSection";
+
+export default {
+  title: "Textarea",
+  component: DxcTextarea,
+};
+
+export const Chromatic = () => (
+  <>
+    <>
+      <ExampleContainer pseudoState="pseudo-hover">
+        <Title title="Hovered" theme="light" level={4} />
+        <DxcTextarea label="Hovered" />
+      </ExampleContainer>
+      <ExampleContainer pseudoState="pseudo-focus">
+        <Title title="Focused" theme="light" level={4} />
+        <DxcTextarea label="Focused" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Disabled" theme="light" level={4} />
+        <DxcTextarea
+          label="Disabled"
+          optional
+          helperText="Sample text"
+          placeholder="Enter your text here..."
+          disabled
+        />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Disabled with value" theme="light" level={4} />
+        <DxcTextarea label="Disabled" value="Example text" disabled />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="With error" theme="light" level={4} />
+        <DxcTextarea
+          label="Textarea with error"
+          helperText="Helper text"
+          placeholder="Enter your text here..."
+          error="Error message"
+        />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Helper text and optional with value" theme="light" level={4} />
+        <DxcTextarea label="Helper & optional" value="Some text" helperText="Sample text" optional />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Resizable" theme="light" level={4} />
+        <DxcTextarea label="With resizer" helperText="Helper text" verticalGrow="manual" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Grow manual" theme="light" level={4} />
+        <DxcTextarea
+          label="Manual vertical grow"
+          verticalGrow="manual"
+          value="Long textttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttt"
+        />
+      </ExampleContainer>
+    </>
+    <BackgroundColorProvider color="#333333">
+      <DarkContainer>
+        <>
+          <Title title="Helper text and optional with value" theme="dark" level={4} />
+          <DxcTextarea label="Helper & optional" value="Some text" margin="medium" helperText="Sample text" optional />
+
+          <Title title="Disabled" theme="dark" level={4} />
+          <DxcTextarea
+            label="Disabled"
+            margin="medium"
+            optional
+            helperText="Sample text"
+            placeholder="Enter your text here..."
+            disabled
+          />
+          <Title title="Disabled with value" theme="dark" level={4} />
+          <DxcTextarea label="Disabled" margin="medium" value="Example text" disabled />
+          <Title title="With error" theme="dark" level={4} />
+          <DxcTextarea
+            label="Textarea with error"
+            margin="medium"
+            helperText="Helper text"
+            placeholder="Enter your text here..."
+            error="Error message"
+          />
+        </>
+      </DarkContainer>
+    </BackgroundColorProvider>
+    <Title title="Sizes" theme="light" level={2} />
+    <ExampleContainer>
+      <DxcTextarea label="Small" size="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcTextarea label="Medium" size="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcTextarea label="Large" size="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcTextarea label="Fill parent" size="fillParent" />
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcTextarea label="Xxsmmall" margin="xxsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcTextarea label="xsmmall" margin="xsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcTextarea label="smmall" margin="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcTextarea label="medium" margin="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcTextarea label="Large" margin="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcTextarea label="Xlarge" margin="xlarge" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcTextarea label="Xxlarge" margin="xxlarge" />
+    </ExampleContainer>
+  </>
+);

package/textarea/index.d.ts

@@ -0,0 +1,127 @@
+type Size = "small" | "medium" | "large" | "fillParent";
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
+  top?: Space;
+  bottom?: Space;
+  left?: Space;
+  right?: Space;
+};
+
+type Props = {
+  /**
+   * Text to be placed above the textarea.
+   */
+  label?: string;
+  /**
+   * Name attribute of the textarea element.
+   */
+  name?: string;
+  /**
+   * Value of the textarea. If undefined, the component will be uncontrolled and the value will be managed internally.
+   */
+  value?: string;
+  /**
+   * Helper text to be placed above the textarea.
+   */
+  helperText?: string;
+  /**
+   * Text to be put as placeholder of the textarea.
+   */
+  placeholder?: string;
+  /**
+   * If true, the component will be disabled.
+   */
+  disabled?: boolean;
+  /**
+   * If true, the textarea will be optional, showing '(Optional)'
+   * next to the label. Otherwise, the field will be considered required
+   * and an error will be passed as a parameter to the OnBlur and onChange functions
+   * when it has not been filled.
+   */
+  optional?: boolean;
+  /**
+   * Defines the textarea's ability to resize vertically. It can be:
+   *    - 'auto': The textarea grows or shrinks automatically in order to fit the content.
+   *    - 'manual': The height of the textarea is enabled to be manually modified.
+   *    - 'none': The textarea has a fixed height and can't be modified.
+   */
+  verticalGrow?: "auto" | "manual" | "none";
+  /**
+   * Number of rows of the textarea.
+   */
+  rows?: number;
+  /**
+   * This function will be called when the user types within the textarea.
+   * An object including the current value and the error (if the value
+   * entered is not valid) will be passed to this function.
+   * If there is no error, error will be null.
+   */
+  onChange?: (val: { value: string; error: string }) => void;
+  /**
+   * This function will be called when the textarea loses the focus. An
+   * object including the textarea value and the error (if the value entered
+   * is not valid) will be passed to this function. If there is no error,
+   * error will be null.
+   */
+  onBlur?: (val: { value: string; error: string }) => void;
+  /**
+   * If it is defined, the component will change its appearance, showing
+   * the error below the textarea. If it is not defined, the error
+   * messages will be managed internally, but never displayed on its own.
+   */
+  error?: string;
+  /**
+   * Regular expression that defines the valid format allowed by the
+   * textarea. This will be checked both when the textarea loses the focus
+   * and while typing within it. If the string entered does not match the
+   * pattern, the onBlur and onChange functions will be called with the
+   * current value and an internal error informing that this value does not
+   * match the pattern. If the pattern is met, the error parameter of both
+   * events will be null.
+   */
+  pattern?: string;
+  /**
+   * Specifies the minimun length allowed by the textarea.
+   * This will be checked both when the textarea loses the
+   * focus and while typing within it. If the string entered does not
+   * comply the minimum length, the onBlur and onChange functions will be called
+   * with the current value and an internal error informing that the value
+   * length does not comply the specified range. If a valid length is
+   * reached, the error parameter of both events will be null.
+   */
+  minLength?: number;
+  /**
+   * Specifies the maximum length allowed by the textarea.
+   * This will be checked both when the textarea loses the
+   * focus and while typing within it. If the string entered does not
+   * comply the maximum length, the onBlur and onChange functions will be called
+   * with the current value and an internal error informing that the value
+   * length does not comply the specified range. If a valid length is
+   * reached, the error parameter of both events will be null.
+   */
+  maxLength?: number;
+  /**
+   * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the textarea value.
+   * Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
+   */
+  autocomplete?: string;
+  /**
+   * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
+   * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
+   */
+  margin?: Space | Margin;
+  /**
+   * Size of the component ('small' | 'medium' | 'large' | 'fillParent').
+   */
+  size?: Size;
+  /**
+   * Value of the tabindex attribute.
+   */
+  tabIndex?: number;
+  /**
+   * Reference to the component.
+   */
+  ref?: React.RefObject<HTMLDivElement>;
+};
+
+export default function DxcTextarea(props: Props): JSX.Element;