@instructure/ui-simple-select 8.8.1-snapshot.3 → 8.9.0

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.9.0](https://github.com/instructure/instructure-ui/compare/v8.8.0...v8.9.0) (2021-09-15)
+
+**Note:** Version bump only for package @instructure/ui-simple-select
+
 # [8.8.0](https://github.com/instructure/instructure-ui/compare/v8.7.0...v8.8.0) (2021-08-27)
 
 ### Features

package/es/SimpleSelect/Group/index.js

@@ -22,16 +22,14 @@
  * SOFTWARE.
  */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
-import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types';
-import { Option } from '../Option';
-
+import { allowedProps, propTypes } from './props';
 /**
 ---
 parent: SimpleSelect
 id: SimpleSelect.Group
 ---
 **/
+
 class Group extends Component {
   /* istanbul ignore next */
   render() {
@@ -44,17 +42,8 @@ class Group extends Component {
 
 Group.displayName = "Group";
 Group.componentId = 'SimpleSelect.Group';
-Group.propTypes = {
-  /**
-   * 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])
-};
+Group.allowedProps = allowedProps;
+Group.propTypes = propTypes;
 Group.defaultProps = {
   children: null
 };

package/{src/SimpleSelect/Group/types.ts → es/SimpleSelect/Group/props.js}

@@ -21,7 +21,19 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+import PropTypes from 'prop-types';
+import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types';
+import { Option } from '../Option';
+const propTypes = {
+  /**
+   * The label associated with the group options.
+   */
+  renderLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
 
-export type SimpleSelectGroupProps = {
-  renderLabel: React.ReactNode | ((...args: any[]) => any)
-}
+  /**
+   * Children of type `<SimpleSelect.Option />` that will be considered part of the group.
+   */
+  children: ChildrenPropTypes.oneOf([Option])
+};
+const allowedProps = ['renderLabel', 'children'];
+export { propTypes, allowedProps };

package/es/SimpleSelect/Option/index.js

@@ -22,14 +22,14 @@
  * SOFTWARE.
  */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
-
+import { allowedProps, propTypes } from './props';
 /**
 ---
 parent: SimpleSelect
 id: SimpleSelect.Option
 ---
 **/
+
 class Option extends Component {
   /* istanbul ignore next */
   render() {
@@ -42,41 +42,10 @@ class Option extends Component {
 
 Option.displayName = "Option";
 Option.componentId = 'SimpleSelect.Option';
-Option.propTypes = {
-  /**
-   * The id for the option.
-   */
-  id: PropTypes.string.isRequired,
-
-  /**
-   * The value for the option.
-   */
-  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
-
-  /**
-   * Whether or not this option is disabled.
-   */
-  isDisabled: PropTypes.bool,
-
-  /**
-   * Content to display before the option label, such as an icon.
-   */
-  renderBeforeLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * Content to display after the option label, such as an icon.
-   */
-  renderAfterLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * Content to display as the option label.
-   */
-  children: PropTypes.string
-};
+Option.allowedProps = allowedProps;
+Option.propTypes = propTypes;
 Option.defaultProps = {
   isDisabled: false,
-  renderBeforeLabel: void 0,
-  renderAfterLabel: void 0,
   children: null
 };
 export default Option;

package/es/SimpleSelect/Option/props.js

@@ -0,0 +1,57 @@
+/*
+ * 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 = {
+  /**
+   * The id for the option.
+   */
+  id: PropTypes.string.isRequired,
+
+  /**
+   * The value for the option.
+   */
+  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
+
+  /**
+   * Whether or not this option is disabled.
+   */
+  isDisabled: PropTypes.bool,
+
+  /**
+   * Content to display before the option label, such as an icon.
+   */
+  renderBeforeLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * Content to display after the option label, such as an icon.
+   */
+  renderAfterLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * Content to display as the option label.
+   */
+  children: PropTypes.string
+};
+const allowedProps = ['id', 'value', 'isDisabled', 'renderBeforeLabel', 'renderAfterLabel', 'children'];
+export { propTypes, allowedProps };

package/es/SimpleSelect/index.js

@@ -29,23 +29,20 @@ var _dec, _class, _class2, _temp;
  * SOFTWARE.
  */
 import React, { Component, Children } from 'react';
-import PropTypes from 'prop-types';
-import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types';
-import { FormPropTypes } from '@instructure/ui-form-field';
-import { PositionPropTypes } from '@instructure/ui-position';
 import { testable } from '@instructure/ui-testable';
 import { matchComponentTypes, passthroughProps, callRenderProp, getInteraction } from '@instructure/ui-react-utils';
 import { uid } from '@instructure/uid';
 import { Select } from '@instructure/ui-select';
 import { Option } from './Option';
 import { Group } from './Group';
-
+import { allowedProps, propTypes } from './props';
 /**
 ---
 category: components
 tags: form, field, dropdown
 ---
 **/
+
 let SimpleSelect = (_dec = testable(), _dec(_class = (_temp = _class2 = class SimpleSelect extends Component {
   constructor(props) {
     super(props);
@@ -387,182 +384,13 @@ let SimpleSelect = (_dec = testable(), _dec(_class = (_temp = _class2 = class Si
     }, passthroughProps(rest)), this.renderChildren(children));
   }
 
-}, _class2.displayName = "SimpleSelect", _class2.componentId = 'SimpleSelect', _class2.Option = Option, _class2.Group = Group, _class2.propTypes = {
-  /**
-   * The form field label.
-   */
-  renderLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.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.oneOfType([PropTypes.string, PropTypes.number]),
-
-  /**
-   * The value of the option to select by default, when uncontrolled.
-   */
-  defaultValue: PropTypes.string,
-
-  /**
-   * The id of the text input. One is generated if not supplied.
-   */
-  id: PropTypes.string,
-
-  /**
-   * The size of the text input.
-   */
-  size: PropTypes.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * Additional helpful text to provide to screen readers about the operation
-   * of the component. Provided via aria-describedby.
-   */
-  assistiveText: PropTypes.string,
-
-  /**
-   * Html placeholder text to display when the input has no value. This should
-   * be hint text, not a label replacement.
-   */
-  placeholder: 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']),
-
-  /**
-   * Whether or not the text input is required.
-   */
-  isRequired: PropTypes.bool,
-
-  /**
-   * Whether the input is rendered inline with other elements or if it
-   * is rendered as a block level element.
-   */
-  isInline: PropTypes.bool,
-
-  /**
-   * The width of the text input.
-   */
-  width: PropTypes.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.string,
-
-  /**
-   * The number of options that should be visible before having to scroll.
-   */
-  visibleOptionsCount: PropTypes.number,
-
-  /**
-   * Displays messages and validation for the input. It should be an object
-   * with the following shape:
-   * `{
-   *   text: PropTypes.string,
-   *   type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
-   * }`
-   */
-  messages: PropTypes.arrayOf(FormPropTypes.message),
-
-  /**
-   * The placement of the options list.
-   */
-  placement: PositionPropTypes.placement,
-
-  /**
-   * The parent in which to constrain the placement.
-   */
-  constrain: 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.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.func,
-
-  /**
-   * Callback fired when text input receives focus.
-   */
-  onFocus: PropTypes.func,
-
-  /**
-   * Callback fired when text input loses focus.
-   */
-  onBlur: PropTypes.func,
-
-  /**
-   * Callback fired when the options list is shown.
-   */
-  onShowOptions: PropTypes.func,
-
-  /**
-   * Callback fired when the options list is hidden.
-   */
-  onHideOptions: PropTypes.func,
-
-  /**
-   * A ref to the html `input` element.
-   */
-  inputRef: PropTypes.func,
-
-  /**
-   * A ref to the html `ul` element.
-   */
-  listRef: PropTypes.func,
-
-  /**
-   * Content to display in the list when no options are available.
-   */
-  renderEmptyOption: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * Content to display before the text input. This will commonly be an icon.
-   */
-  renderBeforeInput: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * Content to display after the text input. This content will replace the
-   * default arrow icons.
-   */
-  renderAfterInput: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * Children of type `<SimpleSelect.Option />` or `<SimpleSelect.Group />`.
-   */
-  children: ChildrenPropTypes.oneOf([Group, Option])
-}, _class2.defaultProps = {
-  value: void 0,
-  defaultValue: void 0,
-  id: void 0,
+}, _class2.displayName = "SimpleSelect", _class2.componentId = 'SimpleSelect', _class2.Option = Option, _class2.Group = Group, _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
   size: 'medium',
-  assistiveText: void 0,
   placeholder: null,
-  interaction: void 0,
   isRequired: false,
   isInline: false,
-  width: void 0,
-  optionsMaxWidth: void 0,
   visibleOptionsCount: 8,
-  messages: void 0,
   placement: 'bottom stretch',
-  mountNode: void 0,
   constrain: 'window',
   onChange: (event, data) => {},
   onFocus: event => {},

package/es/SimpleSelect/props.js

@@ -0,0 +1,192 @@
+/*
+ * 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';
+import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types';
+import { FormPropTypes } from '@instructure/ui-form-field';
+import { PositionPropTypes } from '@instructure/ui-position';
+import { Group } from './Group';
+import { Option } from './Option';
+const propTypes = {
+  /**
+   * The form field label.
+   */
+  renderLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.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.oneOfType([PropTypes.string, PropTypes.number]),
+
+  /**
+   * The value of the option to select by default, when uncontrolled.
+   */
+  defaultValue: PropTypes.string,
+
+  /**
+   * The id of the text input. One is generated if not supplied.
+   */
+  id: PropTypes.string,
+
+  /**
+   * The size of the text input.
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+
+  /**
+   * Additional helpful text to provide to screen readers about the operation
+   * of the component. Provided via aria-describedby.
+   */
+  assistiveText: PropTypes.string,
+
+  /**
+   * Html placeholder text to display when the input has no value. This should
+   * be hint text, not a label replacement.
+   */
+  placeholder: 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']),
+
+  /**
+   * Whether or not the text input is required.
+   */
+  isRequired: PropTypes.bool,
+
+  /**
+   * Whether the input is rendered inline with other elements or if it
+   * is rendered as a block level element.
+   */
+  isInline: PropTypes.bool,
+
+  /**
+   * The width of the text input.
+   */
+  width: PropTypes.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.string,
+
+  /**
+   * The number of options that should be visible before having to scroll.
+   */
+  visibleOptionsCount: PropTypes.number,
+
+  /**
+   * Displays messages and validation for the input. It should be an object
+   * with the following shape:
+   * `{
+   *   text: PropTypes.string,
+   *   type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
+   * }`
+   */
+  messages: PropTypes.arrayOf(FormPropTypes.message),
+
+  /**
+   * The placement of the options list.
+   */
+  placement: PositionPropTypes.placement,
+
+  /**
+   * The parent in which to constrain the placement.
+   */
+  constrain: 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.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.func,
+
+  /**
+   * Callback fired when text input receives focus.
+   */
+  onFocus: PropTypes.func,
+
+  /**
+   * Callback fired when text input loses focus.
+   */
+  onBlur: PropTypes.func,
+
+  /**
+   * Callback fired when the options list is shown.
+   */
+  onShowOptions: PropTypes.func,
+
+  /**
+   * Callback fired when the options list is hidden.
+   */
+  onHideOptions: PropTypes.func,
+
+  /**
+   * A ref to the html `input` element.
+   */
+  inputRef: PropTypes.func,
+
+  /**
+   * A ref to the html `ul` element.
+   */
+  listRef: PropTypes.func,
+
+  /**
+   * Content to display in the list when no options are available.
+   */
+  renderEmptyOption: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * Content to display before the text input. This will commonly be an icon.
+   */
+  renderBeforeInput: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * Content to display after the text input. This content will replace the
+   * default arrow icons.
+   */
+  renderAfterInput: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * Children of type `<SimpleSelect.Option />` or `<SimpleSelect.Group />`.
+   */
+  children: ChildrenPropTypes.oneOf([Group, Option])
+};
+const allowedProps = ['renderLabel', 'value', 'defaultValue', 'id', 'size', 'assistiveText', 'placeholder', 'interaction', 'isRequired', 'isInline', 'width', 'optionsMaxWidth', 'visibleOptionsCount', 'messages', 'placement', 'constrain', 'mountNode', 'onChange', 'onFocus', 'onBlur', 'onShowOptions', 'onHideOptions', 'inputRef', 'listRef', 'renderEmptyOption', 'renderBeforeInput', 'renderAfterInput', 'children'];
+export { propTypes, allowedProps };