@instructure/ui-number-input 9.8.1 → 9.9.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [9.9.0](https://github.com/instructure/instructure-ui/compare/v9.8.1...v9.9.0) (2024-11-12)
+
+
+### Features
+
+* **many:** backport new error messages from v10 ([9003d19](https://github.com/instructure/instructure-ui/commit/9003d19cc66022dfdeecc2e2c8c8d9d2a7300e3f))
+
+
+
+
+
 ## [9.8.1](https://github.com/instructure/instructure-ui/compare/v9.8.0...v9.8.1) (2024-10-28)
 
 

package/es/NumberInput/index.js

@@ -30,6 +30,7 @@ import { FormField } from '@instructure/ui-form-field';
 import { IconArrowOpenDownLine, IconArrowOpenUpLine } from '@instructure/ui-icons';
 import { testable } from '@instructure/ui-testable';
 import { omitProps, pickProps, callRenderProp, getInteraction, withDeterministicId } from '@instructure/ui-react-utils';
+import { hasVisibleChildren } from '@instructure/ui-a11y-utils';
 import { withStyle, jsx } from '@instructure/emotion';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
@@ -116,7 +117,7 @@ let NumberInput = (_dec = withDeterministicId(), _dec2 = withStyle(generateStyle
     return this._id;
   }
   get invalid() {
-    return !!this.props.messages && this.props.messages.some(message => message.type === 'error');
+    return !!this.props.messages && this.props.messages.some(message => message.type === 'error' || message.type === 'newError');
   }
   get interaction() {
     return getInteraction({
@@ -177,10 +178,14 @@ let NumberInput = (_dec = withDeterministicId(), _dec2 = withStyle(generateStyle
       showArrows = _this$props4.showArrows,
       value = _this$props4.value,
       width = _this$props4.width,
-      allowStringValue = _this$props4.allowStringValue;
+      styles = _this$props4.styles;
     const interaction = this.interaction;
+    const rawLabel = callRenderProp(renderLabel);
+    const label = hasVisibleChildren(rawLabel) ? jsx(React.Fragment, null, rawLabel, isRequired && jsx("span", {
+      css: this.invalid ? styles === null || styles === void 0 ? void 0 : styles.requiredInvalid : {}
+    }, " *")) : rawLabel;
     return jsx(FormField, Object.assign({}, pickProps(this.props, FormField.allowedProps), {
-      label: callRenderProp(renderLabel),
+      label: label,
       inline: display === 'inline-block',
       id: this.id,
       elementRef: this.handleRef
@@ -195,7 +200,7 @@ let NumberInput = (_dec = withDeterministicId(), _dec2 = withStyle(generateStyle
       css: (_this$props$styles6 = this.props.styles) === null || _this$props$styles6 === void 0 ? void 0 : _this$props$styles6.input,
       "aria-invalid": this.invalid ? 'true' : void 0,
       id: this.id,
-      type: allowStringValue ? 'text' : 'number',
+      type: "number",
       inputMode: this.props.inputMode,
       placeholder: placeholder,
       ref: this.handleInputRef,
@@ -218,8 +223,7 @@ let NumberInput = (_dec = withDeterministicId(), _dec2 = withStyle(generateStyle
   size: 'medium',
   display: 'block',
   textAlign: 'start',
-  inputMode: 'numeric',
-  allowStringValue: false
+  inputMode: 'numeric'
 }, _NumberInput)) || _class) || _class) || _class);
 export default NumberInput;
 export { NumberInput };

package/es/NumberInput/props.js

@@ -44,8 +44,7 @@ const propTypes = {
   onIncrement: PropTypes.func,
   onKeyDown: PropTypes.func,
   inputMode: PropTypes.oneOf(['numeric', 'decimal', 'tel']),
-  textAlign: PropTypes.oneOf(['start', 'center']),
-  allowStringValue: PropTypes.bool
+  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', 'allowStringValue'];
+const allowedProps = ['renderLabel', 'id', 'interaction', 'messages', 'placeholder', 'isRequired', 'showArrows', 'size', 'value', 'width', 'display', 'inputRef', 'onFocus', 'onBlur', 'onChange', 'onDecrement', 'onIncrement', 'onKeyDown', 'inputMode', 'textAlign'];
 export { propTypes, allowedProps };

package/es/NumberInput/styles.js

@@ -77,6 +77,9 @@ const generateStyle = (componentTheme, props, state) => {
     }
   };
   return {
+    requiredInvalid: {
+      color: componentTheme.requiredInvalidColor
+    },
     numberInput: {
       label: 'numberInput'
     },

package/es/NumberInput/theme.js

@@ -50,6 +50,7 @@ const generateComponentTheme = theme => {
     borderRadius: borders === null || borders === void 0 ? void 0 : borders.radiusMedium,
     color: colors === null || colors === void 0 ? void 0 : colors.textDarkest,
     background: colors === null || colors === void 0 ? void 0 : colors.backgroundLightest,
+    requiredInvalidColor: colors === null || colors === void 0 ? void 0 : colors.textDanger,
     padding: `0 ${spacing === null || spacing === void 0 ? void 0 : spacing.small}`,
     arrowsContainerWidth: '2rem',
     arrowsColor: colors === null || colors === void 0 ? void 0 : colors.textDarkest,

package/lib/NumberInput/index.js

@@ -17,6 +17,7 @@ var _pickProps = require("@instructure/ui-react-utils/lib/pickProps.js");
 var _callRenderProp = require("@instructure/ui-react-utils/lib/callRenderProp.js");
 var _getInteraction = require("@instructure/ui-react-utils/lib/getInteraction.js");
 var _withDeterministicId = require("@instructure/ui-react-utils/lib/DeterministicIdContext/withDeterministicId.js");
+var _hasVisibleChildren = require("@instructure/ui-a11y-utils/lib/hasVisibleChildren.js");
 var _emotion = require("@instructure/emotion");
 var _styles = _interopRequireDefault(require("./styles"));
 var _theme = _interopRequireDefault(require("./theme"));
@@ -128,7 +129,7 @@ let NumberInput = exports.NumberInput = (_dec = (0, _withDeterministicId.withDet
     return this._id;
   }
   get invalid() {
-    return !!this.props.messages && this.props.messages.some(message => message.type === 'error');
+    return !!this.props.messages && this.props.messages.some(message => message.type === 'error' || message.type === 'newError');
   }
   get interaction() {
     return (0, _getInteraction.getInteraction)({
@@ -189,10 +190,14 @@ let NumberInput = exports.NumberInput = (_dec = (0, _withDeterministicId.withDet
       showArrows = _this$props4.showArrows,
       value = _this$props4.value,
       width = _this$props4.width,
-      allowStringValue = _this$props4.allowStringValue;
+      styles = _this$props4.styles;
     const interaction = this.interaction;
+    const rawLabel = (0, _callRenderProp.callRenderProp)(renderLabel);
+    const label = (0, _hasVisibleChildren.hasVisibleChildren)(rawLabel) ? (0, _emotion.jsx)(_react.default.Fragment, null, rawLabel, isRequired && (0, _emotion.jsx)("span", {
+      css: this.invalid ? styles === null || styles === void 0 ? void 0 : styles.requiredInvalid : {}
+    }, " *")) : rawLabel;
     return (0, _emotion.jsx)(_FormField.FormField, Object.assign({}, (0, _pickProps.pickProps)(this.props, _FormField.FormField.allowedProps), {
-      label: (0, _callRenderProp.callRenderProp)(renderLabel),
+      label: label,
       inline: display === 'inline-block',
       id: this.id,
       elementRef: this.handleRef
@@ -207,7 +212,7 @@ let NumberInput = exports.NumberInput = (_dec = (0, _withDeterministicId.withDet
       css: (_this$props$styles6 = this.props.styles) === null || _this$props$styles6 === void 0 ? void 0 : _this$props$styles6.input,
       "aria-invalid": this.invalid ? 'true' : void 0,
       id: this.id,
-      type: allowStringValue ? 'text' : 'number',
+      type: "number",
       inputMode: this.props.inputMode,
       placeholder: placeholder,
       ref: this.handleInputRef,
@@ -230,7 +235,6 @@ let NumberInput = exports.NumberInput = (_dec = (0, _withDeterministicId.withDet
   size: 'medium',
   display: 'block',
   textAlign: 'start',
-  inputMode: 'numeric',
-  allowStringValue: false
+  inputMode: 'numeric'
 }, _NumberInput)) || _class) || _class) || _class);
 var _default = exports.default = NumberInput;

package/lib/NumberInput/props.js

@@ -51,7 +51,6 @@ const propTypes = exports.propTypes = {
   onIncrement: _propTypes.default.func,
   onKeyDown: _propTypes.default.func,
   inputMode: _propTypes.default.oneOf(['numeric', 'decimal', 'tel']),
-  textAlign: _propTypes.default.oneOf(['start', 'center']),
-  allowStringValue: _propTypes.default.bool
+  textAlign: _propTypes.default.oneOf(['start', 'center'])
 };
-const allowedProps = exports.allowedProps = ['renderLabel', 'id', 'interaction', 'messages', 'placeholder', 'isRequired', 'showArrows', 'size', 'value', 'width', 'display', 'inputRef', 'onFocus', 'onBlur', 'onChange', 'onDecrement', 'onIncrement', 'onKeyDown', 'inputMode', 'textAlign', 'allowStringValue'];
+const allowedProps = exports.allowedProps = ['renderLabel', 'id', 'interaction', 'messages', 'placeholder', 'isRequired', 'showArrows', 'size', 'value', 'width', 'display', 'inputRef', 'onFocus', 'onBlur', 'onChange', 'onDecrement', 'onIncrement', 'onKeyDown', 'inputMode', 'textAlign'];

package/lib/NumberInput/styles.js

@@ -83,6 +83,9 @@ const generateStyle = (componentTheme, props, state) => {
     }
   };
   return {
+    requiredInvalid: {
+      color: componentTheme.requiredInvalidColor
+    },
     numberInput: {
       label: 'numberInput'
     },

package/lib/NumberInput/theme.js

@@ -56,6 +56,7 @@ const generateComponentTheme = theme => {
     borderRadius: borders === null || borders === void 0 ? void 0 : borders.radiusMedium,
     color: colors === null || colors === void 0 ? void 0 : colors.textDarkest,
     background: colors === null || colors === void 0 ? void 0 : colors.backgroundLightest,
+    requiredInvalidColor: colors === null || colors === void 0 ? void 0 : colors.textDanger,
     padding: `0 ${spacing === null || spacing === void 0 ? void 0 : spacing.small}`,
     arrowsContainerWidth: '2rem',
     arrowsColor: colors === null || colors === void 0 ? void 0 : colors.textDarkest,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-number-input",
-  "version": "9.8.1",
+  "version": "9.9.0",
   "description": "A UI component library made by Instructure Inc.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "homepage": "https://instructure.github.io/instructure-ui/",
@@ -23,25 +23,26 @@
     "ts:check": "tsc -p tsconfig.build.json --noEmit --emitDeclarationOnly false"
   },
   "devDependencies": {
-    "@instructure/ui-axe-check": "9.8.1",
-    "@instructure/ui-babel-preset": "9.8.1",
-    "@instructure/ui-scripts": "9.8.1",
-    "@instructure/ui-test-locator": "9.8.1",
-    "@instructure/ui-test-utils": "9.8.1",
-    "@instructure/ui-themes": "9.8.1",
+    "@instructure/ui-axe-check": "9.9.0",
+    "@instructure/ui-babel-preset": "9.9.0",
+    "@instructure/ui-scripts": "9.9.0",
+    "@instructure/ui-test-locator": "9.9.0",
+    "@instructure/ui-test-utils": "9.9.0",
+    "@instructure/ui-themes": "9.9.0",
     "@testing-library/react": "^15.0.7",
     "vitest": "^2.0.2"
   },
   "dependencies": {
     "@babel/runtime": "^7.24.5",
-    "@instructure/emotion": "9.8.1",
-    "@instructure/shared-types": "9.8.1",
-    "@instructure/ui-form-field": "9.8.1",
-    "@instructure/ui-icons": "9.8.1",
-    "@instructure/ui-react-utils": "9.8.1",
-    "@instructure/ui-testable": "9.8.1",
-    "@instructure/ui-utils": "9.8.1",
-    "@instructure/uid": "9.8.1",
+    "@instructure/emotion": "9.9.0",
+    "@instructure/shared-types": "9.9.0",
+    "@instructure/ui-a11y-utils": "9.9.0",
+    "@instructure/ui-form-field": "9.9.0",
+    "@instructure/ui-icons": "9.9.0",
+    "@instructure/ui-react-utils": "9.9.0",
+    "@instructure/ui-testable": "9.9.0",
+    "@instructure/ui-utils": "9.9.0",
+    "@instructure/uid": "9.9.0",
     "keycode": "^2",
     "prop-types": "^15.8.1"
   },

package/src/NumberInput/index.tsx

@@ -39,6 +39,7 @@ import {
   getInteraction,
   withDeterministicId
 } from '@instructure/ui-react-utils'
+import { hasVisibleChildren } from '@instructure/ui-a11y-utils'
 
 import { withStyle, jsx } from '@instructure/emotion'
 
@@ -74,8 +75,7 @@ class NumberInput extends Component<NumberInputProps, NumberInputState> {
     size: 'medium',
     display: 'block',
     textAlign: 'start',
-    inputMode: 'numeric',
-    allowStringValue: false
+    inputMode: 'numeric'
   }
 
   state: NumberInputState = { hasFocus: false }
@@ -102,7 +102,9 @@ class NumberInput extends Component<NumberInputProps, NumberInputState> {
   get invalid() {
     return (
       !!this.props.messages &&
-      this.props.messages.some((message) => message.type === 'error')
+      this.props.messages.some(
+        (message) => message.type === 'error' || message.type === 'newError'
+      )
     )
   }
 
@@ -234,15 +236,27 @@ class NumberInput extends Component<NumberInputProps, NumberInputState> {
       showArrows,
       value,
       width,
-      allowStringValue
+      styles
     } = this.props
 
     const { interaction } = this
 
+    const rawLabel = callRenderProp(renderLabel)
+    const label = hasVisibleChildren(rawLabel) ? (
+      <React.Fragment>
+        {rawLabel}
+        {isRequired && (
+          <span css={this.invalid ? styles?.requiredInvalid : {}}> *</span>
+        )}
+      </React.Fragment>
+    ) : (
+      rawLabel
+    )
+
     return (
       <FormField
         {...pickProps(this.props, FormField.allowedProps)}
-        label={callRenderProp(renderLabel)}
+        label={label}
         inline={display === 'inline-block'}
         id={this.id}
         elementRef={this.handleRef}
@@ -260,7 +274,7 @@ class NumberInput extends Component<NumberInputProps, NumberInputState> {
               css={this.props.styles?.input}
               aria-invalid={this.invalid ? 'true' : undefined}
               id={this.id}
-              type={allowStringValue ? 'text' : 'number'}
+              type="number"
               inputMode={this.props.inputMode}
               placeholder={placeholder}
               ref={this.handleInputRef}

package/src/NumberInput/props.ts

@@ -64,7 +64,7 @@ type NumberInputOwnProps = {
   /**
    * Array of objects with shape: `{
    *   text: ReactNode,
-   *   type: One of: ['error', 'hint', 'success', 'screenreader-only']
+   *   type: One of: ['newError', 'error', 'hint', 'success', 'screenreader-only']
    * }`
    */
   messages?: FormMessage[]
@@ -161,11 +161,6 @@ type NumberInputOwnProps = {
    * The text alignment of the input.
    */
   textAlign?: 'start' | 'center'
-
-  /**
-   * sets the input type to string and allows string as value
-   */
-  allowStringValue?: boolean
 }
 
 type NumberInputState = {
@@ -202,6 +197,7 @@ type NumberInputStyle = ComponentStyle<
   | 'inputWidth'
   | 'inputContainer'
   | 'input'
+  | 'requiredInvalid'
 >
 
 const propTypes: PropValidators<PropKeys> = {
@@ -224,8 +220,7 @@ const propTypes: PropValidators<PropKeys> = {
   onIncrement: PropTypes.func,
   onKeyDown: PropTypes.func,
   inputMode: PropTypes.oneOf(['numeric', 'decimal', 'tel']),
-  textAlign: PropTypes.oneOf(['start', 'center']),
-  allowStringValue: PropTypes.bool
+  textAlign: PropTypes.oneOf(['start', 'center'])
 }
 
 const allowedProps: AllowedPropKeys = [
@@ -248,8 +243,7 @@ const allowedProps: AllowedPropKeys = [
   'onIncrement',
   'onKeyDown',
   'inputMode',
-  'textAlign',
-  'allowStringValue'
+  'textAlign'
 ]
 
 export type {

package/src/NumberInput/styles.ts

@@ -98,6 +98,9 @@ const generateStyle = (
   }
 
   return {
+    requiredInvalid: {
+      color: componentTheme.requiredInvalidColor
+    },
     numberInput: {
       label: 'numberInput'
     },

package/src/NumberInput/theme.ts

@@ -53,6 +53,8 @@ const generateComponentTheme = (theme: Theme): NumberInputTheme => {
     color: colors?.textDarkest,
     background: colors?.backgroundLightest,
 
+    requiredInvalidColor: colors?.textDanger,
+
     padding: `0 ${spacing?.small}`,
 
     arrowsContainerWidth: '2rem',

package/tsconfig.build.json

@@ -18,6 +18,7 @@
     { "path": "../ui-form-field/tsconfig.build.json" },
     { "path": "../ui-icons/tsconfig.build.json" },
     { "path": "../ui-react-utils/tsconfig.build.json" },
+    { "path": "../ui-a11y-utils/tsconfig.build.json" },
     { "path": "../ui-testable/tsconfig.build.json" },
     { "path": "../ui-utils/tsconfig.build.json" },
     { "path": "../uid/tsconfig.build.json" }