@instructure/ui-number-input 8.13.1-snapshot.48 → 8.14.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.14.0](https://github.com/instructure/instructure-ui/compare/v8.13.0...v8.14.0) (2021-12-16)
+
+### Features
+
+- **ui-number-input,ui-pagination:** add Pagination `input` variant, NumberInput `textAlign` prop ([5b90d60](https://github.com/instructure/instructure-ui/commit/5b90d608fd51296ae04e353e991f50a373c592c5))
+
 # [8.13.0](https://github.com/instructure/instructure-ui/compare/v8.12.0...v8.13.0) (2021-12-01)
 
 ### Features

package/es/NumberInput/NumberInputLocator.js

@@ -22,7 +22,8 @@
  * SOFTWARE.
  */
 import { locator } from '@instructure/ui-test-locator';
-import { NumberInput } from './index';
+import { NumberInput } from './index'; // @ts-expect-error ts-migrate(2339) FIXME: Property 'selector' does not exist on type 'typeof... Remove this comment to see the full error message
+
 export const NumberInputLocator = locator(NumberInput.selector, {
   findInput: function () {
     return locator('input').find(...arguments);

package/es/NumberInput/index.js

@@ -25,7 +25,7 @@ var _dec, _dec2, _class, _class2, _temp, _IconArrowOpenUpLine, _IconArrowOpenDow
  */
 
 /** @jsx jsx */
-import { Component } from 'react';
+import React, { Component } from 'react';
 import keycode from 'keycode';
 import { FormField } from '@instructure/ui-form-field';
 import { IconArrowOpenDownLine, IconArrowOpenUpLine } from '@instructure/ui-icons';
@@ -36,21 +36,23 @@ import { withStyle, jsx } from '@instructure/emotion';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
 import { allowedProps, propTypes } from './props';
+
 /**
 ---
 category: components
 id: NumberInput
 ---
+@tsProps
 **/
-
 let NumberInput = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = testable(), _dec(_class = _dec2(_class = (_temp = _class2 = class NumberInput extends Component {
   constructor() {
     super(...arguments);
     this.state = {
       hasFocus: false
     };
-    this._input = null;
     this.ref = null;
+    this._input = null;
+    this._id = void 0;
 
     this.handleRef = el => {
       this.ref = el;
@@ -58,36 +60,60 @@ let NumberInput = (_dec = withStyle(generateStyle, generateComponentTheme), _dec
 
     this.handleInputRef = element => {
       this._input = element;
-      this.props.inputRef(element);
+
+      if (typeof this.props.inputRef === 'function') {
+        this.props.inputRef(element);
+      }
     };
 
     this.handleFocus = event => {
       this.setState({
         hasFocus: true
       });
-      this.props.onFocus(event);
+
+      if (typeof this.props.onFocus === 'function') {
+        this.props.onFocus(event);
+      }
     };
 
     this.handleBlur = event => {
       this.setState({
         hasFocus: false
       });
-      this.props.onBlur(event);
+
+      if (typeof this.props.onBlur === 'function') {
+        this.props.onBlur(event);
+      }
     };
 
     this.handleChange = event => {
-      this.props.onChange(event, event.target.value);
+      if (typeof this.props.onChange === 'function') {
+        this.props.onChange(event, event.target.value);
+      }
     };
 
     this.handleKeyDown = event => {
-      this.props.onKeyDown(event);
+      const _this$props = this.props,
+            onKeyDown = _this$props.onKeyDown,
+            onDecrement = _this$props.onDecrement,
+            onIncrement = _this$props.onIncrement;
+
+      if (typeof onKeyDown === 'function') {
+        onKeyDown(event);
+      }
 
       if (event.keyCode === keycode.codes.down) {
         event.preventDefault();
-        this.props.onDecrement(event);
+
+        if (typeof onDecrement === 'function') {
+          onDecrement(event);
+        }
       } else if (event.keyCode === keycode.codes.up) {
         event.preventDefault();
-        this.props.onIncrement(event);
+
+        if (typeof onIncrement === 'function') {
+          onIncrement(event);
+        }
       }
     };
 
@@ -123,15 +149,15 @@ let NumberInput = (_dec = withStyle(generateStyle, generateComponentTheme), _dec
   }
 
   componentDidMount() {
-    var _this$props$makeStyle, _this$props;
+    var _this$props$makeStyle, _this$props2;
 
-    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props, this.makeStyleVariables);
+    (_this$props$makeStyle = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props2, this.makeStyleVariables);
   }
 
   componentDidUpdate() {
-    var _this$props$makeStyle2, _this$props2;
+    var _this$props$makeStyle2, _this$props3;
 
-    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2, this.makeStyleVariables);
+    (_this$props$makeStyle2 = (_this$props3 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props3, this.makeStyleVariables);
   }
 
   get makeStyleVariables() {
@@ -147,9 +173,13 @@ let NumberInput = (_dec = withStyle(generateStyle, generateComponentTheme), _dec
     event.preventDefault();
 
     if (interaction === 'enabled') {
-      this._input.focus();
+      var _this$_input;
 
-      callback(event);
+      (_this$_input = this._input) === null || _this$_input === void 0 ? void 0 : _this$_input.focus();
+
+      if (typeof callback === 'function') {
+        callback(event);
+      }
     }
   }
 
@@ -162,13 +192,13 @@ let NumberInput = (_dec = withStyle(generateStyle, generateComponentTheme), _dec
       "aria-hidden": true,
       css: (_this$props$styles2 = this.props.styles) === null || _this$props$styles2 === void 0 ? void 0 : _this$props$styles2.arrow,
       onMouseDown: this.handleClickUpArrow,
-      tabIndex: "-1",
+      tabIndex: -1,
       type: "button"
     }, _IconArrowOpenUpLine || (_IconArrowOpenUpLine = jsx(IconArrowOpenUpLine, null))), jsx("button", {
       "aria-hidden": true,
       css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.arrow,
       onMouseDown: this.handleClickDownArrow,
-      tabIndex: "-1",
+      tabIndex: -1,
       type: "button"
     }, _IconArrowOpenDownLin || (_IconArrowOpenDownLin = jsx(IconArrowOpenDownLine, null))));
   }
@@ -176,14 +206,14 @@ let NumberInput = (_dec = withStyle(generateStyle, generateComponentTheme), _dec
   render() {
     var _this$props$styles4, _this$props$styles5, _this$props$styles6;
 
-    const _this$props3 = this.props,
-          renderLabel = _this$props3.renderLabel,
-          display = _this$props3.display,
-          placeholder = _this$props3.placeholder,
-          isRequired = _this$props3.isRequired,
-          showArrows = _this$props3.showArrows,
-          value = _this$props3.value,
-          width = _this$props3.width;
+    const _this$props4 = this.props,
+          renderLabel = _this$props4.renderLabel,
+          display = _this$props4.display,
+          placeholder = _this$props4.placeholder,
+          isRequired = _this$props4.isRequired,
+          showArrows = _this$props4.showArrows,
+          value = _this$props4.value,
+          width = _this$props4.width;
     const interaction = this.interaction;
     return jsx(FormField, Object.assign({}, pickProps(this.props, FormField.allowedProps), {
       label: callRenderProp(renderLabel),
@@ -217,23 +247,14 @@ let NumberInput = (_dec = withStyle(generateStyle, generateComponentTheme), _dec
   }
 
 }, _class2.displayName = "NumberInput", _class2.componentId = 'NumberInput', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
-  id: null,
   // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
   interaction: void 0,
   messages: [],
-  placeholder: null,
   isRequired: false,
   showArrows: true,
   size: 'medium',
   display: 'block',
   textAlign: 'start',
-  inputRef: event => {},
-  onFocus: event => {},
-  onBlur: event => {},
-  onChange: (event, value) => {},
-  onDecrement: event => {},
-  onIncrement: event => {},
-  onKeyDown: event => {},
   inputMode: 'numeric'
 }, _temp)) || _class) || _class);
 export default NumberInput;

package/es/NumberInput/props.js

@@ -24,115 +24,25 @@
 import PropTypes from 'prop-types';
 import { FormPropTypes } from '@instructure/ui-form-field';
 const propTypes = {
-  /**
-   * The form field label.
-   */
   renderLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
-
-  /**
-   * The id of the input. One is generated if not supplied.
-   */
   id: PropTypes.string,
-
-  /**
-   * Specifies if interaction with the input is enabled, disabled, or readonly.
-   * When "disabled", the input changes visibly to indicate that it cannot
-   * receive user interactions. When "readonly" the input still cannot receive
-   * user interactions but it keeps the same styles as if it were enabled.
-   */
   interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
-
-  /**
-   * Object with shape: `{
-   *   text: PropTypes.node,
-   *   type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
-   * }`
-   */
   messages: PropTypes.arrayOf(FormPropTypes.message),
-
-  /**
-   * Html placeholder text to display when the input has no value. This
-   * should be hint text, not a label replacement.
-   */
   placeholder: PropTypes.string,
-
-  /**
-   * Whether or not the text input is required.
-   */
   isRequired: PropTypes.bool,
-
-  /**
-   * Whether or not to display the up/down arrow buttons.
-   */
   showArrows: PropTypes.bool,
-
-  /**
-   * The size of the input.
-   */
   size: PropTypes.oneOf(['medium', 'large']),
-
-  /**
-   * The value of the input (should be accompanied by an `onChange` prop).
-   */
   value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-
-  /**
-   * The width of the input.
-   */
   width: PropTypes.string,
-
-  /**
-   * The display of the root element.
-   */
   display: PropTypes.oneOf(['inline-block', 'block']),
-
-  /**
-   * A function that provides a reference to the actual input element.
-   */
   inputRef: PropTypes.func,
-
-  /**
-   * Callback fired when input receives focus.
-   */
   onFocus: PropTypes.func,
-
-  /**
-   * Callback fired when the input loses focus.
-   */
   onBlur: PropTypes.func,
-
-  /**
-   * Callback executed when the input fires a change event.
-   * @param {Object} event - the event object
-   * @param {Object} value - the string value of the input
-   */
   onChange: PropTypes.func,
-
-  /**
-   * Called when the down arrow button is clicked, or the down arrow key is
-   * pressed.
-   */
   onDecrement: PropTypes.func,
-
-  /**
-   * Called when the up arrow button is clicked, or the up arrow key is
-   * pressed.
-   */
   onIncrement: PropTypes.func,
-
-  /**
-   * Callback fired when a key is pressed.
-   */
   onKeyDown: PropTypes.func,
-
-  /**
-   * The inputMode attribute of the underlying `input` element can be one of ['numeric', 'decimal', 'tel']
-   */
   inputMode: PropTypes.oneOf(['numeric', 'decimal', 'tel']),
-
-  /**
-   * The text alignment of the input.
-   */
   textAlign: PropTypes.oneOf(['start', 'center'])
 };
 const allowedProps = ['renderLabel', 'id', 'interaction', 'messages', 'placeholder', 'isRequired', 'showArrows', 'size', 'value', 'width', 'display', 'inputRef', 'onFocus', 'onBlur', 'onChange', 'onDecrement', 'onIncrement', 'onKeyDown', 'inputMode', 'textAlign'];

package/lib/NumberInput/NumberInputLocator.js

@@ -32,6 +32,7 @@ var _index = require("./index");
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+// @ts-expect-error ts-migrate(2339) FIXME: Property 'selector' does not exist on type 'typeof... Remove this comment to see the full error message
 const NumberInputLocator = (0, _locator.locator)(_index.NumberInput.selector, {
   findInput: function () {
     return (0, _locator.locator)('input').find(...arguments);

package/lib/NumberInput/index.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 
 Object.defineProperty(exports, "__esModule", {
@@ -7,7 +9,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.NumberInput = void 0;
 
-var _react = require("react");
+var _react = _interopRequireWildcard(require("react"));
 
 var _keycode = _interopRequireDefault(require("keycode"));
 
@@ -44,6 +46,7 @@ var _dec, _dec2, _class, _class2, _temp, _IconArrowOpenUpLine, _IconArrowOpenDow
 category: components
 id: NumberInput
 ---
+@tsProps
 **/
 let NumberInput = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _dec2 = (0, _testable.testable)(), _dec(_class = _dec2(_class = (_temp = _class2 = class NumberInput extends _react.Component {
   constructor() {
@@ -51,8 +54,9 @@ let NumberInput = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
     this.state = {
       hasFocus: false
     };
-    this._input = null;
     this.ref = null;
+    this._input = null;
+    this._id = void 0;
 
     this.handleRef = el => {
       this.ref = el;
@@ -60,36 +64,60 @@ let NumberInput = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
 
     this.handleInputRef = element => {
       this._input = element;
-      this.props.inputRef(element);
+
+      if (typeof this.props.inputRef === 'function') {
+        this.props.inputRef(element);
+      }
     };
 
     this.handleFocus = event => {
       this.setState({
         hasFocus: true
       });
-      this.props.onFocus(event);
+
+      if (typeof this.props.onFocus === 'function') {
+        this.props.onFocus(event);
+      }
     };
 
     this.handleBlur = event => {
       this.setState({
         hasFocus: false
       });
-      this.props.onBlur(event);
+
+      if (typeof this.props.onBlur === 'function') {
+        this.props.onBlur(event);
+      }
     };
 
     this.handleChange = event => {
-      this.props.onChange(event, event.target.value);
+      if (typeof this.props.onChange === 'function') {
+        this.props.onChange(event, event.target.value);
+      }
     };
 
     this.handleKeyDown = event => {
-      this.props.onKeyDown(event);
+      const _this$props = this.props,
+            onKeyDown = _this$props.onKeyDown,
+            onDecrement = _this$props.onDecrement,
+            onIncrement = _this$props.onIncrement;
+
+      if (typeof onKeyDown === 'function') {
+        onKeyDown(event);
+      }
 
       if (event.keyCode === _keycode.default.codes.down) {
         event.preventDefault();
-        this.props.onDecrement(event);
+
+        if (typeof onDecrement === 'function') {
+          onDecrement(event);
+        }
       } else if (event.keyCode === _keycode.default.codes.up) {
         event.preventDefault();
-        this.props.onIncrement(event);
+
+        if (typeof onIncrement === 'function') {
+          onIncrement(event);
+        }
       }
     };
 
@@ -125,15 +153,15 @@ let NumberInput = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
   }
 
   componentDidMount() {
-    var _this$props$makeStyle, _this$props;
+    var _this$props$makeStyle, _this$props2;
 
-    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props, this.makeStyleVariables);
+    (_this$props$makeStyle = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props2, this.makeStyleVariables);
   }
 
   componentDidUpdate() {
-    var _this$props$makeStyle2, _this$props2;
+    var _this$props$makeStyle2, _this$props3;
 
-    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2, this.makeStyleVariables);
+    (_this$props$makeStyle2 = (_this$props3 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props3, this.makeStyleVariables);
   }
 
   get makeStyleVariables() {
@@ -149,9 +177,13 @@ let NumberInput = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
     event.preventDefault();
 
     if (interaction === 'enabled') {
-      this._input.focus();
+      var _this$_input;
 
-      callback(event);
+      (_this$_input = this._input) === null || _this$_input === void 0 ? void 0 : _this$_input.focus();
+
+      if (typeof callback === 'function') {
+        callback(event);
+      }
     }
   }
 
@@ -164,13 +196,13 @@ let NumberInput = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
       "aria-hidden": true,
       css: (_this$props$styles2 = this.props.styles) === null || _this$props$styles2 === void 0 ? void 0 : _this$props$styles2.arrow,
       onMouseDown: this.handleClickUpArrow,
-      tabIndex: "-1",
+      tabIndex: -1,
       type: "button"
     }, _IconArrowOpenUpLine || (_IconArrowOpenUpLine = (0, _emotion.jsx)(_IconArrowOpenUpLine2.IconArrowOpenUpLine, null))), (0, _emotion.jsx)("button", {
       "aria-hidden": true,
       css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.arrow,
       onMouseDown: this.handleClickDownArrow,
-      tabIndex: "-1",
+      tabIndex: -1,
       type: "button"
     }, _IconArrowOpenDownLin || (_IconArrowOpenDownLin = (0, _emotion.jsx)(_IconArrowOpenDownLine.IconArrowOpenDownLine, null))));
   }
@@ -178,14 +210,14 @@ let NumberInput = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
   render() {
     var _this$props$styles4, _this$props$styles5, _this$props$styles6;
 
-    const _this$props3 = this.props,
-          renderLabel = _this$props3.renderLabel,
-          display = _this$props3.display,
-          placeholder = _this$props3.placeholder,
-          isRequired = _this$props3.isRequired,
-          showArrows = _this$props3.showArrows,
-          value = _this$props3.value,
-          width = _this$props3.width;
+    const _this$props4 = this.props,
+          renderLabel = _this$props4.renderLabel,
+          display = _this$props4.display,
+          placeholder = _this$props4.placeholder,
+          isRequired = _this$props4.isRequired,
+          showArrows = _this$props4.showArrows,
+          value = _this$props4.value,
+          width = _this$props4.width;
     const interaction = this.interaction;
     return (0, _emotion.jsx)(_FormField.FormField, Object.assign({}, (0, _pickProps.pickProps)(this.props, _FormField.FormField.allowedProps), {
       label: (0, _callRenderProp.callRenderProp)(renderLabel),
@@ -219,23 +251,14 @@ let NumberInput = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
   }
 
 }, _class2.displayName = "NumberInput", _class2.componentId = 'NumberInput', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
-  id: null,
   // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
   interaction: void 0,
   messages: [],
-  placeholder: null,
   isRequired: false,
   showArrows: true,
   size: 'medium',
   display: 'block',
   textAlign: 'start',
-  inputRef: event => {},
-  onFocus: event => {},
-  onBlur: event => {},
-  onChange: (event, value) => {},
-  onDecrement: event => {},
-  onIncrement: event => {},
-  onKeyDown: event => {},
   inputMode: 'numeric'
 }, _temp)) || _class) || _class);
 exports.NumberInput = NumberInput;

package/lib/NumberInput/props.js

@@ -35,115 +35,25 @@ var _FormPropTypes = require("@instructure/ui-form-field/lib/FormPropTypes.js");
  * SOFTWARE.
  */
 const propTypes = {
-  /**
-   * The form field label.
-   */
   renderLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]).isRequired,
-
-  /**
-   * The id of the input. One is generated if not supplied.
-   */
   id: _propTypes.default.string,
-
-  /**
-   * Specifies if interaction with the input is enabled, disabled, or readonly.
-   * When "disabled", the input changes visibly to indicate that it cannot
-   * receive user interactions. When "readonly" the input still cannot receive
-   * user interactions but it keeps the same styles as if it were enabled.
-   */
   interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
-
-  /**
-   * Object with shape: `{
-   *   text: PropTypes.node,
-   *   type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
-   * }`
-   */
   messages: _propTypes.default.arrayOf(_FormPropTypes.FormPropTypes.message),
-
-  /**
-   * Html placeholder text to display when the input has no value. This
-   * should be hint text, not a label replacement.
-   */
   placeholder: _propTypes.default.string,
-
-  /**
-   * Whether or not the text input is required.
-   */
   isRequired: _propTypes.default.bool,
-
-  /**
-   * Whether or not to display the up/down arrow buttons.
-   */
   showArrows: _propTypes.default.bool,
-
-  /**
-   * The size of the input.
-   */
   size: _propTypes.default.oneOf(['medium', 'large']),
-
-  /**
-   * The value of the input (should be accompanied by an `onChange` prop).
-   */
   value: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-
-  /**
-   * The width of the input.
-   */
   width: _propTypes.default.string,
-
-  /**
-   * The display of the root element.
-   */
   display: _propTypes.default.oneOf(['inline-block', 'block']),
-
-  /**
-   * A function that provides a reference to the actual input element.
-   */
   inputRef: _propTypes.default.func,
-
-  /**
-   * Callback fired when input receives focus.
-   */
   onFocus: _propTypes.default.func,
-
-  /**
-   * Callback fired when the input loses focus.
-   */
   onBlur: _propTypes.default.func,
-
-  /**
-   * Callback executed when the input fires a change event.
-   * @param {Object} event - the event object
-   * @param {Object} value - the string value of the input
-   */
   onChange: _propTypes.default.func,
-
-  /**
-   * Called when the down arrow button is clicked, or the down arrow key is
-   * pressed.
-   */
   onDecrement: _propTypes.default.func,
-
-  /**
-   * Called when the up arrow button is clicked, or the up arrow key is
-   * pressed.
-   */
   onIncrement: _propTypes.default.func,
-
-  /**
-   * Callback fired when a key is pressed.
-   */
   onKeyDown: _propTypes.default.func,
-
-  /**
-   * The inputMode attribute of the underlying `input` element can be one of ['numeric', 'decimal', 'tel']
-   */
   inputMode: _propTypes.default.oneOf(['numeric', 'decimal', 'tel']),
-
-  /**
-   * The text alignment of the input.
-   */
   textAlign: _propTypes.default.oneOf(['start', 'center'])
 };
 exports.propTypes = propTypes;