@instructure/ui-pagination 11.6.0 → 11.6.1-snapshot-129

package/es/Pagination/v2/PaginationArrowButton/index.js

@@ -0,0 +1,109 @@
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+const _excluded = ["label", "direction", "buttonRef"];
+/*
+ * 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 { Component } from 'react';
+import { IconButton } from '@instructure/ui-buttons/latest';
+import { PresentationContent } from '@instructure/ui-a11y-content';
+import { Tooltip } from '@instructure/ui-tooltip/latest';
+import { ChevronLeftInstUIIcon, ChevronRightInstUIIcon, ChevronsLeftInstUIIcon, ChevronsRightInstUIIcon, renderIconWithProps } from '@instructure/ui-icons';
+import { allowedProps } from "./props.js";
+/**
+---
+parent: Pagination
+id: Pagination.Navigation
+---
+**/
+import { jsx as _jsx } from "@emotion/react/jsx-runtime";
+class PaginationArrowButton extends Component {
+  constructor(...args) {
+    super(...args);
+    this.ref = null;
+    this.handleRef = el => {
+      this.ref = el;
+    };
+  }
+  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 ChevronsLeftInstUIIcon;
+      case 'prev':
+        return ChevronLeftInstUIIcon;
+      case 'next':
+        return ChevronRightInstUIIcon;
+      case 'last':
+        return ChevronsRightInstUIIcon;
+      default:
+        return null;
+    }
+  }
+  renderIcon() {
+    const icon = this.Icon;
+    if (!icon) return null;
+    return renderIconWithProps(icon, 'md', 'actionTertiaryBaseColor');
+  }
+  render() {
+    const _this$props = this.props,
+      label = _this$props.label,
+      direction = _this$props.direction,
+      buttonRef = _this$props.buttonRef,
+      props = _objectWithoutProperties(_this$props, _excluded);
+    return _jsx(Tooltip, {
+      elementRef: this.handleRef,
+      on: ['hover', 'focus'],
+      renderTip: _jsx(PresentationContent, {
+        children: label
+      }),
+      children: _jsx(IconButton, {
+        ...props,
+        size: "small",
+        withBackground: false,
+        withBorder: false,
+        screenReaderLabel: label,
+        rel: props.href || props.to ? direction : void 0,
+        elementRef: buttonRef,
+        margin: this.margin,
+        "data-cid": "PaginationArrowButton",
+        children: this.renderIcon()
+      })
+    });
+  }
+}
+PaginationArrowButton.displayName = "PaginationArrowButton";
+PaginationArrowButton.componentId = 'Pagination.Navigation';
+PaginationArrowButton.allowedProps = allowedProps;
+PaginationArrowButton.defaultProps = {};
+export default PaginationArrowButton;
+export { PaginationArrowButton };

package/es/Pagination/v2/PaginationArrowButton/props.js

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+
+const allowedProps = ['direction', 'label', 'buttonRef'
+
+// we don't want to pass onClick
+// 'onClick'
+];
+export { allowedProps };

package/es/Pagination/v2/PaginationButton/index.js

@@ -0,0 +1,77 @@
+/*
+ * 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 { Component } from 'react';
+import { BaseButton } from '@instructure/ui-buttons/latest';
+import { omitProps } from '@instructure/ui-react-utils';
+import { allowedProps } from "./props.js";
+import { jsx as _jsx } from "@emotion/react/jsx-runtime";
+/**
+---
+parent: Pagination
+id: Pagination.Page
+---
+**/
+
+class PaginationButton extends Component {
+  constructor(...args) {
+    super(...args);
+    this.ref = null;
+    this.handleRef = el => {
+      this.ref = el;
+    };
+  }
+  render() {
+    const exclude = this.props.current ? ['onClick', 'href'] : [];
+    const props = omitProps(this.props, PaginationButton.allowedProps, exclude);
+
+    // wrapped in an unstyled <li> for better a11y
+    return _jsx("li", {
+      style: {
+        all: 'unset'
+      },
+      children: _jsx(BaseButton, {
+        color: "primary",
+        "data-cid": "PaginationButton",
+        withBackground: this.props.current,
+        withBorder: this.props.current,
+        ...props,
+        "aria-current": this.props.current ? 'page' : void 0,
+        elementRef: this.handleRef,
+        ...(this.props.screenReaderLabel ? {
+          'aria-label': this.props.screenReaderLabel
+        } : {}),
+        children: this.props.children
+      })
+    });
+  }
+}
+PaginationButton.displayName = "PaginationButton";
+PaginationButton.componentId = 'Pagination.Page';
+PaginationButton.allowedProps = allowedProps;
+PaginationButton.defaultProps = {
+  current: false
+};
+export default PaginationButton;
+export { PaginationButton };

package/es/Pagination/v2/PaginationButton/props.js

@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+
+const allowedProps = ['children', 'current', 'screenReaderLabel'
+// we don't want to pass onClick
+// 'onClick'
+];
+export { allowedProps };

package/es/Pagination/v2/PaginationPageInput/index.js

@@ -0,0 +1,189 @@
+var _dec, _class, _PaginationPageInput;
+/*
+ * 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 { Component } from 'react';
+import { withStyle } from '@instructure/emotion';
+import { Text } from '@instructure/ui-text/latest';
+import { NumberInput } from '@instructure/ui-number-input/latest';
+import { ScreenReaderContent } from '@instructure/ui-a11y-content';
+import generateStyle from "./styles.js";
+import { allowedProps } from "./props.js";
+import { jsx as _jsx, jsxs as _jsxs } from "@emotion/react/jsx-runtime";
+/**
+---
+parent: Pagination
+id: Pagination.PageInput
+---
+**/
+let PaginationPageInput = (_dec = withStyle(generateStyle, 'PaginationPageInput'), _dec(_class = (_PaginationPageInput = class PaginationPageInput extends Component {
+  constructor(props) {
+    super(props);
+    this.ref = null;
+    this.handleRef = el => {
+      this.ref = el;
+    };
+    this.handleInputRef = 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 => {
+      if (Math.round(this.state.number) !== this.currentPage) {
+        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(Text, {
+      variant: "content",
+      children: _jsx("span", {
+        css: styles === null || styles === void 0 ? void 0 : styles.inputLabel,
+        children: label(numberOfPages)
+      })
+    }) : null;
+  }
+  renderScreenReaderLabel() {
+    const _this$props4 = this.props,
+      screenReaderLabel = _this$props4.screenReaderLabel,
+      numberOfPages = _this$props4.numberOfPages;
+    return _jsx(ScreenReaderContent, {
+      children: screenReaderLabel(this.currentPage, numberOfPages)
+    });
+  }
+  render() {
+    const _this$props5 = this.props,
+      styles = _this$props5.styles,
+      disabled = _this$props5.disabled;
+    return _jsxs("span", {
+      css: styles === null || styles === void 0 ? void 0 : styles.paginationPageInput,
+      ref: this.handleRef,
+      "data-cid": "PaginationPageInput",
+      children: [_jsx("span", {
+        css: styles === null || styles === void 0 ? void 0 : styles.numberInput,
+        children: _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()]
+    });
+  }
+}, _PaginationPageInput.displayName = "PaginationPageInput", _PaginationPageInput.componentId = 'Pagination.PageInput', _PaginationPageInput.allowedProps = allowedProps, _PaginationPageInput.defaultProps = {
+  disabled: false
+}, _PaginationPageInput)) || _class);
+export default PaginationPageInput;
+export { PaginationPageInput };

package/es/Pagination/v2/PaginationPageInput/props.js

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+
+const allowedProps = ['numberOfPages', 'currentPageIndex', 'onChange', 'screenReaderLabel', 'label', 'disabled', 'inputRef'];
+export { allowedProps };

package/es/Pagination/v2/PaginationPageInput/styles.js

@@ -0,0 +1,56 @@
+/*
+ * 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} sharedTokens Shared token object that stores common values for the theme.
+ * @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',
+      color: componentTheme.labelColor
+    }
+  };
+};
+export default generateStyle;