@instructure/ui-time-select 8.8.1-snapshot.8 → 8.9.0

package/lib/TimeSelect/index.js

@@ -13,10 +13,6 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
 
 var _react = _interopRequireWildcard(require("react"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
-var _I18nPropTypes = require("@instructure/ui-i18n/lib/I18nPropTypes.js");
-
 var _ApplyLocaleContext = require("@instructure/ui-i18n/lib/ApplyLocale/ApplyLocaleContext.js");
 
 var _Locale = require("@instructure/ui-i18n/lib/Locale.js");
@@ -31,24 +27,20 @@ var _localizedFormat = _interopRequireDefault(require("dayjs/plugin/localizedFor
 
 require("./locales");
 
-var _controllable = require("@instructure/ui-prop-types/lib/controllable.js");
-
 var _getInteraction = require("@instructure/ui-react-utils/lib/getInteraction.js");
 
 var _passthroughProps = require("@instructure/ui-react-utils/lib/passthroughProps.js");
 
 var _callRenderProp = require("@instructure/ui-react-utils/lib/callRenderProp.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 _Select = require("@instructure/ui-select/lib/Select");
 
 var _uid = require("@instructure/uid");
 
+var _props = require("./props");
+
 const _excluded = ["value", "defaultValue", "placeholder", "renderLabel", "inputRef", "id", "listRef", "renderBeforeInput", "renderAfterInput", "isRequired", "isInline", "width", "format", "step", "optionsMaxWidth", "visibleOptionsCount", "messages", "placement", "constrain", "onFocus", "onShowOptions", "onHideOptions"];
 
 var _dec, _class, _class2, _temp;
@@ -473,205 +465,13 @@ let TimeSelect = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _clas
     }, (0, _passthroughProps.passthroughProps)(rest)), isShowingOptions && this.renderOptions());
   }
 
-}, _class2.displayName = "TimeSelect", _class2.componentId = 'TimeSelect', _class2.propTypes = {
-  /**
-   * The form field label.
-   */
-  renderLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]).isRequired,
-
-  /**
-   * Whether to default to the first option when `defaultValue` hasn't been specified.
-   */
-  defaultToFirstOption: _propTypes.default.bool,
-
-  /**
-   * An ISO 8601 formatted date string representing the current selected value. If defined,
-   * the component will act controlled and will not manage its own state.
-   */
-  value: (0, _controllable.controllable)(_I18nPropTypes.I18nPropTypes.iso8601, 'onChange'),
-
-  /**
-   * An ISO 8601 formatted date string to use if `value` isn't provided.
-   */
-  defaultValue: _I18nPropTypes.I18nPropTypes.iso8601,
-
-  /**
-   * The id of the text input. One is generated if not supplied.
-   */
-  id: _propTypes.default.string,
-
-  /**
-   * The format to use when displaying the possible and currently selected options.
-   *
-   * See [moment.js formats](https://momentjs.com/docs/#/displaying/format/) for the list of available formats.
-   */
-  format: _propTypes.default.string,
-
-  /**
-   * The number of minutes to increment by when generating the allowable options.
-   */
-  step: _propTypes.default.oneOf([5, 10, 15, 20, 30, 60]),
-
-  /**
-   * 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']),
-
-  /**
-   * Html placeholder text to display when the input has no value. This should
-   * be hint text, not a label replacement.
-   */
-  placeholder: _propTypes.default.string,
-
-  /**
-   * 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,
-
-  /**
-   * 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
-   */
-  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]),
-
-  /* eslint-disable react/require-default-props */
-
-  /**
-   * A standard language identifier.
-   *
-   * See [moment.js i18n](https://momentjs.com/docs/#/i18n/) for more details.
-   *
-   * This property can also be set via a context property and if both are set then the component property takes
-   * precedence over the context property.
-   *
-   * The web browser's locale will be used if no value is set via a component property or a context
-   * property.
-   */
-  locale: _propTypes.default.string,
-
-  /**
-   * A timezone identifier in the format: Area/Location
-   *
-   * See [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the list
-   * of possible options.
-   *
-   * This property can also be set via a context property and if both are set then the component property takes
-   * precedence over the context property.
-   *
-   * The web browser's timezone will be used if no value is set via a component property or a context
-   * property.
-   */
-  timezone: _propTypes.default.string
-  /* eslint-enable react/require-default-props */
-
-}, _class2.defaultProps = {
-  value: void 0,
-  defaultValue: void 0,
+}, _class2.displayName = "TimeSelect", _class2.componentId = 'TimeSelect', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   defaultToFirstOption: false,
-  id: void 0,
   format: 'LT',
   step: 30,
-  interaction: void 0,
-  placeholder: void 0,
   isRequired: false,
   isInline: false,
-  width: void 0,
-  optionsMaxWidth: void 0,
   visibleOptionsCount: 8,
-  messages: void 0,
   placement: 'bottom stretch',
   constrain: 'window',
   onChange: (event, data) => {},

package/lib/TimeSelect/props.js

@@ -0,0 +1,230 @@
+"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 _controllable = require("@instructure/ui-prop-types/lib/controllable.js");
+
+var _I18nPropTypes = require("@instructure/ui-i18n/lib/I18nPropTypes.js");
+
+var _FormPropTypes = require("@instructure/ui-form-field/lib/FormPropTypes.js");
+
+var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.js");
+
+/*
+ * 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,
+
+  /**
+   * Whether to default to the first option when `defaultValue` hasn't been specified.
+   */
+  defaultToFirstOption: _propTypes.default.bool,
+
+  /**
+   * An ISO 8601 formatted date string representing the current selected value. If defined,
+   * the component will act controlled and will not manage its own state.
+   */
+  value: (0, _controllable.controllable)(_I18nPropTypes.I18nPropTypes.iso8601, 'onChange'),
+
+  /**
+   * An ISO 8601 formatted date string to use if `value` isn't provided.
+   */
+  defaultValue: _I18nPropTypes.I18nPropTypes.iso8601,
+
+  /**
+   * The id of the text input. One is generated if not supplied.
+   */
+  id: _propTypes.default.string,
+
+  /**
+   * The format to use when displaying the possible and currently selected options.
+   *
+   * See [moment.js formats](https://momentjs.com/docs/#/displaying/format/) for the list of available formats.
+   */
+  format: _propTypes.default.string,
+
+  /**
+   * The number of minutes to increment by when generating the allowable options.
+   */
+  step: _propTypes.default.oneOf([5, 10, 15, 20, 30, 60]),
+
+  /**
+   * 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']),
+
+  /**
+   * Html placeholder text to display when the input has no value. This should
+   * be hint text, not a label replacement.
+   */
+  placeholder: _propTypes.default.string,
+
+  /**
+   * 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,
+
+  /**
+   * 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
+   */
+  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]),
+
+  /* eslint-disable react/require-default-props */
+
+  /**
+   * A standard language identifier.
+   *
+   * See [moment.js i18n](https://momentjs.com/docs/#/i18n/) for more details.
+   *
+   * This property can also be set via a context property and if both are set then the component property takes
+   * precedence over the context property.
+   *
+   * The web browser's locale will be used if no value is set via a component property or a context
+   * property.
+   */
+  locale: _propTypes.default.string,
+
+  /**
+   * A timezone identifier in the format: Area/Location
+   *
+   * See [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the list
+   * of possible options.
+   *
+   * This property can also be set via a context property and if both are set then the component property takes
+   * precedence over the context property.
+   *
+   * The web browser's timezone will be used if no value is set via a component property or a context
+   * property.
+   */
+  timezone: _propTypes.default.string
+  /* eslint-enable react/require-default-props */
+
+};
+exports.propTypes = propTypes;
+const allowedProps = ['renderLabel', 'defaultToFirstOption', 'value', 'defaultValue', 'id', 'format', 'step', 'interaction', 'placeholder', 'isRequired', 'isInline', 'width', 'optionsMaxWidth', 'visibleOptionsCount', 'messages', 'placement', 'constrain', 'onChange', 'onFocus', 'onBlur', 'onShowOptions', 'onHideOptions', 'inputRef', 'listRef', 'renderEmptyOption', 'renderBeforeInput', 'renderAfterInput', 'locale', 'timezone'];
+exports.allowedProps = allowedProps;