@dxc-technology/halstack-react 0.0.0-8d998c7 → 0.0.0-9005464

package/number-input/NumberInput.stories.tsx

@@ -0,0 +1,115 @@
+import React from "react";
+import { BackgroundColorProvider } from "../BackgroundColorContext";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DarkContainer from "../../.storybook/components/DarkSection";
+import DxcNumberInput from "./NumberInput";
+
+export default {
+  title: "Number input ",
+  component: DxcNumberInput,
+};
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Without label" theme="light" level={4} />
+      <DxcNumberInput />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With label and placeholder" theme="light" level={4} />
+      <DxcNumberInput label="Number input" placeholder="Placeholder" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Helper text, optional and value" theme="light" level={4} />
+      <DxcNumberInput label="Number input" value="12" helperText="Help message" optional />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled and placeholder" theme="light" level={4} />
+      <DxcNumberInput label="Disabled number input" disabled placeholder="Placeholder" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled, helper text, optional and value" theme="light" level={4} />
+      <DxcNumberInput label="Disabled number input" helperText="Help message" disabled optional value="10" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Prefix" theme="light" level={4} />
+      <DxcNumberInput label="With prefix" prefix="+34" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Suffix" theme="light" level={4} />
+      <DxcNumberInput label="With suffix" suffix="USD" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Invalid" theme="light" level={4} />
+      <DxcNumberInput label="Error number input" helperText="Help message" error="Error message." value="23" optional />
+    </ExampleContainer>
+    <BackgroundColorProvider color="#333333">
+      <DarkContainer>
+        <Title title="Dark" theme="dark" level={2} />
+        <ExampleContainer>
+          <Title title="Helper text, placeholder and optional" theme="dark" level={4} />
+          <DxcNumberInput label="Number input" helperText="Help message" placeholder="Placeholder" optional />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Helper text, value and error" theme="dark" level={4} />
+          <DxcNumberInput label="Number input" helperText="Help message" error="Error message." value="199" />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled and placeholder" theme="dark" level={4} />
+          <DxcNumberInput label="Disabled number input" disabled placeholder="Placeholder" />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled, helper text, optional and value" theme="dark" level={4} />
+          <DxcNumberInput label="Disabled number input" helperText="Help message" disabled optional value="1232454" />
+        </ExampleContainer>
+      </DarkContainer>
+    </BackgroundColorProvider>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcNumberInput label="Xxsmall" margin="xxsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcNumberInput label="Xsmall" margin="xsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcNumberInput label="Small" margin="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcNumberInput label="Medium" margin="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcNumberInput label="Large" margin="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcNumberInput label="Xlarge" margin="xlarge" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcNumberInput label="Xxlarge" margin="xxlarge" />
+    </ExampleContainer>
+    <Title title="Sizes" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Small size" theme="light" level={4} />
+      <DxcNumberInput label="Small" size="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium size" theme="light" level={4} />
+      <DxcNumberInput label="Medium" size="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large size" theme="light" level={4} />
+      <DxcNumberInput label="Large" size="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="FillParent size" theme="light" level={4} />
+      <DxcNumberInput label="FillParent" size="fillParent" />
+    </ExampleContainer>
+  </>
+);

package/number-input/types.d.ts

@@ -0,0 +1,117 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * Text to be placed above the number.
+     */
+    label?: string;
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * Value of the input element. 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 number.
+     */
+    helperText?: string;
+    /**
+     * Text to be put as placeholder of the number.
+     */
+    placeholder?: string;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * If true, the number 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 number value.
+     */
+    prefix?: string;
+    /**
+     * Suffix to be placed after the number value.
+     */
+    suffix?: string;
+    /**
+     * Minimum value allowed by the number input. If the typed value by the user is
+     * lower than min, the onBlur and onChange functions will be called with
+     * the current value and an internal error informing that the current
+     * value is not correct. If a valid state is reached, the error parameter
+     * will be null in both events.
+     */
+    min?: number;
+    /**
+     * Maximum value allowed by the number input. If the typed value by the user
+     * surpasses max, the onBlur and onChange functions will be called with
+     * the current value and an internal error informing that the current
+     * value is not correct. If a valid state is reached, the error parameter
+     * will be null in both events.
+     */
+    max?: number;
+    /**
+     * The step interval to use when using the up and down arrows to adjust the value.
+     */
+    step?: number;
+    /**
+     * 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 | null;
+    }) => 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?: (val: {
+        value: string;
+        error: string | null;
+    }) => 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;
+    /**
+     * 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?: "small" | "medium" | "large" | "fillParent";
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+/**
+ * Reference to the component.
+ */
+export declare type RefType = HTMLDivElement;
+export default Props;

package/number-input/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxc-technology/halstack-react",
-  "version": "0.0.0-8d998c7",
+  "version": "0.0.0-9005464",
   "description": "DXC Halstack React components library",
   "repository": "dxc-technology/halstack-react",
   "homepage": "http://developer.dxc.com/tools/react",

package/paginator/Paginator.stories.tsx

@@ -0,0 +1,63 @@
+import React from "react";
+import DxcPaginator from "./Paginator";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+
+export default {
+  title: "Paginator",
+  component: DxcPaginator,
+};
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Default" theme="light" level={4} />
+      <DxcPaginator />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Default with items per page options" theme="light" level={4} />
+      <DxcPaginator itemsPerPageOptions={[5, 10, 15]} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Default with show go to page selector" theme="light" level={4} />
+      <DxcPaginator showGoToPage />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change in first page" theme="light" level={4} />
+      <DxcPaginator currentPage={1} itemsPerPage={10} totalItems={27} onPageChange={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change in middle page" theme="light" level={4} />
+      <DxcPaginator currentPage={2} itemsPerPage={10} totalItems={27} onPageChange={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change in last page" theme="light" level={4} />
+      <DxcPaginator currentPage={3} itemsPerPage={10} totalItems={27} onPageChange={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change and items per page options" theme="light" level={4} />
+      <DxcPaginator
+        currentPage={1}
+        itemsPerPage={10}
+        totalItems={27}
+        onPageChange={() => {}}
+        itemsPerPageOptions={[5, 10, 15]}
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change and show go to page selector" theme="light" level={4} />
+      <DxcPaginator currentPage={1} itemsPerPage={10} totalItems={27} onPageChange={() => {}} showGoToPage />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change, show go to page and items per page selectors" theme="light" level={4} />
+      <DxcPaginator
+        currentPage={1}
+        itemsPerPage={10}
+        totalItems={27}
+        onPageChange={() => {}}
+        itemsPerPageOptions={[5, 10, 15]}
+        showGoToPage
+      />
+    </ExampleContainer>
+  </>
+);

package/password-input/PasswordInput.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import PasswordInputPropsType from "./types";
+declare const DxcPasswordInput: React.ForwardRefExoticComponent<PasswordInputPropsType & React.RefAttributes<HTMLDivElement>>;
+export default DxcPasswordInput;

package/password-input/PasswordInput.js

@@ -9,8 +9,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
 
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
@@ -19,12 +17,8 @@ var _react = _interopRequireWildcard(require("react"));
 
 var _styledComponents = _interopRequireDefault(require("styled-components"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _TextInput = _interopRequireDefault(require("../text-input/TextInput"));
 
-var _variables = require("../common/variables.js");
-
 var _templateObject;
 
 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); }
@@ -162,38 +156,7 @@ var DxcPasswordInput = /*#__PURE__*/_react["default"].forwardRef(function (_ref,
   }));
 });
 
-var sizes = {
-  small: "240px",
-  medium: "360px",
-  large: "480px",
-  fillParent: "100%"
-};
-
 var PasswordInput = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  & ::-ms-reveal {\n    display: none;\n  }\n"])));
 
-DxcPasswordInput.propTypes = {
-  label: _propTypes["default"].string,
-  name: _propTypes["default"].string,
-  value: _propTypes["default"].string,
-  helperText: _propTypes["default"].string,
-  error: _propTypes["default"].string,
-  clearable: _propTypes["default"].bool,
-  onChange: _propTypes["default"].func,
-  onBlur: _propTypes["default"].func,
-  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))),
-  pattern: _propTypes["default"].string,
-  length: _propTypes["default"].shape({
-    min: _propTypes["default"].number,
-    max: _propTypes["default"].number
-  }),
-  tabIndex: _propTypes["default"].number
-};
 var _default = DxcPasswordInput;
 exports["default"] = _default;

package/password-input/{PasswordInput.stories.jsx → PasswordInput.stories.tsx}

@@ -7,7 +7,7 @@ import ExampleContainer from "../../.storybook/components/ExampleContainer";
 import DarkContainer from "../../.storybook/components/DarkSection";
 
 export default {
-  title: "Password input ",
+  title: "Password input",
   component: DxcPasswordInput,
 };
 

package/password-input/types.d.ts

@@ -0,0 +1,100 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * Text to be placed above the password.
+     */
+    label?: string;
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * Value of the input element. 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 password.
+     */
+    helperText?: string;
+    /**
+     * If true, the password input will have an action to clear the entered value.
+     */
+    clearable?: boolean;
+    /**
+     * 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 | null;
+    }) => 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?: (val: {
+        value: string;
+        error: string | null;
+    }) => void;
+    /**
+     * If it is defined, the component will change its appearance, showing
+     * the error below the password input component. 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
+     * password 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 password 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?: "small" | "medium" | "large" | "fillParent";
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+/**
+ * Reference to the component.
+ */
+export declare type RefType = HTMLDivElement;
+export default Props;

package/password-input/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/progress-bar/ProgressBar.js

@@ -157,7 +157,7 @@ var ProgressBarProgress = _styledComponents["default"].div(_templateObject5 || (
 var HelperText = _styledComponents["default"].span(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: 1.5em;\n"])), function (props) {
   return props.backgroundType === "dark" ? props.theme.helperTextFontColorOnDark : props.overlay === true ? "#FFFFFF" : props.theme.helperTextFontColor;
 }, function (props) {
-  return props.theme.fontFamily;
+  return props.theme.helperTextFontFamily;
 }, function (props) {
   return props.theme.helperTextFontSize;
 }, function (props) {

package/progress-bar/ProgressBar.stories.jsx

@@ -0,0 +1,58 @@
+import React from "react";
+import DxcProgressBar from "./ProgressBar";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+
+export default {
+  title: "ProgressBar",
+  component: DxcProgressBar,
+};
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Without labels" theme="light" level={4} />
+      <DxcProgressBar overlay={false} value={50} showValue />
+      <Title title="With helperText" theme="light" level={4} />
+      <DxcProgressBar helperText="Helper text" value={50} overlay={false} showValue />
+      <Title title="Without default value" theme="light" level={4} />
+      <DxcProgressBar label="Loading..." overlay={false} showValue />
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin xxsmall" margin="xxsmall" overlay={false} value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin xsmall" margin="xsmall" overlay={false} value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin small" margin="small" overlay={false} value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin medium" margin="medium" overlay={false} value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin large" margin="large" overlay={false} value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin xlarge" margin="xlarge" overlay={false} value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="XxLarge margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin xxlarge" margin="xxlarge" overlay={false} value={50} showValue />
+    </ExampleContainer>
+  </>
+);
+
+export const ProgressBarOverlay = () => (
+  <ExampleContainer>
+    <Title title="Overlay" theme="dark" level={4} />
+    <DxcProgressBar label="Overlay" helperText="Helper text" showValue value={50} />
+  </ExampleContainer>
+);