@instructure/ui-date-input 8.18.1-snapshot.2 → 8.19.1-snapshot.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.19.0](https://github.com/instructure/instructure-ui/compare/v8.18.0...v8.19.0) (2022-03-16)
+
+**Note:** Version bump only for package @instructure/ui-date-input
+
 # [8.18.0](https://github.com/instructure/instructure-ui/compare/v8.17.0...v8.18.0) (2022-02-23)
 
 **Note:** Version bump only for package @instructure/ui-date-input

package/es/DateInput/index.js

@@ -29,7 +29,7 @@ var _dec, _dec2, _class, _class2, _temp, _IconCalendarMonthLin;
  */
 
 /** @jsx jsx */
-import { Children, Component } from 'react';
+import React, { Children, Component } from 'react';
 import { Calendar } from '@instructure/ui-calendar';
 import { IconCalendarMonthLine } from '@instructure/ui-icons';
 import { Popover } from '@instructure/ui-popover';
@@ -46,6 +46,9 @@ import { propTypes, allowedProps } from './props';
 ---
 category: components
 ---
+The `DateInput` component provides a visual interface for inputting date data.
+See <https://instructure.design/#DateInput/>
+@tsProps
 **/
 let DateInput = (_dec = withStyle(generateStyle, null), _dec2 = testable(), _dec(_class = _dec2(_class = (_temp = _class2 = class DateInput extends Component {
   constructor() {
@@ -67,74 +70,76 @@ let DateInput = (_dec = withStyle(generateStyle, null), _dec2 = testable(), _dec
     };
 
     this.handleInputRef = el => {
-      const inputRef = this.props.inputRef;
-      const hasInputRef = this.state.hasInputRef; // Ensures that we position the Calendar with respect to the input correctly
-      // if the Calendar is open on mount
+      var _this$props$inputRef, _this$props;
 
-      if (!hasInputRef) {
+      // Ensures that we position the Calendar with respect to the input correctly
+      // if the Calendar is open on mount
+      if (!this.state.hasInputRef) {
         this.setState({
           hasInputRef: true
         });
       }
 
       this._input = el;
-      inputRef(el);
+      (_this$props$inputRef = (_this$props = this.props).inputRef) === null || _this$props$inputRef === void 0 ? void 0 : _this$props$inputRef.call(_this$props, el);
     };
 
     this.handleInputChange = (event, value) => {
-      const onChange = this.props.onChange;
-      onChange(event, {
+      var _this$props$onChange, _this$props2;
+
+      (_this$props$onChange = (_this$props2 = this.props).onChange) === null || _this$props$onChange === void 0 ? void 0 : _this$props$onChange.call(_this$props2, event, {
         value
       });
       this.handleShowCalendar(event);
     };
 
     this.handleShowCalendar = event => {
-      const onRequestShowCalendar = this.props.onRequestShowCalendar;
-      const interaction = this.interaction;
+      if (this.interaction === 'enabled') {
+        var _this$props$onRequest, _this$props3;
 
-      if (interaction === 'enabled') {
-        onRequestShowCalendar(event);
+        (_this$props$onRequest = (_this$props3 = this.props).onRequestShowCalendar) === null || _this$props$onRequest === void 0 ? void 0 : _this$props$onRequest.call(_this$props3, event);
       }
     };
 
     this.handleHideCalendar = event => {
-      const _this$props = this.props,
-            onRequestHideCalendar = _this$props.onRequestHideCalendar,
-            onRequestValidateDate = _this$props.onRequestValidateDate;
-      onRequestValidateDate(event);
-      onRequestHideCalendar(event);
+      var _this$props$onRequest2, _this$props4, _this$props$onRequest3, _this$props5;
+
+      (_this$props$onRequest2 = (_this$props4 = this.props).onRequestValidateDate) === null || _this$props$onRequest2 === void 0 ? void 0 : _this$props$onRequest2.call(_this$props4, event);
+      (_this$props$onRequest3 = (_this$props5 = this.props).onRequestHideCalendar) === null || _this$props$onRequest3 === void 0 ? void 0 : _this$props$onRequest3.call(_this$props5, event);
     };
 
     this.handleHighlightOption = (event, _ref) => {
       let direction = _ref.direction;
-      const _this$props2 = this.props,
-            onRequestSelectNextDay = _this$props2.onRequestSelectNextDay,
-            onRequestSelectPrevDay = _this$props2.onRequestSelectPrevDay;
-      if (direction === -1) onRequestSelectPrevDay(event);
-      if (direction === 1) onRequestSelectNextDay(event);
+      const _this$props6 = this.props,
+            onRequestSelectNextDay = _this$props6.onRequestSelectNextDay,
+            onRequestSelectPrevDay = _this$props6.onRequestSelectPrevDay;
+      if (direction === -1) onRequestSelectPrevDay === null || onRequestSelectPrevDay === void 0 ? void 0 : onRequestSelectPrevDay(event);
+      if (direction === 1) onRequestSelectNextDay === null || onRequestSelectNextDay === void 0 ? void 0 : onRequestSelectNextDay(event);
     };
   }
 
   componentDidMount() {
-    var _this$props$makeStyle, _this$props3;
+    var _this$props$makeStyle, _this$props7;
 
-    (_this$props$makeStyle = (_this$props3 = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props3);
+    (_this$props$makeStyle = (_this$props7 = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props7);
   }
 
   componentDidUpdate() {
-    var _this$props$makeStyle2, _this$props4;
+    var _this$props$makeStyle2, _this$props8;
 
-    (_this$props$makeStyle2 = (_this$props4 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props4);
+    (_this$props$makeStyle2 = (_this$props8 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props8);
   }
 
   get selectedDateId() {
     let selectedDateId;
     Children.toArray(this.props.children).forEach(day => {
-      const _day$props = day.props,
-            date = _day$props.date,
-            isSelected = _day$props.isSelected;
-      if (isSelected) selectedDateId = this.formatDateId(date);
+      const _props = day.props,
+            date = _props.date,
+            isSelected = _props.isSelected;
+
+      if (isSelected) {
+        selectedDateId = this.formatDateId(date);
+      }
     });
     return selectedDateId;
   }
@@ -147,43 +152,42 @@ let DateInput = (_dec = withStyle(generateStyle, null), _dec2 = testable(), _dec
 
   renderMonthNavigationButton() {
     let type = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : 'prev';
-    const _this$props5 = this.props,
-          renderPrevMonthButton = _this$props5.renderPrevMonthButton,
-          renderNextMonthButton = _this$props5.renderNextMonthButton;
+    const _this$props9 = this.props,
+          renderPrevMonthButton = _this$props9.renderPrevMonthButton,
+          renderNextMonthButton = _this$props9.renderNextMonthButton;
     const button = type === 'prev' ? renderPrevMonthButton : renderNextMonthButton;
     return button && safeCloneElement(callRenderProp(button), {
       tabIndex: -1
     });
   }
 
-  renderDays(_ref2) {
-    let getOptionProps = _ref2.getOptionProps;
+  renderDays(getOptionProps) {
     const children = this.props.children;
     return Children.map(children, day => {
-      const _day$props2 = day.props,
-            date = _day$props2.date,
-            isOutsideMonth = _day$props2.isOutsideMonth;
-      let props = {
+      const _day$props = day.props,
+            date = _day$props.date,
+            isOutsideMonth = _day$props.isOutsideMonth;
+      const props = {
         tabIndex: -1,
         id: this.formatDateId(date)
       };
       const optionProps = getOptionProps(props);
-      props = isOutsideMonth ? { ...props,
+      const propsAdded = isOutsideMonth ? { ...props,
         onClick: optionProps.onClick,
         role: 'presentation'
       } : optionProps;
-      return safeCloneElement(day, props);
+      return safeCloneElement(day, propsAdded);
     });
   }
 
-  renderCalendar(_ref3) {
-    let getListProps = _ref3.getListProps,
-        getOptionProps = _ref3.getOptionProps;
-    const _this$props6 = this.props,
-          onRequestRenderNextMonth = _this$props6.onRequestRenderNextMonth,
-          onRequestRenderPrevMonth = _this$props6.onRequestRenderPrevMonth,
-          renderNavigationLabel = _this$props6.renderNavigationLabel,
-          renderWeekdayLabels = _this$props6.renderWeekdayLabels;
+  renderCalendar(_ref2) {
+    let getListProps = _ref2.getListProps,
+        getOptionProps = _ref2.getOptionProps;
+    const _this$props10 = this.props,
+          onRequestRenderNextMonth = _this$props10.onRequestRenderNextMonth,
+          onRequestRenderPrevMonth = _this$props10.onRequestRenderPrevMonth,
+          renderNavigationLabel = _this$props10.renderNavigationLabel,
+          renderWeekdayLabels = _this$props10.renderWeekdayLabels;
     return jsx(Calendar, getListProps({
       onRequestRenderNextMonth,
       onRequestRenderPrevMonth,
@@ -191,34 +195,32 @@ let DateInput = (_dec = withStyle(generateStyle, null), _dec2 = testable(), _dec
       renderWeekdayLabels,
       renderNextMonthButton: this.renderMonthNavigationButton('next'),
       renderPrevMonthButton: this.renderMonthNavigationButton('prev')
-    }), this.renderDays({
-      getOptionProps
-    }));
+    }), this.renderDays(getOptionProps));
   }
 
-  renderInput(_ref4) {
-    let getInputProps = _ref4.getInputProps,
-        getTriggerProps = _ref4.getTriggerProps;
-
-    const _this$props7 = this.props,
-          renderLabel = _this$props7.renderLabel,
-          value = _this$props7.value,
-          placeholder = _this$props7.placeholder,
-          onBlur = _this$props7.onBlur,
-          isRequired = _this$props7.isRequired,
-          size = _this$props7.size,
-          isInline = _this$props7.isInline,
-          layout = _this$props7.layout,
-          width = _this$props7.width,
-          messages = _this$props7.messages,
-          onRequestValidateDate = _this$props7.onRequestValidateDate,
-          onRequestShowCalendar = _this$props7.onRequestShowCalendar,
-          onRequestHideCalendar = _this$props7.onRequestHideCalendar,
-          onRequestSelectNextDay = _this$props7.onRequestSelectNextDay,
-          onRequestSelectPrevDay = _this$props7.onRequestSelectPrevDay,
-          onRequestRenderNextMonth = _this$props7.onRequestRenderNextMonth,
-          onRequestRenderPrevMonth = _this$props7.onRequestRenderPrevMonth,
-          rest = _objectWithoutProperties(_this$props7, _excluded);
+  renderInput(_ref3) {
+    let getInputProps = _ref3.getInputProps,
+        getTriggerProps = _ref3.getTriggerProps;
+
+    const _this$props11 = this.props,
+          renderLabel = _this$props11.renderLabel,
+          value = _this$props11.value,
+          placeholder = _this$props11.placeholder,
+          onBlur = _this$props11.onBlur,
+          isRequired = _this$props11.isRequired,
+          size = _this$props11.size,
+          isInline = _this$props11.isInline,
+          layout = _this$props11.layout,
+          width = _this$props11.width,
+          messages = _this$props11.messages,
+          onRequestValidateDate = _this$props11.onRequestValidateDate,
+          onRequestShowCalendar = _this$props11.onRequestShowCalendar,
+          onRequestHideCalendar = _this$props11.onRequestHideCalendar,
+          onRequestSelectNextDay = _this$props11.onRequestSelectNextDay,
+          onRequestSelectPrevDay = _this$props11.onRequestSelectPrevDay,
+          onRequestRenderNextMonth = _this$props11.onRequestRenderNextMonth,
+          onRequestRenderPrevMonth = _this$props11.onRequestRenderPrevMonth,
+          rest = _objectWithoutProperties(_this$props11, _excluded);
 
     const interaction = this.interaction;
 
@@ -249,27 +251,26 @@ let DateInput = (_dec = withStyle(generateStyle, null), _dec2 = testable(), _dec
   }
 
   render() {
-    const _this$props8 = this.props,
-          placement = _this$props8.placement,
-          isShowingCalendar = _this$props8.isShowingCalendar,
-          assistiveText = _this$props8.assistiveText,
-          styles = _this$props8.styles;
-    const selectedDateId = this.selectedDateId;
+    const _this$props12 = this.props,
+          placement = _this$props12.placement,
+          isShowingCalendar = _this$props12.isShowingCalendar,
+          assistiveText = _this$props12.assistiveText,
+          styles = _this$props12.styles;
     return jsx(Selectable, {
       isShowingOptions: isShowingCalendar,
       onRequestShowOptions: this.handleShowCalendar,
       onRequestHideOptions: this.handleHideCalendar,
       onRequestHighlightOption: this.handleHighlightOption,
       onRequestSelectOption: this.handleHideCalendar,
-      selectedOptionId: selectedDateId,
-      highlightedOptionId: selectedDateId
-    }, _ref5 => {
-      let getRootProps = _ref5.getRootProps,
-          getInputProps = _ref5.getInputProps,
-          getTriggerProps = _ref5.getTriggerProps,
-          getListProps = _ref5.getListProps,
-          getOptionProps = _ref5.getOptionProps,
-          getDescriptionProps = _ref5.getDescriptionProps;
+      selectedOptionId: this.selectedDateId,
+      highlightedOptionId: this.selectedDateId
+    }, _ref4 => {
+      let getRootProps = _ref4.getRootProps,
+          getInputProps = _ref4.getInputProps,
+          getTriggerProps = _ref4.getTriggerProps,
+          getListProps = _ref4.getListProps,
+          getOptionProps = _ref4.getOptionProps,
+          getDescriptionProps = _ref4.getDescriptionProps;
       return jsx("span", getRootProps({
         css: styles === null || styles === void 0 ? void 0 : styles.dateInput
       }), this.renderInput({
@@ -293,29 +294,14 @@ let DateInput = (_dec = withStyle(generateStyle, null), _dec2 = testable(), _dec
 }, _class2.displayName = "DateInput", _class2.componentId = 'DateInput', _class2.Day = Calendar.Day, _class2.propTypes = propTypes, _class2.allowedProps = allowedProps, _class2.defaultProps = {
   value: '',
   size: 'medium',
-  placeholder: null,
-  onChange: event => {},
-  onBlur: event => {},
-  // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
+  onBlur: () => {},
+  // must have a default so createChainedFunction works
   isRequired: false,
   isInline: false,
   layout: 'stacked',
-  width: null,
   display: 'inline-block',
-  inputRef: el => {},
   placement: 'bottom center',
-  isShowingCalendar: false,
-  onRequestValidateDate: event => {},
-  onRequestShowCalendar: event => {},
-  onRequestHideCalendar: event => {},
-  onRequestSelectNextDay: event => {},
-  onRequestSelectPrevDay: event => {},
-  onRequestRenderNextMonth: event => {},
-  onRequestRenderPrevMonth: event => {},
-  renderNavigationLabel: null,
-  renderNextMonthButton: null,
-  renderPrevMonthButton: null,
-  children: null
+  isShowingCalendar: false
 }, _temp)) || _class) || _class);
 export default DateInput;
 export { DateInput };

package/es/DateInput/props.js

@@ -27,182 +27,34 @@ import { FormPropTypes } from '@instructure/ui-form-field';
 import { PositionPropTypes } from '@instructure/ui-position';
 import { Calendar } from '@instructure/ui-calendar';
 const propTypes = {
-  /**
-   * Specifies the input label.
-   */
   renderLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
-
-  /**
-   * Specifies the input value.
-   */
   value: controllable(PropTypes.string),
-
-  /**
-   * Specifies the input size.
-   */
   size: PropTypes.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * Html placeholder text to display when the input has no value. This should
-   * be hint text, not a label replacement.
-   */
   placeholder: PropTypes.string,
-
-  /**
-   * Callback executed when the input fires a change event.
-   * @param {Object} event - the event object
-   * @param {Object} data - additional data
-   * @param data.value - the new value
-   */
   onChange: PropTypes.func,
-
-  /**
-   * Callback executed when the input fires a blur event.
-   */
   onBlur: PropTypes.func,
-
-  /**
-   * 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']),
-
-  /**
-   * Specifies if the input is required.
-   */
   isRequired: PropTypes.bool,
-
-  /**
-   * Controls whether the input is rendered inline with other elements or if it
-   * is rendered as a block level element.
-   */
   isInline: PropTypes.bool,
-
-  /**
-   * Additional helpful text to provide to screen readers about the operation
-   * of the component.
-   */
   assistiveText: PropTypes.string,
-
-  /**
-   * Controls the layout. When set to `stacked`, the label rests on top of the
-   * input. When set to `inline` the label is next to the input.
-   */
   layout: PropTypes.oneOf(['stacked', 'inline']),
-
-  /**
-   * Specifies the width of the input.
-   */
   width: PropTypes.string,
-
-  /**
-   * Specifies the display property of the container.
-   */
   display: PropTypes.oneOf(['inline-block', 'block']),
-
-  /**
-   * Provides a ref to the underlying input element.
-   */
   inputRef: PropTypes.func,
-
-  /**
-   * 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 calendar in relation to the input.
-   */
   placement: PositionPropTypes.placement,
-
-  /**
-   * Controls whether or not the calendar is showing.
-   */
   isShowingCalendar: PropTypes.bool,
-
-  /**
-   * Callback fired when the input is blurred. Feedback should be provided
-   * to the user when this function is called if the selected date or input
-   * value is not valid.
-   */
   onRequestValidateDate: PropTypes.func,
-
-  /**
-   * Callback fired requesting the calendar be shown.
-   */
   onRequestShowCalendar: PropTypes.func,
-
-  /**
-   * Callback fired requesting the calendar be hidden.
-   */
   onRequestHideCalendar: PropTypes.func,
-
-  /**
-   * Callback fired requesting the next day be selected. If no date is currently
-   * selected should default to the first day of the currently rendered month.
-   */
   onRequestSelectNextDay: PropTypes.func,
-
-  /**
-   * Callback fired requesting the previous day be selected. If no date is currently
-   * selected should default to the first day of the currently rendered month.
-   */
   onRequestSelectPrevDay: PropTypes.func,
-
-  /**
-   * Callback fired requesting the next month be rendered.
-   */
   onRequestRenderNextMonth: PropTypes.func,
-
-  /**
-   * Callback fired requesting the previous month be rendered.
-   */
   onRequestRenderPrevMonth: PropTypes.func,
-
-  /**
-   * Content to render in the calendar navigation header. The recommendation is
-   * to include the name of the current rendered month along with the year.
-   */
   renderNavigationLabel: PropTypes.oneOfType([PropTypes.func, PropTypes.node]),
-
-  /**
-   * An array of labels containing the name of each day of the week. The visible
-   * portion of the label should be abbreviated (no longer than three characters).
-   * Note that screen readers will read this content preceding each date as the
-   * `<Calendar />` is navigated. Consider using
-   * [AccessibleContent](#AccessibleContent) with the `alt` prop containing the
-   * full day name for assistive technologies and the children containing the
-   * abbreviation. ex. `[<AccessibleContent alt="Sunday">Sun</AccessibleContent>, ...]`
-   */
   renderWeekdayLabels: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.node])).isRequired,
-
-  /**
-   * A button to render in the calendar navigation header. The recommendation is
-   * to compose it with the [Button](#Button) component, setting the `variant`
-   * prop to `icon`, the `size` prop to `small`, and setting the `icon` prop to
-   * [IconArrowOpenEnd](#iconography).
-   */
   renderNextMonthButton: PropTypes.oneOfType([PropTypes.func, PropTypes.node]),
-
-  /**
-   * A button to render in the calendar navigation header. The recommendation is
-   * to compose it with the [Button](#Button) component, setting the `variant`
-   * prop to `icon`, the `size` prop to `small`, and setting the `icon` prop to
-   * [IconArrowOpenStart](#iconography).
-   */
   renderPrevMonthButton: PropTypes.oneOfType([PropTypes.func, PropTypes.node]),
-
-  /**
-   * children of type `<DateInput.Day />` There should be exactly 42 provided (6
-   * weeks).
-   */
   children: ChildrenPropTypes.oneOf([Calendar.Day])
 };
 const allowedProps = ['renderLabel', 'value', 'size', 'placeholder', 'onChange', 'onBlur', 'interaction', 'isRequired', 'isInline', 'assistiveText', 'layout', 'width', 'display', 'inputRef', 'messages', 'placement', 'isShowingCalendar', 'onRequestValidateDate', 'onRequestShowCalendar', 'onRequestHideCalendar', 'onRequestSelectNextDay', 'onRequestSelectPrevDay', 'onRequestRenderNextMonth', 'onRequestRenderPrevMonth', 'renderNavigationLabel', 'renderWeekdayLabels', 'renderNextMonthButton', 'renderPrevMonthButton', 'children'];

package/es/DateInput/styles.js

@@ -27,10 +27,9 @@
  * private: true
  * ---
  * Generates the style object from the theme and provided additional information
- * @param  {Object} componentTheme The theme variable object.
- * @param  {Object} props the props of the component, the style is applied to
- * @param  {Object} state the state of the component, the style is applied to
- * @return {Object} The final style object, which will be used in the component
+ * @param  _componentTheme The theme variable object.
+ * @param  props the props of the component, the style is applied to
+ * @return The final style object, which will be used in the component
  */
 const generateStyle = (_componentTheme, props) => {
   return {