@dxc-technology/halstack-react 0.0.0-fb2efcc → 0.0.0-fb9047c

package/checkbox/Checkbox.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import CheckboxPropsType from "./types";
+declare const DxcCheckbox: ({ checked, value, label, labelPosition, name, disabled, onChange, required, margin, size, tabIndex, }: CheckboxPropsType) => JSX.Element;
+export default DxcCheckbox;

package/checkbox/Checkbox.js

@@ -9,8 +9,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
@@ -23,8 +21,6 @@ var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
 var _Checkbox = _interopRequireDefault(require("@material-ui/core/Checkbox"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _RequiredComponent = _interopRequireDefault(require("../common/RequiredComponent"));
 
 var _variables = require("../common/variables.js");
@@ -253,23 +249,5 @@ var CheckboxBlackBack = _styledComponents["default"].span(_templateObject3 || (_
   return props.labelPosition === "before" ? "0px" : "";
 });
 
-DxcCheckbox.propTypes = {
-  checked: _propTypes["default"].bool,
-  value: _propTypes["default"].any,
-  label: _propTypes["default"].string,
-  labelPosition: _propTypes["default"].oneOf(["after", "before", ""]),
-  name: _propTypes["default"].string,
-  disabled: _propTypes["default"].bool,
-  onChange: _propTypes["default"].func,
-  required: _propTypes["default"].bool,
-  size: _propTypes["default"].oneOf((0, _toConsumableArray2["default"])(Object.keys(sizes))),
-  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
-};
 var _default = DxcCheckbox;
 exports["default"] = _default;

package/checkbox/types.d.ts

@@ -0,0 +1,61 @@
+declare type Size = "small" | "medium" | "large" | "fillParent" | "fitContent";
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * If true, the component is checked. If undefined the component will be
+     * uncontrolled and the value will be managed internally by the component.
+     */
+    checked?: boolean;
+    /**
+     * Will be passed to the value attribute of the html input element.
+     * When inside a form, this value will be only submitted if the checkbox is checked.
+     */
+    value?: string;
+    /**
+     * Text to be placed next to the checkbox.
+     */
+    label?: string;
+    /**
+     * Whether the label should appear after or before the checkbox.
+     */
+    labelPosition?: "before" | "after";
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * If true, the checkbox will change its appearence, showing that the value is required.
+     */
+    required?: boolean;
+    /**
+     * This function will be called when the user clicks the checkbox.
+     * The new value will be passed as a parameter.
+     */
+    onChange?: (val: boolean) => void;
+    /**
+     * 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' | 'fitContent').
+     */
+    size?: Size;
+    /**
+     * Value of the tabindex.
+     */
+    tabIndex?: number;
+};
+export default Props;

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

package/paginator/Paginator.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import PaginatorPropsType from "./types";
+declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: PaginatorPropsType) => JSX.Element;
+export default DxcPaginator;

package/paginator/Paginator.js

@@ -11,14 +11,10 @@ exports["default"] = void 0;
 
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
 
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _react = _interopRequireDefault(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _useTheme = _interopRequireDefault(require("../useTheme.js"));
 
 var _Button = _interopRequireDefault(require("../button/Button"));
@@ -102,7 +98,7 @@ var DxcPaginator = function DxcPaginator(_ref) {
       onPageChange(currentPage - 1);
     }
   }), showGoToPage && /*#__PURE__*/_react["default"].createElement(PageToSelectContainer, null, /*#__PURE__*/_react["default"].createElement(GoToLabel, null, "Go to page: "), /*#__PURE__*/_react["default"].createElement(SelectContainer, null, /*#__PURE__*/_react["default"].createElement(_Select["default"], {
-    options: (0, _toConsumableArray2["default"])(Array(totalPages).keys()).map(function (num) {
+    options: Array.from(Array(totalPages), function (e, num) {
       return {
         label: (num + 1).toString(),
         value: (num + 1).toString()
@@ -198,24 +194,5 @@ var PageToSelectContainer = _styledComponents["default"].span(_templateObject8 |
 
 var TextContainer = _styledComponents["default"].span(_templateObject9 || (_templateObject9 = (0, _taggedTemplateLiteral2["default"])([""])));
 
-DxcPaginator.propTypes = {
-  currentPage: _propTypes["default"].number,
-  itemsPerPage: _propTypes["default"].number,
-  itemsPerPageOptions: _propTypes["default"].arrayOf(_propTypes["default"].number),
-  totalItems: _propTypes["default"].number.isRequired,
-  showGoToPage: _propTypes["default"].bool,
-  onPageChange: _propTypes["default"].func,
-  itemsPerPageFunction: _propTypes["default"].func,
-  tabIndex: _propTypes["default"].number
-};
-DxcPaginator.defaultProps = {
-  currentPage: 1,
-  itemsPerPage: 5,
-  itemsPerPageOptions: null,
-  showGoToPage: false,
-  onPageChange: null,
-  itemsPerPageFunction: null,
-  tabIndex: 0
-};
 var _default = DxcPaginator;
 exports["default"] = _default;

package/paginator/types.d.ts

@@ -0,0 +1,38 @@
+declare type Props = {
+    /**
+     * Number of the current selected page.
+     */
+    currentPage?: number;
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * Array of numbers representing the items per page options.
+     * If undefined, the select with items per page options will not be displayed.
+     */
+    itemsPerPageOptions?: number[];
+    /**
+     * This function will be called when the user selects an item per page option.
+     * The number will be passed as a parameter to this function.
+     */
+    itemsPerPageFunction?: (val: number) => void;
+    /**
+     * Total number of items in the pages.
+     */
+    totalItems?: number;
+    /**
+     * If true, a select will be displayed with the page numbers to move through them.
+     */
+    showGoToPage?: boolean;
+    /**
+     * This function will be called when the user clicks on any of the button to change pages.
+     * The page number will be passed as a parameter to this function.
+     */
+    onPageChange?: (val: number) => void;
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/paginator/types.js

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

package/checkbox/index.d.ts

@@ -1,24 +0,0 @@
-type Size = "small" | "medium" | "large" | "fillParent" | "fitContent";
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  checked?: boolean;
-  value?: any;
-  label?: string;
-  labelPosition?: "before" | "after";
-  name?: string,
-  disabled?: boolean;
-  onChange?: void;
-  required?: boolean;
-  margin?: Space | Margin;
-  size?: Size;
-  tabIndex?: number;
-};
-
-export default function DxcCheckbox(props: Props): JSX.Element;

package/paginator/index.d.ts

@@ -1,20 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  currentPage?: number;
-  itemsPerPage?: number;
-  itemsPerPageOptions?: number[];
-  totalItems?: number
-  showGoToPage?: boolean,
-  onPageChange?: void;
-  itemsPerPageFunction?: void;
-  tabIndex?: number;
-};
-
-export default function DxcPaginator(props: Props): JSX.Element;