@dxc-technology/halstack-react 3.2.0 → 4.0.0

package/select/index.d.ts

@@ -0,0 +1,131 @@
+type SVG = string | (HTMLElement & SVGElement);
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
+  top?: Space;
+  bottom?: Space;
+  left?: Space;
+  right?: Space;
+};
+
+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?: 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 empty 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

@@ -23,8 +23,10 @@ var _variables = require("../common/variables.js");
 
 var _useTheme = _interopRequireDefault(require("../useTheme.js"));
 
+var _BackgroundColorContext = require("../BackgroundColorContext.js");
+
 function _templateObject4() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  text-decoration: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  letter-spacing: ", ";\n  color: #00000099;\n  margin: 6px 18px;\n  cursor: pointer;\n"]);
+  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;
@@ -34,7 +36,7 @@ function _templateObject4() {
 }
 
 function _templateObject3() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  letter-spacing: ", ";\n  color: #00000099;\n  text-transform: ", ";\n  margin-top: 15px;\n"]);
+  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;
@@ -44,7 +46,7 @@ function _templateObject3() {
 }
 
 function _templateObject2() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  letter-spacing: ", ";\n  color: #000000de;\n  margin: 15px 0;\n"]);
+  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;
@@ -54,7 +56,7 @@ function _templateObject2() {
 }
 
 function _templateObject() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  font-size: ", ";\n  background-color: ", ";\n  max-width: 300px;\n  font-family: ", ";\n  width: ", ";\n  padding: ", ";\n  overflow-y: auto;\n  overflow-x: hidden;\n  ::-webkit-scrollbar {\n    width: 2px;\n  }\n\n  ::-webkit-scrollbar-track {\n    border-radius: 3px;\n  }\n\n  ::-webkit-scrollbar-thumb {\n    background-color: #66666626;\n    border-radius: 3px;\n  }\n\n  display: flex;\n  flex-direction: column;\n"]);
+  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"]);
 
   _templateObject = function _templateObject() {
     return data;
@@ -71,7 +73,9 @@ var DxcSidenav = function DxcSidenav(_ref) {
     theme: colorsTheme.sidenav
   }, _react["default"].createElement(SideNavContainer, {
     padding: padding
-  }, children));
+  }, _react["default"].createElement(_BackgroundColorContext.BackgroundColorProvider, {
+    color: colorsTheme.sidenav.backgroundColor
+  }, children)));
 };
 
 var Title = function Title(_ref2) {
@@ -95,49 +99,69 @@ var Link = function Link(_ref4) {
 };
 
 var SideNavContainer = _styledComponents["default"].div(_templateObject(), function (props) {
-  return props.theme.fontSizeBase;
-}, function (props) {
   return props.theme.backgroundColor;
-}, function (props) {
-  return props.theme.fontFamily;
 }, function (props) {
   return props.padding ? "calc(300px - ".concat(_variables.spaces[props.padding], " - ").concat(_variables.spaces[props.padding], ")") : "300px";
 }, function (props) {
   return props.padding ? _variables.spaces[props.padding] : "";
+}, function (props) {
+  return props.theme.scrollBarTrackColor;
+}, function (props) {
+  return props.theme.scrollBarThumbColor;
 });
 
 var SideNavMenuTitle = _styledComponents["default"].div(_templateObject2(), function (props) {
-  return props.theme.fontFamily;
+  return props.theme.titleFontFamily;
+}, function (props) {
+  return props.theme.titleFontSize;
+}, function (props) {
+  return props.theme.titleFontStyle;
+}, function (props) {
+  return props.theme.titleFontWeight;
 }, function (props) {
-  return props.theme.fontSize24;
+  return props.theme.titleFontColor;
 }, function (props) {
-  return props.theme.fontStyle;
+  return props.theme.titleFontLetterSpacing;
 }, function (props) {
-  return props.theme.fontLetterSpacingTitle;
+  return props.theme.titleFontTextTransform;
 });
 
 var SideNavMenuSubTitle = _styledComponents["default"].div(_templateObject3(), function (props) {
-  return props.theme.fontFamily;
+  return props.theme.subtitleFontFamily;
 }, function (props) {
-  return props.theme.fontSize12;
+  return props.theme.subtitleFontSize;
 }, function (props) {
-  return props.theme.fontStyle;
+  return props.theme.subtitleFontStyle;
 }, function (props) {
-  return props.theme.fontLetterSpacingSubtitle;
+  return props.theme.subtitleFontWeight;
 }, function (props) {
-  return props.theme.fontTextTransform;
+  return props.theme.subtitleFontColor;
+}, function (props) {
+  return props.theme.subtitleFontLetterSpacing;
+}, function (props) {
+  return props.theme.subtitleFontTextTransform;
 });
 
 var SideNavMenuLink = _styledComponents["default"].a(_templateObject4(), function (props) {
-  return props.theme.textDecoration;
+  return props.theme.linkFontFamily;
+}, function (props) {
+  return props.theme.linkFontSize;
+}, function (props) {
+  return props.theme.linkFontStyle;
+}, function (props) {
+  return props.theme.linkFontWeight;
+}, function (props) {
+  return props.theme.linkFontColor;
+}, function (props) {
+  return props.theme.linkFontLetterSpacing;
 }, function (props) {
-  return props.theme.fontFamily;
+  return props.theme.linkFontTextTransform;
 }, function (props) {
-  return props.theme.fontSize14;
+  return props.theme.linkTextDecoration;
 }, function (props) {
-  return props.theme.fontStyle;
+  return "".concat(props.theme.linkMarginTop, " ").concat(props.theme.linkMarginRight, " ").concat(props.theme.linkMarginBottom, " ").concat(props.theme.linkMarginLeft);
 }, function (props) {
-  return props.theme.fontLetterSpacingLink;
+  return props.theme.linkFocusColor;
 });
 
 DxcSidenav.propTypes = {

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;