@instructure/ui-simple-select 8.8.1-snapshot.8 → 8.9.1

package/lib/SimpleSelect/Group/index.js

@@ -1,7 +1,5 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -9,11 +7,7 @@ exports.Group = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
-var _Children = require("@instructure/ui-prop-types/lib/Children.js");
-
-var _Option = require("../Option");
+var _props = require("./props");
 
 /*
  * The MIT License (MIT)
@@ -58,17 +52,8 @@ class Group extends _react.Component {
 exports.Group = Group;
 Group.displayName = "Group";
 Group.componentId = 'SimpleSelect.Group';
-Group.propTypes = {
-  /**
-   * The label associated with the group options.
-   */
-  renderLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]).isRequired,
-
-  /**
-   * Children of type `<SimpleSelect.Option />` that will be considered part of the group.
-   */
-  children: _Children.Children.oneOf([_Option.Option])
-};
+Group.allowedProps = _props.allowedProps;
+Group.propTypes = _props.propTypes;
 Group.defaultProps = {
   children: null
 };

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

@@ -1,3 +1,18 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.allowedProps = exports.propTypes = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _Children = require("@instructure/ui-prop-types/lib/Children.js");
+
+var _Option = require("../Option");
+
 /*
  * The MIT License (MIT)
  *
@@ -21,11 +36,17 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+const propTypes = {
+  /**
+   * The label associated with the group options.
+   */
+  renderLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]).isRequired,
 
-export type SimpleSelectOptionProps = {
-  id: string
-  value: string | number
-  isDisabled?: boolean
-  renderBeforeLabel?: React.ReactNode | ((...args: any[]) => any)
-  renderAfterLabel?: React.ReactNode | ((...args: any[]) => any)
-}
+  /**
+   * Children of type `<SimpleSelect.Option />` that will be considered part of the group.
+   */
+  children: _Children.Children.oneOf([_Option.Option])
+};
+exports.propTypes = propTypes;
+const allowedProps = ['renderLabel', 'children'];
+exports.allowedProps = allowedProps;

package/lib/SimpleSelect/Option/index.js

@@ -1,7 +1,5 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -9,7 +7,7 @@ exports.Option = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
+var _props = require("./props");
 
 /*
  * The MIT License (MIT)
@@ -54,41 +52,10 @@ class Option extends _react.Component {
 exports.Option = Option;
 Option.displayName = "Option";
 Option.componentId = 'SimpleSelect.Option';
-Option.propTypes = {
-  /**
-   * The id for the option.
-   */
-  id: _propTypes.default.string.isRequired,
-
-  /**
-   * The value for the option.
-   */
-  value: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]).isRequired,
-
-  /**
-   * Whether or not this option is disabled.
-   */
-  isDisabled: _propTypes.default.bool,
-
-  /**
-   * Content to display before the option label, such as an icon.
-   */
-  renderBeforeLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * Content to display after the option label, such as an icon.
-   */
-  renderAfterLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * Content to display as the option label.
-   */
-  children: _propTypes.default.string
-};
+Option.allowedProps = _props.allowedProps;
+Option.propTypes = _props.propTypes;
 Option.defaultProps = {
   isDisabled: false,
-  renderBeforeLabel: void 0,
-  renderAfterLabel: void 0,
   children: null
 };
 var _default = Option;

package/lib/SimpleSelect/Option/props.js

@@ -0,0 +1,68 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.allowedProps = exports.propTypes = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+/*
+ * 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 propTypes = {
+  /**
+   * The id for the option.
+   */
+  id: _propTypes.default.string.isRequired,
+
+  /**
+   * The value for the option.
+   */
+  value: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]).isRequired,
+
+  /**
+   * Whether or not this option is disabled.
+   */
+  isDisabled: _propTypes.default.bool,
+
+  /**
+   * Content to display before the option label, such as an icon.
+   */
+  renderBeforeLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * Content to display after the option label, such as an icon.
+   */
+  renderAfterLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * Content to display as the option label.
+   */
+  children: _propTypes.default.string
+};
+exports.propTypes = propTypes;
+const allowedProps = ['id', 'value', 'isDisabled', 'renderBeforeLabel', 'renderAfterLabel', 'children'];
+exports.allowedProps = allowedProps;

package/lib/SimpleSelect/index.js

@@ -13,14 +13,6 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
 
 var _react = _interopRequireWildcard(require("react"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
-var _Children = require("@instructure/ui-prop-types/lib/Children.js");
-
-var _FormPropTypes = require("@instructure/ui-form-field/lib/FormPropTypes.js");
-
-var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.js");
-
 var _testable = require("@instructure/ui-testable/lib/testable.js");
 
 var _matchComponentTypes = require("@instructure/ui-react-utils/lib/matchComponentTypes.js");
@@ -39,6 +31,8 @@ var _Option = require("./Option");
 
 var _Group = require("./Group");
 
+var _props = require("./props");
+
 const _excluded = ["id", "value", "children", "renderBeforeLabel", "renderAfterLabel"],
       _excluded2 = ["id", "renderLabel", "children"],
       _excluded3 = ["renderLabel", "value", "defaultValue", "id", "size", "assistiveText", "placeholder", "interaction", "isRequired", "isInline", "width", "optionsMaxWidth", "visibleOptionsCount", "messages", "placement", "constrain", "mountNode", "inputRef", "listRef", "renderEmptyOption", "renderBeforeInput", "renderAfterInput", "onFocus", "onBlur", "onShowOptions", "onHideOptions", "children"];
@@ -392,182 +386,13 @@ let SimpleSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _cl
     }, (0, _passthroughProps.passthroughProps)(rest)), this.renderChildren(children));
   }
 
-}, _class2.displayName = "SimpleSelect", _class2.componentId = 'SimpleSelect', _class2.Option = _Option.Option, _class2.Group = _Group.Group, _class2.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.string,
-   *   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])
-}, _class2.defaultProps = {
-  value: void 0,
-  defaultValue: void 0,
-  id: void 0,
+}, _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',
-  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/lib/SimpleSelect/props.js

@@ -0,0 +1,208 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.allowedProps = exports.propTypes = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _Children = require("@instructure/ui-prop-types/lib/Children.js");
+
+var _FormPropTypes = require("@instructure/ui-form-field/lib/FormPropTypes.js");
+
+var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.js");
+
+var _Group = require("./Group");
+
+var _Option = require("./Option");
+
+/*
+ * 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 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.string,
+   *   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;
+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'];
+exports.allowedProps = allowedProps;