@dxc-technology/halstack-react 0.0.0-7da4003 → 0.0.0-83f5e92

package/select/index.d.ts

@@ -0,0 +1,131 @@
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
+  top?: Space;
+  bottom?: Space;
+  left?: Space;
+  right?: Space;
+};
+type SVG = React.SVGProps<SVGSVGElement> | React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
+
+type OptionGroup = {
+  /**
+   * Label of the group to be shown in the select's listbox.
+   */
+  label: string;
+  /**
+   * List of the grouped options.
+   */
+  options: Option[];
+};
+type Option = {
+  /**
+   * Element used as the icon that will be placed before the option label. 
+   * It can be a url of an image or an inline SVG. If the url option 
+   * is the chosen one, take into account that the component's 
+   * color styling tokens will not be applied to the image.
+   */
+  icon?: string | SVG;
+  /**
+   * Label of the option to be shown in the select's listbox.
+   */
+  label: string;
+  /**
+   * Value of the option. It should be unique and
+   * not an empty string, which is reserved to the empty option added
+   * by optional prop.
+   */
+  value: string;
+};
+
+type Props = {
+  /**
+   * Text to be placed above the select.
+   */
+  label?: string;
+  /**
+   * Name attribute of the input element. This attribute will allow users
+   * to find the component's value during the submit event. In this event,
+   * the component's value will always be a regular string, for both single
+   * and multiple selection modes, been in the first one a single option
+   * value and in the multiple variant more than one option value,
+   * separated by commas.
+   */
+  name?: string;
+  /**
+   * Value of the select. If undefined, the component will be uncontrolled
+   * and the value will be managed internally by the component.
+   */
+  value?: string | string[];
+  /**
+   * An array of objects representing the selectable options.
+   */
+  options?: Option[] | OptionGroup[];
+  /**
+   * Helper text to be placed above the select.
+   */
+  helperText?: string;
+  /**
+   * Text to be put as placeholder of the select.
+   */
+  placeholder?: string;
+  /**
+   * If true, the component will be disabled.
+   */
+  disabled?: boolean;
+  /**
+   * If true, the select will be optional, showing '(Optional)'
+   * next to the label and adding a default first option with an empty string as value, 
+   * been the placeholder (if defined) its label. Otherwise, the field will be
+   * considered required and an error will be passed as a parameter to the
+   * OnBlur and onChange functions if an option wasn't selected.
+   */
+  optional?: boolean;
+  /**
+   * If true, enables search functionality.
+   */
+  searchable?: boolean;
+  /**
+   * If true, the select component will support multiple selected options.
+   * In that case, value will be an array of strings with each selected
+   * option value.
+   */
+  multiple?: boolean;
+  /**
+   * This function will be called when the user selects an option.
+   * 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?: (value: string | string[]) => void;
+  /**
+   * This function will be called when the select loses the focus. An
+   * object including the value (or values) and the error (if the value
+   * selected is not valid) will be passed to this function. If there is no error,
+   * error will be null.
+   */
+  onBlur?: (val: { value: string | string[]; error: string }) => void;
+  /**
+   * If it is defined, the component will change its appearance, showing
+   * the error below the select component. If it is not defined, the error
+   * messages will be managed internally, but never displayed on its own.
+   */
+  error?: 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?: "small" | "medium" | "large" | "fillParent";
+  /**
+   * Value of the tabindex attribute.
+   */
+  tabIndex?: number;
+  /**
+   * Reference to the component.
+   */
+  ref?: React.RefObject<HTMLDivElement>;
+};
+
+export default function DxcSelect(props: Props): JSX.Element;

package/{dist/sidenav → sidenav}/Sidenav.js

@@ -1,9 +1,9 @@
 "use strict";
 
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
-
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
+var _typeof = require("@babel/runtime/helpers/typeof");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -25,80 +25,46 @@ var _useTheme = _interopRequireDefault(require("../useTheme.js"));
 
 var _BackgroundColorContext = require("../BackgroundColorContext.js");
 
-function _templateObject4() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  color: ", ";\n  letter-spacing: ", ";\n  text-transform: ", ";\n  text-decoration: ", ";\n  margin: ", ";\n  cursor: pointer;\n\n  :focus-visible {\n    outline: 2px solid ", ";\n    outline-offset: 1px;\n  }\n"]);
-
-  _templateObject4 = function _templateObject4() {
-    return data;
-  };
-
-  return data;
-}
-
-function _templateObject3() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  color: ", ";\n  letter-spacing: ", ";\n  text-transform: ", ";\n  margin-bottom: 4px;\n"]);
-
-  _templateObject3 = function _templateObject3() {
-    return data;
-  };
-
-  return data;
-}
-
-function _templateObject2() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  color: ", ";\n  letter-spacing: ", ";\n  text-transform: ", ";\n  margin-bottom: 16px;\n"]);
-
-  _templateObject2 = function _templateObject2() {
-    return data;
-  };
-
-  return data;
-}
-
-function _templateObject() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-direction: column;\n  background-color: ", ";\n  max-width: 300px;\n  width: ", ";\n  padding: ", ";\n\n  overflow-y: auto;\n  overflow-x: hidden;\n  ::-webkit-scrollbar {\n    width: 2px;\n  }\n  ::-webkit-scrollbar-track {\n    background-color: ", ";\n    border-radius: 3px;\n  }\n  ::-webkit-scrollbar-thumb {\n    background-color: ", ";\n    border-radius: 3px;\n  }\n"]);
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
 
-  _templateObject = function _templateObject() {
-    return data;
-  };
+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); }
 
-  return data;
-}
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(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 DxcSidenav = function DxcSidenav(_ref) {
   var padding = _ref.padding,
       children = _ref.children;
   var colorsTheme = (0, _useTheme["default"])();
-  return _react["default"].createElement(_styledComponents.ThemeProvider, {
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
     theme: colorsTheme.sidenav
-  }, _react["default"].createElement(SideNavContainer, {
+  }, /*#__PURE__*/_react["default"].createElement(SideNavContainer, {
     padding: padding
-  }, _react["default"].createElement(_BackgroundColorContext.BackgroundColorProvider, {
+  }, /*#__PURE__*/_react["default"].createElement(_BackgroundColorContext.BackgroundColorProvider, {
     color: colorsTheme.sidenav.backgroundColor
   }, children)));
 };
 
 var Title = function Title(_ref2) {
   var children = _ref2.children;
-  return _react["default"].createElement(SideNavMenuTitle, null, children);
+  return /*#__PURE__*/_react["default"].createElement(SideNavMenuTitle, null, children);
 };
 
 var Subtitle = function Subtitle(_ref3) {
   var children = _ref3.children;
-  return _react["default"].createElement(SideNavMenuSubTitle, null, children);
+  return /*#__PURE__*/_react["default"].createElement(SideNavMenuSubTitle, null, children);
 };
 
 var Link = function Link(_ref4) {
   var href = _ref4.href,
       onClick = _ref4.onClick,
       children = _ref4.children;
-  return _react["default"].createElement(SideNavMenuLink, {
+  return /*#__PURE__*/_react["default"].createElement(SideNavMenuLink, {
     href: href,
     onClick: onClick
   }, children);
 };
 
-var SideNavContainer = _styledComponents["default"].div(_templateObject(), function (props) {
+var SideNavContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-direction: column;\n  background-color: ", ";\n  max-width: 300px;\n  width: ", ";\n  padding: ", ";\n\n  overflow-y: auto;\n  overflow-x: hidden;\n  ::-webkit-scrollbar {\n    width: 2px;\n  }\n  ::-webkit-scrollbar-track {\n    background-color: ", ";\n    border-radius: 3px;\n  }\n  ::-webkit-scrollbar-thumb {\n    background-color: ", ";\n    border-radius: 3px;\n  }\n"])), function (props) {
   return props.theme.backgroundColor;
 }, function (props) {
   return props.padding ? "calc(300px - ".concat(_variables.spaces[props.padding], " - ").concat(_variables.spaces[props.padding], ")") : "300px";
@@ -110,7 +76,7 @@ var SideNavContainer = _styledComponents["default"].div(_templateObject(), funct
   return props.theme.scrollBarThumbColor;
 });
 
-var SideNavMenuTitle = _styledComponents["default"].div(_templateObject2(), function (props) {
+var SideNavMenuTitle = _styledComponents["default"].div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  color: ", ";\n  letter-spacing: ", ";\n  text-transform: ", ";\n  margin-bottom: 16px;\n"])), function (props) {
   return props.theme.titleFontFamily;
 }, function (props) {
   return props.theme.titleFontSize;
@@ -126,7 +92,7 @@ var SideNavMenuTitle = _styledComponents["default"].div(_templateObject2(), func
   return props.theme.titleFontTextTransform;
 });
 
-var SideNavMenuSubTitle = _styledComponents["default"].div(_templateObject3(), function (props) {
+var SideNavMenuSubTitle = _styledComponents["default"].div(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  color: ", ";\n  letter-spacing: ", ";\n  text-transform: ", ";\n  margin-bottom: 4px;\n"])), function (props) {
   return props.theme.subtitleFontFamily;
 }, function (props) {
   return props.theme.subtitleFontSize;
@@ -142,7 +108,7 @@ var SideNavMenuSubTitle = _styledComponents["default"].div(_templateObject3(), f
   return props.theme.subtitleFontTextTransform;
 });
 
-var SideNavMenuLink = _styledComponents["default"].a(_templateObject4(), function (props) {
+var SideNavMenuLink = _styledComponents["default"].a(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  color: ", ";\n  letter-spacing: ", ";\n  text-transform: ", ";\n  text-decoration: ", ";\n  margin: ", ";\n  cursor: pointer;\n\n  :focus-visible {\n    outline: 2px solid ", ";\n    outline-offset: 1px;\n  }\n"])), function (props) {
   return props.theme.linkFontFamily;
 }, function (props) {
   return props.theme.linkFontSize;

package/sidenav/index.d.ts

@@ -0,0 +1,13 @@
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Padding = {
+  top?: Space;
+  bottom?: Space;
+  left?: Space;
+  right?: Space;
+};
+
+type Props = {
+  padding?: Space | Padding;
+};
+
+export default function DxcSidenav(props: Props): JSX.Element;

package/slider/Slider.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import SliderPropsType from "./types";
+declare const DxcSlider: ({ label, name, value, helperText, minValue, maxValue, step, showLimitsValues, showInput, disabled, marks, onChange, onDragEnd, labelFormatCallback, margin, size, }: SliderPropsType) => JSX.Element;
+export default DxcSlider;