@instructure/ui-simple-select 8.14.1-snapshot.5 → 8.14.1-snapshot.68

package/lib/SimpleSelect/index.js

@@ -44,12 +44,42 @@ var _dec, _class, _class2, _temp;
 category: components
 tags: form, field, dropdown
 ---
+@tsProps
 **/
 let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _class2 = class SimpleSelect extends _react.Component {
   constructor(props) {
     super(props);
     this.ref = null;
-    this._emptyOptionId = (0, _uid.uid)('Select-EmptyOption');
+    this._emptyOptionId = void 0;
+
+    this.getOption = (field, value) => {
+      let match;
+
+      for (let i = 0; i < this.childrenArray.length; ++i) {
+        const child = this.childrenArray[i];
+
+        if ((0, _matchComponentTypes.matchComponentTypes)(child, [_Option.Option])) {
+          if (child.props[field] === value) {
+            match = child;
+          }
+        } else if ((0, _matchComponentTypes.matchComponentTypes)(child, [_Group.Group])) {
+          const groupChildren = _react.Children.toArray(child.props.children);
+
+          for (let j = 0; j < groupChildren.length; ++j) {
+            const groupChild = groupChildren[j];
+
+            if (groupChild.props[field] === value) {
+              match = groupChild;
+              break;
+            }
+          }
+        }
+
+        if (match) break;
+      }
+
+      return match;
+    };
 
     this.handleRef = node => {
       this.ref = node;
@@ -57,16 +87,22 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
 
     this.handleBlur = event => {
       this.setState({
-        highlightedOptionId: null
+        highlightedOptionId: void 0
       });
-      this.props.onBlur(event);
+
+      if (typeof this.props.onBlur === 'function') {
+        this.props.onBlur(event);
+      }
     };
 
     this.handleShowOptions = event => {
       this.setState({
         isShowingOptions: true
       });
-      this.props.onShowOptions(event);
+
+      if (typeof this.props.onShowOptions === 'function') {
+        this.props.onShowOptions(event);
+      }
     };
 
     this.handleHideOptions = event => {
@@ -74,18 +110,21 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
         const option = this.getOption('id', state.selectedOptionId);
         return {
           isShowingOptions: false,
-          highlightedOptionId: null,
+          highlightedOptionId: void 0,
           inputValue: option ? option.props.children : ''
         };
       });
-      this.props.onHideOptions(event);
+
+      if (typeof this.props.onHideOptions === 'function') {
+        this.props.onHideOptions(event);
+      }
     };
 
     this.handleHighlightOption = (event, _ref) => {
       let id = _ref.id;
       if (id === this._emptyOptionId) return;
       const option = this.getOption('id', id);
-      const label = option.props.children;
+      const label = option === null || option === void 0 ? void 0 : option.props.children;
       const inputValue = event.type === 'keydown' ? label : this.state.inputValue;
       this.setState({
         highlightedOptionId: id,
@@ -120,12 +159,17 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
       } // fire onChange if selected option changed
 
 
-      option && this.props.onChange(event, {
-        value,
-        id
-      }); // hide options list whenever selection is made
+      if (option && typeof this.props.onChange === 'function') {
+        this.props.onChange(event, {
+          value,
+          id
+        });
+      } // hide options list whenever selection is made
 
-      this.props.onHideOptions(event);
+
+      if (typeof this.props.onHideOptions === 'function') {
+        this.props.onHideOptions(event);
+      }
     };
 
     const _option = this.getInitialOption(props);
@@ -133,25 +177,30 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
     this.state = {
       inputValue: _option ? _option.props.children : '',
       isShowingOptions: false,
-      highlightedOptionId: null,
-      selectedOptionId: _option ? _option.props.id : null
+      highlightedOptionId: void 0,
+      selectedOptionId: _option ? _option.props.id : void 0
     };
+    this._emptyOptionId = (0, _uid.uid)('Select-EmptyOption');
   }
 
   get _select() {
     return this.ref;
   }
 
+  get childrenArray() {
+    return _react.Children.toArray(this.props.children);
+  }
+
   focus() {
     this.ref && this.ref.focus();
   }
 
   get focused() {
-    return this.ref && this.ref.focused;
+    return this.ref ? this.ref.focused : false;
   }
 
   get id() {
-    return this.ref && this.ref.id;
+    return this.ref ? this.ref.id : void 0;
   }
 
   get isControlled() {
@@ -191,7 +240,7 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
     } // otherwise get the first option
 
 
-    return this.getOptionByIndex(0);
+    return this.getFirstOption();
   }
 
   getOptionLabelById(id) {
@@ -199,13 +248,11 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
     return option ? option.props.children : '';
   }
 
-  getOptionByIndex(index) {
-    const children = _react.Children.toArray(this.props.children);
+  getFirstOption() {
+    let match;
 
-    let match = null;
-
-    for (let i = 0; i < children.length; i++) {
-      const child = children[i];
+    for (let i = 0; i < this.childrenArray.length; i++) {
+      const child = this.childrenArray[i];
 
       if ((0, _matchComponentTypes.matchComponentTypes)(child, [_Option.Option])) {
         match = child;
@@ -222,41 +269,8 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
     return match;
   }
 
-  getOption(field, value) {
-    const children = _react.Children.toArray(this.props.children);
-
-    let match = null;
-
-    for (let i = 0; i < children.length; ++i) {
-      const child = children[i];
-
-      if ((0, _matchComponentTypes.matchComponentTypes)(child, [_Option.Option])) {
-        if (child.props[field] === value) {
-          match = child;
-        }
-      } else if ((0, _matchComponentTypes.matchComponentTypes)(child, [_Group.Group])) {
-        const groupChildren = _react.Children.toArray(child.props.children);
-
-        for (let j = 0; j < groupChildren.length; ++j) {
-          const groupChild = groupChildren[j];
-
-          if (groupChild.props[field] === value) {
-            match = groupChild;
-            break;
-          }
-        }
-      }
-
-      if (match) break;
-    }
-
-    return match;
-  }
-
   renderChildren() {
-    let children = _react.Children.toArray(this.props.children);
-
-    children = _react.Children.map(children, child => {
+    const children = _react.Children.map(this.childrenArray, child => {
       if ((0, _matchComponentTypes.matchComponentTypes)(child, [_Option.Option])) {
         return this.renderOption(child);
       } else if ((0, _matchComponentTypes.matchComponentTypes)(child, [_Group.Group])) {
@@ -387,28 +401,17 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
       onRequestHideOptions: this.handleHideOptions,
       onRequestHighlightOption: this.handleHighlightOption,
       onRequestSelectOption: this.handleSelectOption
-    }, (0, _passthroughProps.passthroughProps)(rest)), this.renderChildren(children));
+    }, (0, _passthroughProps.passthroughProps)(rest)), this.renderChildren());
   }
 
 }, _class2.displayName = "SimpleSelect", _class2.componentId = 'SimpleSelect', _class2.Option = _Option.Option, _class2.Group = _Group.Group, _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   size: 'medium',
-  placeholder: null,
   isRequired: false,
   isInline: false,
   visibleOptionsCount: 8,
   placement: 'bottom stretch',
   constrain: 'window',
-  onChange: (event, data) => {},
-  onFocus: event => {},
-  onBlur: event => {},
-  onShowOptions: event => {},
-  onHideOptions: event => {},
-  inputRef: node => {},
-  listRef: node => {},
-  renderEmptyOption: '---',
-  renderBeforeInput: null,
-  renderAfterInput: null,
-  children: null
+  renderEmptyOption: '---'
 }, _temp)) || _class);
 exports.SimpleSelect = SimpleSelect;
 var _default = SimpleSelect;

package/lib/SimpleSelect/props.js

@@ -43,164 +43,34 @@ var _Option = require("./Option");
  * SOFTWARE.
  */
 const propTypes = {
-  /**
-   * The form field label.
-   */
   renderLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]).isRequired,
-
-  /**
-   * The value corresponding to the value of the selected option. If defined,
-   * the component will act controlled and will not manage its own state.
-   */
   // TODO: it was using the "controllable" util, in the TS migration mimic that behaviour
   value: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-
-  /**
-   * The value of the option to select by default, when uncontrolled.
-   */
   defaultValue: _propTypes.default.string,
-
-  /**
-   * The id of the text input. One is generated if not supplied.
-   */
   id: _propTypes.default.string,
-
-  /**
-   * The size of the text input.
-   */
   size: _propTypes.default.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * Additional helpful text to provide to screen readers about the operation
-   * of the component. Provided via aria-describedby.
-   */
   assistiveText: _propTypes.default.string,
-
-  /**
-   * Html placeholder text to display when the input has no value. This should
-   * be hint text, not a label replacement.
-   */
   placeholder: _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']),
-
-  /**
-   * Whether or not the text input is required.
-   */
   isRequired: _propTypes.default.bool,
-
-  /**
-   * Whether the input is rendered inline with other elements or if it
-   * is rendered as a block level element.
-   */
   isInline: _propTypes.default.bool,
-
-  /**
-   * The width of the text input.
-   */
   width: _propTypes.default.string,
-
-  /**
-   * The max width the options list can be before option text wraps. If not
-   * set, the list will only display as wide as the text input.
-   */
   optionsMaxWidth: _propTypes.default.string,
-
-  /**
-   * The number of options that should be visible before having to scroll.
-   */
   visibleOptionsCount: _propTypes.default.number,
-
-  /**
-   * Displays messages and validation for the input. It should be an object
-   * with the following shape:
-   * `{
-   *   text: PropTypes.node,
-   *   type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
-   * }`
-   */
   messages: _propTypes.default.arrayOf(_FormPropTypes.FormPropTypes.message),
-
-  /**
-   * The placement of the options list.
-   */
   placement: _PositionPropTypes.PositionPropTypes.placement,
-
-  /**
-   * The parent in which to constrain the placement.
-   */
   constrain: _PositionPropTypes.PositionPropTypes.constrain,
-
-  /**
-   * An element or a function returning an element to use mount the options
-   * list to in the DOM (defaults to `document.body`)
-   */
   mountNode: _PositionPropTypes.PositionPropTypes.mountNode,
-
-  /**
-   * Callback fired when a new option is selected.
-   * @param {Object} event - the event object
-   * @param {Object} data - additional data
-   * @param data.value - the value of selected option
-   * @param data.id - the id of the selected option
-   */
   onChange: _propTypes.default.func,
-
-  /**
-   * Callback fired when text input receives focus.
-   */
   onFocus: _propTypes.default.func,
-
-  /**
-   * Callback fired when text input loses focus.
-   */
   onBlur: _propTypes.default.func,
-
-  /**
-   * Callback fired when the options list is shown.
-   */
   onShowOptions: _propTypes.default.func,
-
-  /**
-   * Callback fired when the options list is hidden.
-   */
   onHideOptions: _propTypes.default.func,
-
-  /**
-   * A ref to the html `input` element.
-   */
   inputRef: _propTypes.default.func,
-
-  /**
-   * A ref to the html `ul` element.
-   */
   listRef: _propTypes.default.func,
-
-  /**
-   * Content to display in the list when no options are available.
-   */
   renderEmptyOption: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * Content to display before the text input. This will commonly be an icon.
-   */
   renderBeforeInput: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * Content to display after the text input. This content will replace the
-   * default arrow icons.
-   */
   renderAfterInput: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * Children of type `<SimpleSelect.Option />` or `<SimpleSelect.Group />`.
-   */
   children: _Children.Children.oneOf([_Group.Group, _Option.Option])
 };
 exports.propTypes = propTypes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-simple-select",
-  "version": "8.14.1-snapshot.5+63bca0bc9",
+  "version": "8.14.1-snapshot.68+a2cfa0cd8",
   "description": "A component for standard select element behavior.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -25,22 +25,22 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-form-field": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-position": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-prop-types": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-react-utils": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-select": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-testable": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/uid": "8.14.1-snapshot.5+63bca0bc9",
+    "@instructure/console": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-form-field": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-position": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-prop-types": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-react-utils": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-select": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-testable": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/uid": "8.14.1-snapshot.68+a2cfa0cd8",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-color-utils": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-icons": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-test-locator": "8.14.1-snapshot.5+63bca0bc9",
-    "@instructure/ui-test-utils": "8.14.1-snapshot.5+63bca0bc9"
+    "@instructure/ui-babel-preset": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-color-utils": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-icons": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-test-locator": "8.14.1-snapshot.68+a2cfa0cd8",
+    "@instructure/ui-test-utils": "8.14.1-snapshot.68+a2cfa0cd8"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -49,5 +49,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "63bca0bc94ad7c10cdba1f7a88a9755ab74208d6"
+  "gitHead": "a2cfa0cd8bf43d6072f1b352bbd6e43542081be8"
 }

package/src/SimpleSelect/Group/index.tsx

@@ -32,15 +32,14 @@ import { allowedProps, propTypes } from './props'
 parent: SimpleSelect
 id: SimpleSelect.Group
 ---
+@tsProps
 **/
 class Group extends Component<SimpleSelectGroupProps> {
   static readonly componentId = 'SimpleSelect.Group'
+
   static allowedProps = allowedProps
   static propTypes = propTypes
-
-  static defaultProps = {
-    children: null
-  }
+  static defaultProps = {}
 
   /* istanbul ignore next */
   render() {

package/src/SimpleSelect/Group/props.ts

@@ -21,6 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 import React from 'react'
 import PropTypes from 'prop-types'
 
@@ -34,9 +35,16 @@ import type {
 } from '@instructure/shared-types'
 
 type SimpleSelectGroupOwnProps = {
-  renderLabel: React.ReactNode | ((...args: any[]) => any)
-  children?: React.ReactNode
+  /**
+   * The label associated with the group options.
+   */
+  renderLabel: React.ReactNode | (() => React.ReactNode)
+  /**
+   * Children of type `<SimpleSelect.Option />` that will be considered part of the group.
+   */
+  children?: React.ReactNode // TODO: ChildrenPropTypes.oneOf([Option])
 }
+
 type PropKeys = keyof SimpleSelectGroupOwnProps
 
 type AllowedPropKeys = Readonly<Array<PropKeys>>
@@ -45,13 +53,7 @@ type SimpleSelectGroupProps = SimpleSelectGroupOwnProps &
   OtherHTMLAttributes<SimpleSelectGroupOwnProps>
 
 const propTypes: PropValidators<PropKeys> = {
-  /**
-   * The label associated with the group options.
-   */
   renderLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
-  /**
-   * Children of type `<SimpleSelect.Option />` that will be considered part of the group.
-   */
   children: ChildrenPropTypes.oneOf([Option])
 }
 

package/src/SimpleSelect/Option/index.tsx

@@ -31,6 +31,7 @@ import { allowedProps, propTypes } from './props'
 parent: SimpleSelect
 id: SimpleSelect.Option
 ---
+@tsProps
 **/
 class Option extends Component<SimpleSelectOptionProps> {
   static readonly componentId = 'SimpleSelect.Option'
@@ -38,8 +39,7 @@ class Option extends Component<SimpleSelectOptionProps> {
   static allowedProps = allowedProps
   static propTypes = propTypes
   static defaultProps = {
-    isDisabled: false,
-    children: null
+    isDisabled: false
   }
 
   /* istanbul ignore next */

package/src/SimpleSelect/Option/props.ts

@@ -21,6 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 import React from 'react'
 import PropTypes from 'prop-types'
 
@@ -29,45 +30,58 @@ import type {
   PropValidators
 } from '@instructure/shared-types'
 
-type SimpleSelectOptionOwnProps = {
-  id: string
-  value: string | number
-  isDisabled?: boolean
-  renderBeforeLabel?: React.ReactNode | ((...args: any[]) => any)
-  renderAfterLabel?: React.ReactNode | ((...args: any[]) => any)
-  children?: React.ReactNode
+type OptionProps = {
+  id: SimpleSelectOptionOwnProps['id']
+  isDisabled: SimpleSelectOptionOwnProps['isDisabled']
+  isSelected: boolean
+  isHighlighted: boolean
+  children: SimpleSelectOptionOwnProps['children']
 }
-type PropKeys = keyof SimpleSelectOptionOwnProps
-
-type AllowedPropKeys = Readonly<Array<PropKeys>>
 
-type SimpleSelectOptionProps = SimpleSelectOptionOwnProps &
-  OtherHTMLAttributes<SimpleSelectOptionOwnProps>
+type RenderSimpleSelectOptionLabel =
+  | React.ReactNode
+  | ((args: OptionProps) => React.ReactNode)
 
-const propTypes: PropValidators<PropKeys> = {
+type SimpleSelectOptionOwnProps = {
   /**
    * The id for the option.
    */
-  id: PropTypes.string.isRequired,
+  id: string
   /**
    * The value for the option.
    */
-  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
+  value: string | number
   /**
    * Whether or not this option is disabled.
    */
-  isDisabled: PropTypes.bool,
+  isDisabled?: boolean
+  /**
+   * Content to display as the option label.
+   */
+  children?: string
   /**
    * Content to display before the option label, such as an icon.
    */
-  renderBeforeLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+  renderBeforeLabel?: RenderSimpleSelectOptionLabel
   /**
    * Content to display after the option label, such as an icon.
    */
+  renderAfterLabel?: RenderSimpleSelectOptionLabel
+}
+
+type PropKeys = keyof SimpleSelectOptionOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type SimpleSelectOptionProps = SimpleSelectOptionOwnProps &
+  OtherHTMLAttributes<SimpleSelectOptionOwnProps>
+
+const propTypes: PropValidators<PropKeys> = {
+  id: PropTypes.string.isRequired,
+  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
+  isDisabled: PropTypes.bool,
+  renderBeforeLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
   renderAfterLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-  /**
-   * Content to display as the option label.
-   */
   children: PropTypes.string
 }
 
@@ -80,5 +94,5 @@ const allowedProps: AllowedPropKeys = [
   'children'
 ]
 
-export type { SimpleSelectOptionProps }
+export type { SimpleSelectOptionProps, RenderSimpleSelectOptionLabel }
 export { propTypes, allowedProps }

package/src/SimpleSelect/__examples__/SimpleSelect.examples.tsx

@@ -23,8 +23,12 @@
  */
 
 import React from 'react'
+
 import { SimpleSelect } from '../../SimpleSelect'
 
+import type { StoryConfig } from '@instructure/ui-test-utils'
+import type { SimpleSelectProps } from '../props'
+
 export default {
   sectionProp: 'size',
   maxExamplesPerPage: 50,
@@ -64,19 +68,17 @@ export default {
       ]
     ]
   },
-  // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'props' implicitly has an 'any' type.
-  getComponentProps: (props) => {
+  getComponentProps: () => {
     return {
-      inputValue: !props.isEditable ? 'Option one' : '',
+      inputValue: 'Option one',
       renderLabel: 'Choose an option',
       constrain: 'scroll-parent'
     }
   },
-  // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'props' implicitly has an 'any' type.
   filter: (props) => {
     if (props.interaction === 'readonly') return true
     if (props.isRequired) return true
 
     return false
   }
-}
+} as StoryConfig<SimpleSelectProps>