@dxc-technology/halstack-react 0.0.0-d20b360 → 0.0.0-d238e47

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-d20b360",
+  "version": "0.0.0-d238e47",
   "description": "DXC Halstack React components library",
   "repository": "dxc-technology/halstack-react",
   "homepage": "http://developer.dxc.com/tools/react",

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,105 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type RequiredMinLength = {
+    min: number;
+    max?: number;
+};
+declare type RequiredMaxLength = {
+    min?: number;
+    max: number;
+};
+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?: RequiredMinLength | RequiredMaxLength;
+    /**
+     * 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.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>
+);

package/radio/types.d.ts

@@ -42,8 +42,8 @@ declare type Props = {
      */
     onClick?: (val: boolean) => void;
     /**
-     * Size of the margin to be applied to the component. You can pass an object with 'top',
-     * 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
+     * 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;
     /**

package/resultsetTable/ResultsetTable.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import ResultsetTablePropsType from "./types";
+declare const DxcResultsetTable: ({ columns, rows, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, margin, tabIndex, }: ResultsetTablePropsType) => JSX.Element;
+export default DxcResultsetTable;

package/resultsetTable/ResultsetTable.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"));
@@ -21,8 +19,6 @@ var _react = _interopRequireWildcard(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _variables = require("../common/variables.js");
 
 var _Table = _interopRequireDefault(require("../table/Table"));
@@ -249,26 +245,5 @@ var DxcResultsetTableContainer = _styledComponents["default"].div(_templateObjec
   return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.left ? _variables.spaces[props.margin.left] : "";
 });
 
-DxcResultsetTable.propTypes = {
-  rows: _propTypes["default"].array,
-  columns: _propTypes["default"].array,
-  itemsPerPage: _propTypes["default"].number,
-  itemsPerPageOptions: _propTypes["default"].arrayOf(_propTypes["default"].number),
-  itemsPerPageFunction: _propTypes["default"].func,
-  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)))]),
-  tabIndex: _propTypes["default"].number
-};
-DxcResultsetTable.defaultProps = {
-  rows: [],
-  columns: [],
-  itemsPerPage: 5,
-  itemsPerPageOptions: null,
-  itemsPerPageFunction: null
-};
 var _default = DxcResultsetTable;
 exports["default"] = _default;

package/resultsetTable/types.d.ts

@@ -0,0 +1,63 @@
+/// <reference types="react" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Column = {
+    /**
+     * Column display value.
+     */
+    displayValue: React.ReactNode;
+    /**
+     * Boolean value to indicate whether the column is sortable or not.
+     */
+    isSortable?: boolean;
+};
+declare type Row = {
+    /**
+     * Value to be displayed in the cell.
+     */
+    displayValue: React.ReactNode;
+    /**
+     * Value to be used when sorting the table by that
+     * column. If not indicated displayValue will be used for sorting.
+     */
+    sortValue?: string;
+};
+declare type Props = {
+    /**
+     * An array of objects representing the columns of the table.
+     */
+    columns: [Column, ...Column[]];
+    /**
+     * An array of objects representing the rows of the table, you will have
+     * as many objects as columns in the table.
+     */
+    rows: [Row, ...Row[]];
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * An array of numbers representing the items per page options.
+     */
+    itemsPerPageOptions?: number[];
+    /**
+     * This function will be called when the user selects an item per page
+     * option. The value selected will be passed as a parameter.
+     */
+    itemsPerPageFunction?: (newValue: number) => void;
+    /**
+     * Size of the margin to be applied to the component. You can pass an object with 'top',
+     * 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
+     */
+    margin?: Space | Margin;
+    /**
+     * Value of the tabindex attribute given to the sortable icon.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/resultsetTable/types.js

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