@instructure/ui-pagination 8.13.1-snapshot.10 → 8.13.1-snapshot.22

package/es/Pagination/PaginationArrowButton/index.js

@@ -30,7 +30,7 @@ import React, { Component } from 'react';
 import { IconButton } from '@instructure/ui-buttons';
 import { PresentationContent } from '@instructure/ui-a11y-content';
 import { Tooltip } from '@instructure/ui-tooltip';
-import { IconArrowOpenStartSolid, IconArrowOpenEndSolid } from '@instructure/ui-icons';
+import { IconArrowOpenStartSolid, IconArrowOpenEndSolid, IconArrowDoubleStartSolid, IconArrowDoubleEndSolid } from '@instructure/ui-icons';
 import { testable } from '@instructure/ui-testable';
 import { allowedProps, propTypes } from './props';
 /**
@@ -50,6 +50,38 @@ let PaginationArrowButton = (_dec = testable(), _dec(_class = (_temp = _class2 =
     };
   }
 
+  get margin() {
+    switch (this.props.direction) {
+      case 'first':
+        return '0 xx-small 0 0';
+
+      case 'last':
+        return '0 0 0 xx-small';
+
+      default:
+        return void 0;
+    }
+  }
+
+  get Icon() {
+    switch (this.props.direction) {
+      case 'first':
+        return IconArrowDoubleStartSolid;
+
+      case 'prev':
+        return IconArrowOpenStartSolid;
+
+      case 'next':
+        return IconArrowOpenEndSolid;
+
+      case 'last':
+        return IconArrowDoubleEndSolid;
+
+      default:
+        return null;
+    }
+  }
+
   render() {
     const _this$props = this.props,
           label = _this$props.label,
@@ -57,7 +89,6 @@ let PaginationArrowButton = (_dec = testable(), _dec(_class = (_temp = _class2 =
           buttonRef = _this$props.buttonRef,
           props = _objectWithoutProperties(_this$props, _excluded);
 
-    const Icon = direction === 'prev' ? IconArrowOpenStartSolid : IconArrowOpenEndSolid;
     return /*#__PURE__*/React.createElement(Tooltip, {
       on: ['hover', 'focus'],
       renderTip: /*#__PURE__*/React.createElement(PresentationContent, {
@@ -69,8 +100,9 @@ let PaginationArrowButton = (_dec = testable(), _dec(_class = (_temp = _class2 =
       withBorder: false,
       screenReaderLabel: label,
       rel: props.href || props.to ? direction : void 0,
-      elementRef: buttonRef
-    }), Icon));
+      elementRef: buttonRef,
+      margin: this.margin
+    }), this.Icon));
   }
 
 }, _class2.displayName = "PaginationArrowButton", _class2.componentId = 'Pagination.Navigation', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {

package/es/Pagination/PaginationArrowButton/props.js

@@ -23,7 +23,7 @@
  */
 import PropTypes from 'prop-types';
 const propTypes = {
-  direction: PropTypes.oneOf(['next', 'prev']),
+  direction: PropTypes.oneOf(['first', 'prev', 'next', 'last']),
   label: PropTypes.oneOfType([PropTypes.string, PropTypes.node]).isRequired,
   buttonRef: PropTypes.func
 };

package/es/Pagination/PaginationLocator.js

@@ -22,6 +22,7 @@
  * SOFTWARE.
  */
 import { locator } from '@instructure/ui-test-locator';
+import { PaginationPageInputLocator } from './PaginationPageInput/PaginationPageInputLocator';
 import { PaginationArrowButtonLocator } from './PaginationArrowButton/PaginationArrowButtonLocator';
 import { Pagination } from './index';
 const PaginationButtonLocator = locator(Pagination.Page.selector);
@@ -34,5 +35,8 @@ export const PaginationLocator = locator(Pagination.selector, {
   },
   findArrowButton: async function () {
     return PaginationArrowButtonLocator.find(...arguments);
+  },
+  findPageInput: async function () {
+    return PaginationPageInputLocator.find(...arguments);
   }
 });

package/es/Pagination/PaginationPageInput/PaginationPageInputLocator.js

@@ -0,0 +1,35 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { locator } from '@instructure/ui-test-locator';
+import { NumberInputLocator } from '@instructure/ui-number-input/es/NumberInput/NumberInputLocator'; // eslint-disable-line no-restricted-imports
+
+import { PaginationPageInput } from './index';
+export const PaginationPageInputLocator = locator(PaginationPageInput.selector, {
+  findInput: function () {
+    return NumberInputLocator.findInput(...arguments);
+  },
+  findNumberInputArrows: function () {
+    return NumberInputLocator.findArrowButtons(...arguments);
+  }
+});

package/es/Pagination/PaginationPageInput/index.js

@@ -0,0 +1,208 @@
+var _dec, _dec2, _class, _class2, _temp;
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/** @jsx jsx */
+import { Component } from 'react';
+import { testable } from '@instructure/ui-testable';
+import { withStyle, jsx } from '@instructure/emotion';
+import { NumberInput } from '@instructure/ui-number-input';
+import { ScreenReaderContent } from '@instructure/ui-a11y-content';
+import generateStyle from './styles';
+import generateComponentTheme from './theme';
+import { propTypes, allowedProps } from './props';
+
+/**
+---
+parent: Pagination
+id: Pagination.PageInput
+---
+@tsProps
+**/
+let PaginationPageInput = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = testable(), _dec(_class = _dec2(_class = (_temp = _class2 = class PaginationPageInput extends Component {
+  constructor(props) {
+    super(props);
+    this.ref = null;
+    this._inputRef = null;
+
+    this.handleRef = el => {
+      this.ref = el;
+    };
+
+    this.handleInputRef = el => {
+      this._inputRef = el;
+
+      if (typeof this.props.inputRef === 'function') {
+        this.props.inputRef(el);
+      }
+    };
+
+    this.handleChange = (_event, value) => {
+      let newValue = value; // if the last character was not a number, don't accept it
+
+      if (value.length > 0 && isNaN(value.slice(-1))) {
+        newValue = value.slice(0, -1);
+      }
+
+      this.setState({
+        number: newValue ? Number(newValue) : this.MIN,
+        value: newValue
+      });
+    };
+
+    this.handleDecrement = event => {
+      this.setNewPage(event, Math.floor(this.currentPage - 1));
+    };
+
+    this.handleIncrement = event => {
+      this.setNewPage(event, Math.floor(this.currentPage + 1));
+    };
+
+    this.handleBlur = event => {
+      this.setNewPage(event, Math.round(this.state.number));
+    };
+
+    this.state = this.initialState;
+  }
+
+  get currentPage() {
+    return this.props.currentPageIndex + 1;
+  }
+
+  get initialState() {
+    return {
+      number: this.currentPage,
+      value: `${this.currentPage}`
+    };
+  }
+
+  get MIN() {
+    return 1;
+  }
+
+  get MAX() {
+    return this.props.numberOfPages;
+  }
+
+  componentDidMount() {
+    var _this$props$makeStyle, _this$props;
+
+    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props);
+  }
+
+  componentDidUpdate(prevProps) {
+    var _this$props$makeStyle2, _this$props2;
+
+    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2); // when the current page changes from outside (e.g.: from arrow buttons),
+    // we update the initial state
+
+    if (this.props.currentPageIndex !== prevProps.currentPageIndex) {
+      this.resetInitialState();
+    }
+  }
+
+  resetInitialState() {
+    this.setState(this.initialState);
+  }
+
+  handleKeyDown(event) {
+    const key = event.key;
+
+    if (key.toLowerCase() === 'enter') {
+      const _this$state = this.state,
+            value = _this$state.value,
+            number = _this$state.number; // If it is invalid, we reset the input to the current page
+
+      if (value === '' || isNaN(value)) {
+        this.resetInitialState();
+        return;
+      }
+
+      this.setNewPage(event, number);
+    }
+  }
+
+  getNumberWithinRange(n) {
+    if (n < this.MIN) return this.MIN;
+    if (n > this.MAX) return this.MAX;
+    return n;
+  }
+
+  setNewPage(event, n) {
+    const number = this.getNumberWithinRange(n);
+    this.setState({
+      number,
+      value: `${number}`
+    });
+    this.props.onChange(event, number - 1);
+  }
+
+  renderLabel() {
+    const _this$props3 = this.props,
+          label = _this$props3.label,
+          numberOfPages = _this$props3.numberOfPages,
+          styles = _this$props3.styles;
+    return typeof label === 'function' && label(numberOfPages) ? jsx("span", {
+      css: styles === null || styles === void 0 ? void 0 : styles.inputLabel
+    }, label(numberOfPages)) : null;
+  }
+
+  renderScreenReaderLabel() {
+    const _this$props4 = this.props,
+          screenReaderLabel = _this$props4.screenReaderLabel,
+          numberOfPages = _this$props4.numberOfPages;
+    return jsx(ScreenReaderContent, null, screenReaderLabel(this.currentPage, numberOfPages));
+  }
+
+  render() {
+    const _this$props5 = this.props,
+          styles = _this$props5.styles,
+          disabled = _this$props5.disabled;
+    return jsx("span", {
+      css: styles === null || styles === void 0 ? void 0 : styles.paginationPageInput,
+      ref: this.handleRef
+    }, jsx("span", {
+      css: styles === null || styles === void 0 ? void 0 : styles.numberInput
+    }, jsx(NumberInput, {
+      renderLabel: this.renderScreenReaderLabel(),
+      onBlur: this.handleBlur,
+      onChange: this.handleChange,
+      onDecrement: this.handleDecrement,
+      onIncrement: this.handleIncrement,
+      onKeyDown: this.handleKeyDown.bind(this),
+      interaction: disabled ? 'disabled' : 'enabled',
+      showArrows: false,
+      value: this.state.value,
+      width: "100%",
+      textAlign: "center",
+      inputRef: this.handleInputRef
+    })), this.renderLabel());
+  }
+
+}, _class2.displayName = "PaginationPageInput", _class2.componentId = 'Pagination.PageInput', _class2.propTypes = propTypes, _class2.allowedProps = allowedProps, _class2.defaultProps = {
+  disabled: false
+}, _temp)) || _class) || _class);
+export default PaginationPageInput;
+export { PaginationPageInput };

package/es/Pagination/PaginationPageInput/props.js

@@ -0,0 +1,35 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import PropTypes from 'prop-types';
+const propTypes = {
+  numberOfPages: PropTypes.number.isRequired,
+  currentPageIndex: PropTypes.number.isRequired,
+  onChange: PropTypes.func.isRequired,
+  screenReaderLabel: PropTypes.func.isRequired,
+  label: PropTypes.func,
+  disabled: PropTypes.bool,
+  inputRef: PropTypes.func
+};
+const allowedProps = ['numberOfPages', 'currentPageIndex', 'onChange', 'screenReaderLabel', 'label', 'disabled', 'inputRef'];
+export { propTypes, allowedProps };

package/es/Pagination/PaginationPageInput/styles.js

@@ -0,0 +1,55 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} props the props of the component, the style is applied to
+ * @param  {Object} state the state of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+const generateStyle = componentTheme => {
+  return {
+    paginationPageInput: {
+      label: 'paginationPageInput',
+      display: 'inline-flex',
+      alignItems: 'center',
+      margin: `0 ${componentTheme.inputSpacing}`
+    },
+    numberInput: {
+      label: 'paginationPageInput__input',
+      width: componentTheme.inputWidth
+    },
+    inputLabel: {
+      label: 'paginationPageInput__inputLabel',
+      marginInlineStart: componentTheme.inputSpacing,
+      whiteSpace: 'nowrap'
+    }
+  };
+};
+
+export default generateStyle;

package/es/Pagination/PaginationPageInput/theme.js

@@ -0,0 +1,40 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/**
+ * Generates the theme object for the component from the theme and provided additional information
+ * @param  {Object} theme The actual theme object.
+ * @return {Object} The final theme object with the overrides and component variables
+ */
+const generateComponentTheme = theme => {
+  const spacing = theme.spacing;
+  const componentVariables = {
+    inputSpacing: spacing.xSmall,
+    inputWidth: '4.5rem'
+  };
+  return { ...componentVariables
+  };
+};
+
+export default generateComponentTheme;