@dxc-technology/halstack-react 0.0.0-2d619b4 → 0.0.0-2edb175

package/{dist/number → number-input}/index.d.ts

@@ -32,7 +32,10 @@ type Props = {
    */
   disabled?: boolean;
   /**
-   * If true, the number will be optional, showing (Optional) next to the label.
+   * 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;
   /**
@@ -44,11 +47,19 @@ type Props = {
    */
   suffix?: string;
   /**
-   * Minimum value allowed by the number.
+   * 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.
+   * 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;
   /**
@@ -56,16 +67,23 @@ type Props = {
    */
   step?: number;
   /**
-   * This function will be called when the user types within the input element of the component. The new value will be passed as a parameter.
+   * 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?: (value: string) => void;
+  onChange?: (val: { value: string; error: string }) => void;
   /**
-   * This function will be called when the input element loses the focus. An object including the 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.
+   * 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 }) => void;
   /**
-   * If it is defined, the component will change its appearance, showing the error below the number component. If it is not defined, the error messages will be created and managed internally.
+   * 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;
   /**
@@ -92,4 +110,4 @@ type Props = {
    ref?: React.RefObject<HTMLDivElement>;
 };
 
-export default function DxcNumber(props: Props): JSX.Element;
+export default function DxcNumberInput(props: Props): JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxc-technology/halstack-react",
-  "version": "0.0.0-2d619b4",
+  "version": "0.0.0-2edb175",
   "description": "DXC Halstack React components library",
   "repository": "dxc-technology/halstack-react",
   "homepage": "http://developer.dxc.com/tools/react",
@@ -10,12 +10,12 @@
     "email": "DigitalInsurance@dxc.com",
     "url": "https://dxc.com"
   },
-  "main": "./dist/main.js",
-  "types": "./dist/main.d.ts",
+  "main": "./main.js",
+  "types": "./main.d.ts",
   "peerDependencies": {
-    "react": "^16.8.6",
-    "react-dom": "^16.8.6",
-    "styled-components": ">= 4.3.1"
+    "react": "^17.0.1",
+    "react-dom": "^17.0.1",
+    "styled-components": "^5.0.1"
   },
   "dependencies": {
     "@date-io/date-fns": "^1.3.9",
@@ -24,33 +24,40 @@
     "@material-ui/lab": "4.0.0-alpha.17",
     "@material-ui/pickers": "3.2.2",
     "@material-ui/styles": "4.0.2",
-    "@testing-library/user-event": "^12.6.3",
     "color": "^3.1.3",
     "date-fns": "^2.0.0-beta.4",
     "moment": "2.24.0",
     "prop-types": "^15.7.2",
-    "react-use-scrollspy": "^2.0.0",
     "rgb-hex": "^3.0.0",
     "uuid": "^8.3.2"
   },
   "scripts": {
     "test": "jest",
     "test:watch": "npm test -- --watch --coverage",
-    "build": "babel src --out-dir dist --copy-files --verbose && node ../scripts/build/copy-readme.js",
-    "build:watch": "babel src --watch --out-dir dist --copy-files --verbose"
+    "build": "babel src --extensions .js,.jsx,.ts,.tsx --out-dir ../dist --copy-files --verbose && node ../scripts/build/copy-package.js && tsc ",
+    "build:watch": "babel src --watch --out-dir ../dist --copy-files --verbose",
+    "storybook": "start-storybook -p 6006",
+    "build-storybook": "build-storybook"
   },
   "devDependencies": {
-    "@babel/cli": "^7.6.2",
-    "@babel/core": "^7.6.2",
-    "@babel/plugin-proposal-class-properties": "^7.5.5",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "7.13.8",
-    "@babel/plugin-proposal-optional-chaining": "7.13.8",
-    "@babel/plugin-transform-runtime": "^7.10.1",
-    "@babel/preset-env": "^7.6.2",
-    "@babel/preset-react": "^7.0.0",
+    "@babel/cli": "^7.16.8",
+    "@babel/core": "^7.16.7",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.13.8",
+    "@babel/plugin-proposal-optional-chaining": "^7.13.8",
+    "@babel/plugin-transform-runtime": "^7.16.8",
+    "@babel/preset-env": "^7.16.8",
+    "@babel/preset-react": "^7.16.7",
+    "@babel/preset-typescript": "^7.16.7",
+    "@storybook/addon-actions": "^6.4.9",
+    "@storybook/addon-essentials": "^6.4.9",
+    "@storybook/addon-links": "^6.4.9",
+    "@storybook/react": "^6.4.9",
     "@testing-library/react": "^11.2.5",
+    "@storybook/testing-library": "0.0.7",
+    "@testing-library/user-event": "^12.6.3",
     "babel-jest": "^24.8.0",
     "babel-loader": "^8.0.6",
+    "chromatic": "^6.3.3",
     "eslint": "^5.16.0",
     "eslint-config-airbnb": "^17.1.0",
     "eslint-config-prettier": "^6.7.0",
@@ -59,21 +66,21 @@
     "eslint-plugin-jsx-a11y": "^6.2.1",
     "eslint-plugin-react": "^7.13.0",
     "eslint-plugin-react-hooks": "^4.2.0",
+    "eslint-plugin-storybook": "^0.5.5",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^25.5.4",
-    "react": "file:../node_modules/react",
-    "react-dom": "file:../node_modules/react-dom",
+    "react": "^17.0.1",
+    "react-dom": "^17.0.1",
     "react-test-renderer": "^16.8.6",
-    "styled-components": "file:../node_modules/styled-components"
+    "storybook-addon-pseudo-states": "^1.0.0",
+    "styled-components": "^5.0.1",
+    "typescript": "^4.5.4"
   },
   "jest": {
     "moduleNameMapper": {
       "\\.(css|less|scss|sass)$": "identity-obj-proxy",
       "\\.(svg)$": "<rootDir>/test/mocks/svgMock.js",
       "\\.(png)$": "<rootDir>/test/mocks/pngMock.js"
-    },
-    "transformIgnorePatterns": [
-      "/node_modules/(?!react-use-scrollspy).+\\.js$"
-    ]
+    }
   }
 }

package/paginator/Icons.js

@@ -0,0 +1,66 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.previousIcon = exports.nextIcon = exports.lastIcon = exports.firstIcon = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var firstIcon = /*#__PURE__*/_react["default"].createElement("svg", {
+  xmlns: "http://www.w3.org/2000/svg",
+  width: "12.41",
+  height: "12",
+  viewBox: "0 0 12.41 12"
+}, /*#__PURE__*/_react["default"].createElement("path", {
+  id: "Path_2463",
+  "data-name": "Path 2463",
+  d: "M18.41,16.59,13.82,12l4.59-4.59L17,6l-6,6,6,6ZM6,6H8V18H6Z",
+  transform: "translate(-6 -6)"
+}));
+
+exports.firstIcon = firstIcon;
+
+var previousIcon = /*#__PURE__*/_react["default"].createElement("svg", {
+  xmlns: "http://www.w3.org/2000/svg",
+  width: "7.41",
+  height: "12",
+  viewBox: "0 0 7.41 12"
+}, /*#__PURE__*/_react["default"].createElement("path", {
+  id: "Path_2459",
+  "data-name": "Path 2459",
+  d: "M15.41,7.41,14,6,8,12l6,6,1.41-1.41L10.83,12Z",
+  transform: "translate(-8 -6)"
+}));
+
+exports.previousIcon = previousIcon;
+
+var nextIcon = /*#__PURE__*/_react["default"].createElement("svg", {
+  xmlns: "http://www.w3.org/2000/svg",
+  width: "7.41",
+  height: "12",
+  viewBox: "0 0 7.41 12"
+}, /*#__PURE__*/_react["default"].createElement("path", {
+  id: "Path_2461",
+  "data-name": "Path 2461",
+  d: "M10,6,8.59,7.41,13.17,12,8.59,16.59,10,18l6-6Z",
+  transform: "translate(-8.59 -6)"
+}));
+
+exports.nextIcon = nextIcon;
+
+var lastIcon = /*#__PURE__*/_react["default"].createElement("svg", {
+  xmlns: "http://www.w3.org/2000/svg",
+  width: "12.41",
+  height: "12",
+  viewBox: "0 0 12.41 12"
+}, /*#__PURE__*/_react["default"].createElement("path", {
+  id: "Path_2465",
+  "data-name": "Path 2465",
+  d: "M5.59,7.41,10.18,12,5.59,16.59,7,18l6-6L7,6ZM16,6h2V18H16Z",
+  transform: "translate(-5.59 -6)"
+}));
+
+exports.lastIcon = lastIcon;

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

@@ -0,0 +1,198 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+
+var _useTheme = _interopRequireDefault(require("../useTheme.js"));
+
+var _Button = _interopRequireDefault(require("../button/Button"));
+
+var _Select = _interopRequireDefault(require("../select/Select"));
+
+var _Icons = require("./Icons");
+
+var _BackgroundColorContext = require("../BackgroundColorContext.js");
+
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9;
+
+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); }
+
+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 DxcPaginator = function DxcPaginator(_ref) {
+  var _ref$currentPage = _ref.currentPage,
+      currentPage = _ref$currentPage === void 0 ? 1 : _ref$currentPage,
+      _ref$itemsPerPage = _ref.itemsPerPage,
+      itemsPerPage = _ref$itemsPerPage === void 0 ? 5 : _ref$itemsPerPage,
+      itemsPerPageOptions = _ref.itemsPerPageOptions,
+      _ref$totalItems = _ref.totalItems,
+      totalItems = _ref$totalItems === void 0 ? 1 : _ref$totalItems,
+      showGoToPage = _ref.showGoToPage,
+      onPageChange = _ref.onPageChange,
+      itemsPerPageFunction = _ref.itemsPerPageFunction,
+      _ref$tabIndex = _ref.tabIndex,
+      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
+  var totalPages = Math.ceil(totalItems / itemsPerPage);
+  var currentPageInternal = currentPage === -1 ? totalPages : currentPage;
+  var minItemsPerPage = currentPageInternal === 1 || currentPageInternal === 0 ? currentPageInternal : (currentPageInternal - 1) * itemsPerPage + 1;
+  var maxItemsPerPage = minItemsPerPage - 1 + itemsPerPage > totalItems ? totalItems : minItemsPerPage - 1 + itemsPerPage;
+  var colorsTheme = (0, _useTheme["default"])();
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.paginator
+  }, /*#__PURE__*/_react["default"].createElement(_BackgroundColorContext.BackgroundColorProvider, {
+    color: colorsTheme.paginator.backgroundColor
+  }, /*#__PURE__*/_react["default"].createElement(DxcPaginatorContainer, {
+    disabled: currentPageInternal === 1
+  }, /*#__PURE__*/_react["default"].createElement(LabelsContainer, null, itemsPerPageOptions && /*#__PURE__*/_react["default"].createElement(ItemsPageContainer, null, /*#__PURE__*/_react["default"].createElement(ItemsLabel, null, "Items per page "), /*#__PURE__*/_react["default"].createElement(SelectContainer, null, /*#__PURE__*/_react["default"].createElement(_Select["default"], {
+    options: itemsPerPageOptions.map(function (num) {
+      return {
+        label: num.toString(),
+        value: num.toString()
+      };
+    }),
+    onChange: function onChange(newValue) {
+      itemsPerPageFunction(Number(newValue.value));
+    },
+    value: itemsPerPage.toString(),
+    size: "fillParent",
+    margin: {
+      top: "xsmall"
+    },
+    tabIndex: tabIndex
+  }))), /*#__PURE__*/_react["default"].createElement(TotalItemsContainer, null, minItemsPerPage, " to ", maxItemsPerPage, " of ", totalItems), onPageChange && /*#__PURE__*/_react["default"].createElement(_Button["default"], {
+    size: "small",
+    mode: "secondary",
+    disabled: currentPageInternal === 1 || currentPageInternal === 0,
+    margin: {
+      left: "xxsmall",
+      right: "xxsmall"
+    },
+    icon: _Icons.firstIcon,
+    tabIndex: tabIndex,
+    onClick: function onClick() {
+      onPageChange(1);
+    }
+  }), onPageChange && /*#__PURE__*/_react["default"].createElement(_Button["default"], {
+    size: "small",
+    mode: "secondary",
+    disabled: currentPageInternal === 1 || currentPageInternal === 0,
+    margin: {
+      left: "xxsmall",
+      right: "xxsmall"
+    },
+    icon: _Icons.previousIcon,
+    tabIndex: tabIndex,
+    onClick: function onClick() {
+      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: Array.from(Array(totalPages), function (e, num) {
+      return {
+        label: (num + 1).toString(),
+        value: (num + 1).toString()
+      };
+    }),
+    onChange: function onChange(newValue) {
+      onPageChange(Number(newValue.value));
+    },
+    value: currentPage.toString(),
+    size: "fillParent",
+    margin: {
+      top: "xsmall"
+    },
+    tabIndex: tabIndex
+  }))) || /*#__PURE__*/_react["default"].createElement(TextContainer, null, "Page: ", currentPageInternal, " of ", totalPages), onPageChange && /*#__PURE__*/_react["default"].createElement(_Button["default"], {
+    size: "small",
+    mode: "secondary",
+    disabled: currentPageInternal === totalPages,
+    margin: {
+      left: "xxsmall",
+      right: "xxsmall"
+    },
+    icon: _Icons.nextIcon,
+    tabIndex: tabIndex,
+    onClick: function onClick() {
+      onPageChange(currentPage + 1);
+    }
+  }), onPageChange && /*#__PURE__*/_react["default"].createElement(_Button["default"], {
+    size: "small",
+    mode: "secondary",
+    disabled: currentPageInternal === totalPages,
+    margin: {
+      left: "xxsmall",
+      right: "xxsmall"
+    },
+    icon: _Icons.lastIcon,
+    tabIndex: tabIndex,
+    onClick: function onClick() {
+      onPageChange(totalPages);
+    }
+  })))));
+};
+
+var DxcPaginatorContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  height: ", ";\n  width: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-weight: ", ";\n  font-style: ", ";\n  text-transform: ", ";\n  background-color: ", ";\n  color: ", ";\n\n  button {\n    &:disabled {\n      background-color: transparent !important;\n      opacity: 0.3 !important;\n    }\n  }\n"])), function (props) {
+  return props.theme.height;
+}, function (props) {
+  return props.theme.width;
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.fontSize;
+}, function (props) {
+  return props.theme.fontWeight;
+}, function (props) {
+  return props.theme.fontStyle;
+}, function (props) {
+  return props.theme.fontTextTransform;
+}, function (props) {
+  return props.theme.backgroundColor;
+}, function (props) {
+  return props.theme.fontColor;
+});
+
+var SelectContainer = _styledComponents["default"].div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  max-width: 100px;\n"])));
+
+var ItemsPageContainer = _styledComponents["default"].span(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  align-items: center;\n  margin-right: ", ";\n  margin-left: ", ";\n\n  label {\n    height: 0px;\n  }\n  label + .MuiInput-formControl {\n    margin-top: 0px;\n  }\n"])), function (props) {
+  return props.theme.itemsPerPageSelectorMarginRight;
+}, function (props) {
+  return props.theme.itemsPerPageSelectorMarginLeft;
+});
+
+var ItemsLabel = _styledComponents["default"].span(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  margin-right: 15px;\n"])));
+
+var GoToLabel = _styledComponents["default"].span(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  margin-right: 10px;\n  margin-left: 10px;\n"])));
+
+var TotalItemsContainer = _styledComponents["default"].span(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["\n  margin-right: ", ";\n  margin-left: ", ";\n"])), function (props) {
+  return props.theme.totalItemsContainerMarginRight;
+}, function (props) {
+  return props.theme.totalItemsContainerMarginLeft;
+});
+
+var LabelsContainer = _styledComponents["default"].div(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  width: 100%;\n  justify-content: flex-end;\n  align-items: center;\n  margin: 0 ", " 0 ", ";\n"])), function (props) {
+  return props.theme.marginRight;
+}, function (props) {
+  return props.theme.marginLeft;
+});
+
+var PageToSelectContainer = _styledComponents["default"].span(_templateObject8 || (_templateObject8 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  align-items: center;\n  margin-right: ", ";\n  margin-left: ", ";\n\n  label {\n    height: 0px;\n  }\n  label + .MuiInput-formControl {\n    margin-top: 0px;\n  }\n"])), function (props) {
+  return props.theme.pageSelectorMarginRight;
+}, function (props) {
+  return props.theme.pageSelectorMarginLeft;
+});
+
+var TextContainer = _styledComponents["default"].span(_templateObject9 || (_templateObject9 = (0, _taggedTemplateLiteral2["default"])([""])));
+
+var _default = DxcPaginator;
+exports["default"] = _default;

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/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
+});