@instructure/ui-select 8.13.1-snapshot.9 → 8.14.1-snapshot.15

package/es/Select/props.js

@@ -28,176 +28,36 @@ 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 to display in the text input.
-   */
   inputValue: PropTypes.string,
-
-  /**
-   * Whether or not to show the options list.
-   */
-  isShowingOptions: PropTypes.bool,
-
-  /**
-   * 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.
-   */
   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 width of the text input, in characters, if a width is not explicitly
-   * provided via the `width` prop. Only applicable if `isInline={true}`.
-   */
-  htmlSize: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-
-  /**
-   * 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.
-   */
+  htmlSize: PropTypes.number,
   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.node,
-   *   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 text input receives focus.
-   */
   onFocus: PropTypes.func,
-
-  /**
-   * Callback fired when text input loses focus.
-   */
   onBlur: PropTypes.func,
-
-  /**
-   * Callback fired when text input value changes.
-   */
   onInputChange: PropTypes.func,
-
-  /**
-   * Callback fired requesting that the options list be shown.
-   */
+  isShowingOptions: PropTypes.bool,
   onRequestShowOptions: PropTypes.func,
-
-  /**
-   * Callback fired requesting that the options list be hidden.
-   */
   onRequestHideOptions: PropTypes.func,
-
-  /**
-   * Callback fired requesting a particular option be highlighted.
-   */
   onRequestHighlightOption: PropTypes.func,
-
-  /**
-   * Callback fired requesting a particular option be selected.
-   */
   onRequestSelectOption: 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 before the text input. This will commonly be an icon or
-   * tags to show multiple selections.
-   */
   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 `<Select.Option />` or `<Select.Group />`.
-   */
   children: ChildrenPropTypes.oneOf([Group, Option]),
-
-  /**
-   * Prevents the default behavior of wrapping the input and rendered content
-   * when available space is exceeded.
-   */
   shouldNotWrap: PropTypes.bool
 };
 const allowedProps = ['renderLabel', 'inputValue', 'isShowingOptions', 'id', 'size', 'assistiveText', 'placeholder', 'interaction', 'isRequired', 'isInline', 'width', 'htmlSize', 'optionsMaxWidth', 'visibleOptionsCount', 'messages', 'placement', 'constrain', 'mountNode', 'onFocus', 'onBlur', 'onInputChange', 'onRequestShowOptions', 'onRequestHideOptions', 'onRequestHighlightOption', 'onRequestSelectOption', 'inputRef', 'listRef', 'renderBeforeInput', 'renderAfterInput', 'children', 'shouldNotWrap'];

package/lib/Select/Group/index.js

@@ -39,6 +39,7 @@ parent: Select
 id: Select.Group
 ---
 @module Group
+@tsProps
 **/
 class Group extends _react.Component {
   /* istanbul ignore next */
@@ -55,8 +56,6 @@ Group.displayName = "Group";
 Group.componentId = 'Select.Group';
 Group.allowedProps = _props.allowedProps;
 Group.propTypes = _props.propTypes;
-Group.defaultProps = {
-  children: null
-};
+Group.defaultProps = {};
 var _default = Group;
 exports.default = _default;

package/lib/Select/Group/props.js

@@ -37,14 +37,7 @@ var _Option = require("../Option");
  * SOFTWARE.
  */
 const 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])
 };
 exports.propTypes = propTypes;

package/lib/Select/Option/index.js

@@ -39,6 +39,7 @@ parent: Select
 id: Select.Option
 ---
 @module Option
+@tsProps
 **/
 class Option extends _react.Component {
   /* istanbul ignore next */
@@ -58,8 +59,7 @@ Option.propTypes = _props.propTypes;
 Option.defaultProps = {
   isHighlighted: false,
   isSelected: false,
-  isDisabled: false,
-  children: null
+  isDisabled: false
 };
 var _default = Option;
 exports.default = _default;

package/lib/Select/Option/props.js

@@ -33,39 +33,12 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
  * SOFTWARE.
  */
 const propTypes = {
-  /**
-   * The id for the option.
-   */
   id: _propTypes.default.string.isRequired,
-
-  /**
-   * Whether or not this option is highlighted.
-   */
   isHighlighted: _propTypes.default.bool,
-
-  /**
-   * Whether or not this option is selected.
-   */
   isSelected: _propTypes.default.bool,
-
-  /**
-   * 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.node
 };
 exports.propTypes = propTypes;

package/lib/Select/SelectLocator.js

@@ -38,8 +38,11 @@ var _index = require("./index");
  */
 
 /* eslint-disable no-restricted-imports */
+// @ts-expect-error ts-migrate(7016) FIXME: Could not find a declaration file for module '@ins... Remove this comment to see the full error message
+// @ts-expect-error ts-migrate(7016) FIXME: Could not find a declaration file for module '@ins... Remove this comment to see the full error message
 
 /* eslint-enable no-restricted-imports */
+// @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 SelectLocator = (0, _locator.locator)(_index.Select.selector, {
   findInput: function () {
     return (0, _locator.locator)('input').find(...arguments);