@dxc-technology/halstack-react 3.4.1 → 4.0.0

package/text-input/index.d.ts

@@ -0,0 +1,135 @@
+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 SVG = string | (HTMLElement & SVGElement);
+type Action = {
+  onClick: (event: React.MouseEvent<HTMLButtonElement>) => void;
+  icon: SVG;
+};
+
+type Props = {
+  /**
+   * Text to be placed above the input. This label will be used as the aria-label attribute of the list of suggestions.
+   */
+  label?: string;
+  /**
+   * Name attribute of the input element.
+   */
+  name?: string;
+  /**
+   * Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
+   */
+  value?: string;
+  /**
+   * Helper text to be placed above the input.
+   */
+  helperText?: string;
+  /**
+   * Text to be put as placeholder of the input.
+   */
+  placeholder?: string;
+  /**
+   * Action to be shown in the input. This is an object composed of an onClick function and an icon,
+   * being the latter either an inline svg or a URL to the image.
+   */
+  action?: Action;
+  /**
+   * If true, the input will have an action to clear the entered value.
+   */
+  clearable?: boolean;
+  /**
+   * If true, the component will be disabled.
+   */
+  disabled?: boolean;
+  /**
+   * If true, the input 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;
+  /**
+   * Prefix to be placed before the input value.
+   */
+  prefix?: string;
+  /**
+   * Suffix to be placed after the input value.
+   */
+  suffix?: string;
+  /**
+   * This function will be called when the user types within the input
+   * element of the component. 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 input element loses the focus.
+   * An object including the input 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?: (obj: { value: string; error: string }) => void;
+  /**
+   * If it is defined, the component will change its appearance, showing
+   * the error below the input component. If it is not defined, the error
+   * messages will be managed internally, but never displayed on its own.
+   */
+  error?: string;
+  /**
+   * These are the options to be displayed as suggestions. It can be either an array or a function:
+   *    - Array:    Array of options that will be filtered by the component.
+   *    - Function: This function will be called when the user changes the value, we will send as a parameter the new value;
+   *                apart from that this function should return one promise on which we should make 'then' to get the suggestions filtered.
+   */
+  suggestions?: string[] | (() => void);
+  /**
+    * Regular expression that defines the valid format allowed by the input.
+    * This will be checked both when the input element 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 and maximum length allowed by the input. 
+    * This will be checked both when the input element loses the
+    * focus and while typing within it. If the string entered does not
+    * comply the 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.
+   */
+  length?: { min?: number; max?: number };
+  /**
+   * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the input 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 DxcTextInput(props: Props): JSX.Element;

package/{dist/new-textarea/NewTextarea.js → textarea/Textarea.js}

@@ -54,7 +54,7 @@ function _templateObject5() {
 }
 
 function _templateObject4() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: 1.5em;\n"]);
+  var data = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: ", ";\n"]);
 
   _templateObject4 = function _templateObject4() {
     return data;
@@ -74,7 +74,7 @@ function _templateObject3() {
 }
 
 function _templateObject2() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: 1.75em;\n"]);
+  var data = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: ", ";\n"]);
 
   _templateObject2 = function _templateObject2() {
     return data;
@@ -93,19 +93,23 @@ function _templateObject() {
   return data;
 }
 
-var getLengthErrorMessage = function getLengthErrorMessage(length) {
-  return "Min length ".concat(length.min, ", max length ").concat(length.max, ".");
+var getNotOptionalErrorMessage = function getNotOptionalErrorMessage() {
+  return "This field is required. Please, enter a value.";
 };
 
-var patternMatch = function patternMatch(pattern, value) {
-  return new RegExp(pattern).test(value);
+var getLengthErrorMessage = function getLengthErrorMessage(length) {
+  return "Min length ".concat(length.min, ", max length ").concat(length.max, ".");
 };
 
 var getPatternErrorMessage = function getPatternErrorMessage() {
   return "Please match the format requested.";
 };
 
-var DxcNewTextarea = _react["default"].forwardRef(function (_ref, ref) {
+var patternMatch = function patternMatch(pattern, value) {
+  return new RegExp(pattern).test(value);
+};
+
+var DxcTextarea = _react["default"].forwardRef(function (_ref, ref) {
   var _ref$label = _ref.label,
       label = _ref$label === void 0 ? "" : _ref$label,
       _ref$name = _ref.name,
@@ -123,12 +127,12 @@ var DxcNewTextarea = _react["default"].forwardRef(function (_ref, ref) {
       verticalGrow = _ref$verticalGrow === void 0 ? "auto" : _ref$verticalGrow,
       _ref$rows = _ref.rows,
       rows = _ref$rows === void 0 ? 4 : _ref$rows,
-      length = _ref.length,
-      pattern = _ref.pattern,
       onChange = _ref.onChange,
       onBlur = _ref.onBlur,
       _ref$error = _ref.error,
       error = _ref$error === void 0 ? "" : _ref$error,
+      pattern = _ref.pattern,
+      length = _ref.length,
       _ref$autocomplete = _ref.autocomplete,
       autocomplete = _ref$autocomplete === void 0 ? "off" : _ref$autocomplete,
       margin = _ref.margin,
@@ -142,45 +146,54 @@ var DxcNewTextarea = _react["default"].forwardRef(function (_ref, ref) {
       innerValue = _useState2[0],
       setInnerValue = _useState2[1];
 
-  var _useState3 = (0, _react.useState)(""),
-      _useState4 = (0, _slicedToArray2["default"])(_useState3, 2),
-      validationError = _useState4[0],
-      changeValidationError = _useState4[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 textareaId = "textarea-".concat((0, _uuid.v4)());
+  var errorId = "error-message-".concat(textareaId);
 
-  var changeValue = function changeValue(newValue) {
-    value !== null && value !== void 0 ? value : setInnerValue(newValue);
-    typeof onChange === "function" && onChange(newValue);
+  var isNotOptional = function isNotOptional(value) {
+    return value === "" && !optional;
   };
 
   var isLengthIncorrect = function isLengthIncorrect(value) {
     return value !== "" && length && length.min && length.max && (value.length < length.min || value.length > length.max);
   };
 
+  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(length)
+    });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 (isLengthIncorrect(event.target.value)) {
-      changeValidationError(getLengthErrorMessage(length, event));
-      onBlur === null || onBlur === void 0 ? void 0 : onBlur({
-        value: event.target.value,
-        error: getLengthErrorMessage(length)
-      });
-    } else if (event.target.value && pattern && !patternMatch(pattern, event.target.value)) {
-      changeValidationError(getPatternErrorMessage());
-      onBlur === null || onBlur === void 0 ? void 0 : onBlur({
-        value: event.target.value,
-        error: getPatternErrorMessage()
-      });
-    } else {
-      changeValidationError("");
-      onBlur === null || onBlur === void 0 ? void 0 : onBlur({
-        value: event.target.value,
-        error: null
-      });
-    }
+    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(length)
+    });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) {
@@ -197,8 +210,8 @@ var DxcNewTextarea = _react["default"].forwardRef(function (_ref, ref) {
     }
   }, [value, verticalGrow, rows, innerValue]);
   return _react["default"].createElement(_styledComponents.ThemeProvider, {
-    theme: colorsTheme.newTextarea
-  }, _react["default"].createElement(DxcTextarea, {
+    theme: colorsTheme.textarea
+  }, _react["default"].createElement(TextareaContainer, {
     margin: margin,
     size: size,
     ref: ref
@@ -219,14 +232,20 @@ var DxcNewTextarea = _react["default"].forwardRef(function (_ref, ref) {
     onChange: handleTOnChange,
     onBlur: handleTOnBlur,
     disabled: disabled,
-    error: error || validationError,
+    error: error,
+    minLength: length === null || length === void 0 ? void 0 : length.min,
+    maxLength: length === null || length === void 0 ? void 0 : length.max,
     autoComplete: autocomplete,
     backgroundType: backgroundType,
     ref: textareaRef,
-    tabIndex: tabIndex
-  }), _react["default"].createElement(Error, {
+    tabIndex: tabIndex,
+    "aria-invalid": error ? "true" : "false",
+    "aria-describedby": error ? errorId : undefined,
+    "aria-required": optional ? "false" : "true"
+  }), !disabled && _react["default"].createElement(Error, {
+    id: errorId,
     backgroundType: backgroundType
-  }, error || validationError)));
+  }, error)));
 });
 
 var sizes = {
@@ -240,7 +259,7 @@ 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 DxcTextarea = _styledComponents["default"].div(_templateObject(), function (props) {
+var TextareaContainer = _styledComponents["default"].div(_templateObject(), function (props) {
   return calculateWidth(props.margin, props.size);
 }, function (props) {
   return props.margin && (0, _typeof2["default"])(props.margin) !== "object" ? _variables.spaces[props.margin] : "0px";
@@ -264,6 +283,8 @@ var Label = _styledComponents["default"].label(_templateObject2(), function (pro
   return props.theme.labelFontStyle;
 }, function (props) {
   return props.theme.labelFontWeight;
+}, function (props) {
+  return props.theme.labelLineHeight;
 });
 
 var OptionalLabel = _styledComponents["default"].span(_templateObject3(), function (props) {
@@ -280,6 +301,8 @@ var HelperText = _styledComponents["default"].span(_templateObject4(), function
   return props.theme.helperTextFontStyle;
 }, function (props) {
   return props.theme.helperTextFontWeight;
+}, function (props) {
+  return props.theme.helperTextLineHeight;
 });
 
 var Textarea = _styledComponents["default"].textarea(_templateObject5(), function (props) {
@@ -314,7 +337,7 @@ var Error = _styledComponents["default"].span(_templateObject6(), function (prop
   return props.theme.fontFamily;
 });
 
-DxcNewTextarea.propTypes = {
+DxcTextarea.propTypes = {
   label: _propTypes["default"].string,
   name: _propTypes["default"].string,
   value: _propTypes["default"].string,
@@ -342,5 +365,5 @@ DxcNewTextarea.propTypes = {
   size: _propTypes["default"].oneOf((0, _toConsumableArray2["default"])(Object.keys(sizes))),
   tabIndex: _propTypes["default"].number
 };
-var _default = DxcNewTextarea;
+var _default = DxcTextarea;
 exports["default"] = _default;

package/textarea/index.d.ts

@@ -0,0 +1,117 @@
+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 and 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 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.
+   */
+  length?: { min: number; max: 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;

package/toggle/index.d.ts

@@ -0,0 +1,21 @@
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
+  top?: Space;
+  bottom?: Space;
+  left?: Space;
+  right?: Space;
+};
+
+type Props = {
+  label?: string;
+  helperText?: string;
+  value?: any;
+  onChange?: void;
+  disabled?: boolean,
+  options?: any;
+  multiple?: boolean;
+  margin?: Space | Margin;
+  tabIndex?: number;
+};
+
+export default function DxcToggle(props: Props): JSX.Element;