@instructure/ui-date-input 9.5.2 → 9.6.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [9.6.0](https://github.com/instructure/instructure-ui/compare/v9.5.2...v9.6.0) (2024-08-14)
+
+
+### Features
+
+* **ui-calendar,ui-date-input:** improve DateInput2 onChange callback, add date formatting option, extend docs ([4e2c23c](https://github.com/instructure/instructure-ui/commit/4e2c23c3288885e49030f1f471d61b2fed29b54c))
+
+
+
+
+
 ## [9.5.2](https://github.com/instructure/instructure-ui/compare/v9.5.1...v9.5.2) (2024-08-05)
 
 

package/es/DateInput2/index.js

@@ -37,9 +37,16 @@ import { jsx } from '@instructure/emotion';
 import { propTypes } from './props';
 function parseDate(dateString) {
   const date = new Date(dateString);
-  // return empty string if not a valid date
   return isNaN(date.getTime()) ? '' : date.toISOString();
 }
+function defaultDateFormatter(dateString, locale, timezone) {
+  return new Date(dateString).toLocaleDateString(locale, {
+    month: 'long',
+    year: 'numeric',
+    day: 'numeric',
+    timeZone: timezone
+  });
+}
 
 /**
 ---
@@ -64,6 +71,8 @@ const DateInput2 = ({
   locale,
   timezone,
   placeholder,
+  formatDate = defaultDateFormatter,
+  // margin, TODO enable this prop
   ...rest
 }) => {
   const _useState = useState(''),
@@ -80,29 +89,28 @@ const DateInput2 = ({
     setShowPopover = _useState6[1];
   const localeContext = useContext(ApplyLocaleContext);
   useEffect(() => {
-    // when `value` is changed, validation runs again and removes the error message if validation passes
+    // when `value` is changed, validation removes the error message if passes
     // but it's NOT adding error message if validation fails for better UX
     validateInput(true);
   }, [value]);
   useEffect(() => {
     setInputMessages(messages || []);
   }, [messages]);
-  const handleInputChange = (e, value) => {
-    onChange === null || onChange === void 0 ? void 0 : onChange(e, value);
-    // blur event formats the input which should trigger parsing
+  useEffect(() => {
+    setSelectedDate(parseDate(value || ''));
+  }, []);
+  const handleInputChange = (e, newValue, parsedDate = '') => {
+    // blur event formats the input which shouldn't trigger parsing
     if (e.type !== 'blur') {
-      setSelectedDate(parseDate(value));
+      setSelectedDate(parseDate(newValue));
     }
+    onChange === null || onChange === void 0 ? void 0 : onChange(e, newValue, parsedDate);
   };
   const handleDateSelected = (dateString, _momentDate, e) => {
-    const formattedDate = new Date(dateString).toLocaleDateString(getLocale(), {
-      month: 'long',
-      year: 'numeric',
-      day: 'numeric',
-      timeZone: getTimezone()
-    });
-    handleInputChange(e, formattedDate);
-    setSelectedDate(dateString);
+    const formattedDate = formatDate(dateString, getLocale(), getTimezone());
+    const parsedDate = parseDate(dateString);
+    setSelectedDate(parsedDate);
+    handleInputChange(e, formattedDate, parsedDate);
     setShowPopover(false);
     onRequestValidateDate === null || onRequestValidateDate === void 0 ? void 0 : onRequestValidateDate(dateString, true);
   };
@@ -143,18 +151,14 @@ const DateInput2 = ({
   const handleBlur = e => {
     const isInputValid = validateInput(false);
     if (isInputValid && selectedDate) {
-      const formattedDate = new Date(selectedDate).toLocaleDateString(getLocale(), {
-        month: 'long',
-        year: 'numeric',
-        day: 'numeric',
-        timeZone: getTimezone()
-      });
-      handleInputChange(e, formattedDate);
+      const formattedDate = formatDate(selectedDate, getLocale(), getTimezone());
+      handleInputChange(e, formattedDate, selectedDate);
     }
     onRequestValidateDate === null || onRequestValidateDate === void 0 ? void 0 : onRequestValidateDate(value, isInputValid);
     onBlur === null || onBlur === void 0 ? void 0 : onBlur(e);
   };
   return jsx(TextInput, Object.assign({}, passthroughProps(rest), {
+    // margin={'large'} TODO add this prop to TextInput
     renderLabel: renderLabel,
     onChange: handleInputChange,
     onBlur: handleBlur,
@@ -187,8 +191,8 @@ const DateInput2 = ({
       onDateSelected: handleDateSelected,
       selectedDate: selectedDate,
       visibleMonth: selectedDate,
-      locale: locale,
-      timezone: timezone,
+      locale: getLocale(),
+      timezone: getTimezone(),
       role: "listbox",
       renderNextMonthButton: jsx(IconButton, {
         size: "small",

package/es/DateInput2/props.js

@@ -44,6 +44,7 @@ const propTypes = {
   invalidDateErrorMessage: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
   locale: PropTypes.string,
   timezone: PropTypes.string,
-  withYearPicker: PropTypes.object
+  withYearPicker: PropTypes.object,
+  formatDate: PropTypes.func
 };
 export { propTypes };

package/lib/DateInput2/index.js

@@ -46,9 +46,16 @@ var _IconCalendarMonthLin, _IconArrowOpenEndSoli, _IconArrowOpenStartSo;
 /** @jsx jsx */
 function parseDate(dateString) {
   const date = new Date(dateString);
-  // return empty string if not a valid date
   return isNaN(date.getTime()) ? '' : date.toISOString();
 }
+function defaultDateFormatter(dateString, locale, timezone) {
+  return new Date(dateString).toLocaleDateString(locale, {
+    month: 'long',
+    year: 'numeric',
+    day: 'numeric',
+    timeZone: timezone
+  });
+}
 
 /**
 ---
@@ -73,6 +80,8 @@ const DateInput2 = ({
   locale,
   timezone,
   placeholder,
+  formatDate = defaultDateFormatter,
+  // margin, TODO enable this prop
   ...rest
 }) => {
   const _useState = (0, _react.useState)(''),
@@ -89,29 +98,28 @@ const DateInput2 = ({
     setShowPopover = _useState6[1];
   const localeContext = (0, _react.useContext)(_ApplyLocaleContext.ApplyLocaleContext);
   (0, _react.useEffect)(() => {
-    // when `value` is changed, validation runs again and removes the error message if validation passes
+    // when `value` is changed, validation removes the error message if passes
     // but it's NOT adding error message if validation fails for better UX
     validateInput(true);
   }, [value]);
   (0, _react.useEffect)(() => {
     setInputMessages(messages || []);
   }, [messages]);
-  const handleInputChange = (e, value) => {
-    onChange === null || onChange === void 0 ? void 0 : onChange(e, value);
-    // blur event formats the input which should trigger parsing
+  (0, _react.useEffect)(() => {
+    setSelectedDate(parseDate(value || ''));
+  }, []);
+  const handleInputChange = (e, newValue, parsedDate = '') => {
+    // blur event formats the input which shouldn't trigger parsing
     if (e.type !== 'blur') {
-      setSelectedDate(parseDate(value));
+      setSelectedDate(parseDate(newValue));
     }
+    onChange === null || onChange === void 0 ? void 0 : onChange(e, newValue, parsedDate);
   };
   const handleDateSelected = (dateString, _momentDate, e) => {
-    const formattedDate = new Date(dateString).toLocaleDateString(getLocale(), {
-      month: 'long',
-      year: 'numeric',
-      day: 'numeric',
-      timeZone: getTimezone()
-    });
-    handleInputChange(e, formattedDate);
-    setSelectedDate(dateString);
+    const formattedDate = formatDate(dateString, getLocale(), getTimezone());
+    const parsedDate = parseDate(dateString);
+    setSelectedDate(parsedDate);
+    handleInputChange(e, formattedDate, parsedDate);
     setShowPopover(false);
     onRequestValidateDate === null || onRequestValidateDate === void 0 ? void 0 : onRequestValidateDate(dateString, true);
   };
@@ -152,18 +160,14 @@ const DateInput2 = ({
   const handleBlur = e => {
     const isInputValid = validateInput(false);
     if (isInputValid && selectedDate) {
-      const formattedDate = new Date(selectedDate).toLocaleDateString(getLocale(), {
-        month: 'long',
-        year: 'numeric',
-        day: 'numeric',
-        timeZone: getTimezone()
-      });
-      handleInputChange(e, formattedDate);
+      const formattedDate = formatDate(selectedDate, getLocale(), getTimezone());
+      handleInputChange(e, formattedDate, selectedDate);
     }
     onRequestValidateDate === null || onRequestValidateDate === void 0 ? void 0 : onRequestValidateDate(value, isInputValid);
     onBlur === null || onBlur === void 0 ? void 0 : onBlur(e);
   };
   return (0, _emotion.jsx)(_TextInput.TextInput, Object.assign({}, (0, _passthroughProps.passthroughProps)(rest), {
+    // margin={'large'} TODO add this prop to TextInput
     renderLabel: renderLabel,
     onChange: handleInputChange,
     onBlur: handleBlur,
@@ -196,8 +200,8 @@ const DateInput2 = ({
       onDateSelected: handleDateSelected,
       selectedDate: selectedDate,
       visibleMonth: selectedDate,
-      locale: locale,
-      timezone: timezone,
+      locale: getLocale(),
+      timezone: getTimezone(),
       role: "listbox",
       renderNextMonthButton: (0, _emotion.jsx)(_IconButton.IconButton, {
         size: "small",

package/lib/DateInput2/props.js

@@ -51,5 +51,6 @@ const propTypes = exports.propTypes = {
   invalidDateErrorMessage: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.string]),
   locale: _propTypes.default.string,
   timezone: _propTypes.default.string,
-  withYearPicker: _propTypes.default.object
+  withYearPicker: _propTypes.default.object,
+  formatDate: _propTypes.default.func
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-date-input",
-  "version": "9.5.2",
+  "version": "9.6.0",
   "description": "A UI component library made by Instructure Inc.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-axe-check": "9.5.2",
-    "@instructure/ui-babel-preset": "9.5.2",
-    "@instructure/ui-buttons": "9.5.2",
-    "@instructure/ui-scripts": "9.5.2",
-    "@instructure/ui-test-utils": "9.5.2",
+    "@instructure/ui-axe-check": "9.6.0",
+    "@instructure/ui-babel-preset": "9.6.0",
+    "@instructure/ui-buttons": "9.6.0",
+    "@instructure/ui-scripts": "9.6.0",
+    "@instructure/ui-test-utils": "9.6.0",
     "@testing-library/jest-dom": "^6.4.6",
     "@testing-library/react": "^15.0.7",
     "@testing-library/user-event": "^14.5.2",
@@ -35,20 +35,20 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.24.5",
-    "@instructure/emotion": "9.5.2",
-    "@instructure/shared-types": "9.5.2",
-    "@instructure/ui-calendar": "9.5.2",
-    "@instructure/ui-form-field": "9.5.2",
-    "@instructure/ui-i18n": "9.5.2",
-    "@instructure/ui-icons": "9.5.2",
-    "@instructure/ui-popover": "9.5.2",
-    "@instructure/ui-position": "9.5.2",
-    "@instructure/ui-prop-types": "9.5.2",
-    "@instructure/ui-react-utils": "9.5.2",
-    "@instructure/ui-selectable": "9.5.2",
-    "@instructure/ui-testable": "9.5.2",
-    "@instructure/ui-text-input": "9.5.2",
-    "@instructure/ui-utils": "9.5.2",
+    "@instructure/emotion": "9.6.0",
+    "@instructure/shared-types": "9.6.0",
+    "@instructure/ui-calendar": "9.6.0",
+    "@instructure/ui-form-field": "9.6.0",
+    "@instructure/ui-i18n": "9.6.0",
+    "@instructure/ui-icons": "9.6.0",
+    "@instructure/ui-popover": "9.6.0",
+    "@instructure/ui-position": "9.6.0",
+    "@instructure/ui-prop-types": "9.6.0",
+    "@instructure/ui-react-utils": "9.6.0",
+    "@instructure/ui-selectable": "9.6.0",
+    "@instructure/ui-testable": "9.6.0",
+    "@instructure/ui-text-input": "9.6.0",
+    "@instructure/ui-utils": "9.6.0",
     "moment-timezone": "^0.5.45",
     "prop-types": "^15.8.1"
   },

package/src/DateInput2/README.md

@@ -113,7 +113,11 @@ This component is an updated version of [`DateInput`](/#DateInput) that's easier
   render(<Example />)
   ```
 
-### With custom validation
+### Date validation
+
+By default `DateInput2` only does date validation if the `invalidDateErrorMessage` prop is provided. This uses the browser's `Date` object to try an parse the user provided date and displays the error message if it fails. Validation is only triggered on the blur event of the input field.
+
+If you want to do a more complex validation than the above (e.g. only allow a subset of dates) you can use the `onRequestValidateDate` prop to pass a validation function. This function will run on blur or on selecting the date from the picker. The result of the internal validation will be passed to this function. Then you have to set the error messages accordingly. Check the following example for more details:
 
 ```js
 ---
@@ -163,3 +167,101 @@ const Example = () => {
 
 render(<Example />)
 ```
+
+### Date formatting
+
+The display format of the dates can be set via the `formatDate` property. It will be applied if the user clicks on a date in the date picker of after blur event from the input field.
+Something to pay attention to is that the date string passed back in the callback function **is in UTC timezone**.
+
+```js
+---
+type: example
+---
+const Example = () => {
+  const [value1, setValue1] = useState('')
+  const [value2, setValue2] = useState('')
+  const [value3, setValue3] = useState('')
+
+  const shortDateFormatFn = (dateString, locale, timezone) => {
+    return new Date(dateString).toLocaleDateString(locale, {
+      month: 'numeric',
+      year: 'numeric',
+      day: 'numeric',
+      timeZone: timezone,
+    })
+  }
+
+  const isoDateFormatFn = (dateString, locale, timezone) => {
+    // this is a simple way to get ISO8601 date in a specific timezone but should not be used in production
+    // please use a proper date library instead like date-fns, luxon or dayjs
+    const localeDate = new Date(dateString).toLocaleDateString('sv', {
+      month: 'numeric',
+      year: 'numeric',
+      day: 'numeric',
+      timeZone: timezone,
+    })
+
+    return localeDate
+  }
+
+  return (
+    <div style={{display: 'flex', flexDirection: 'column', gap: '1.5rem'}}>
+        <DateInput2
+          renderLabel="Default format"
+          screenReaderLabels={{
+            calendarIcon: 'Calendar',
+            nextMonthButton: 'Next month',
+            prevMonthButton: 'Previous month'
+          }}
+          isInline
+          width="20rem"
+          value={value1}
+          onChange={(e, value) => setValue1(value)}
+          withYearPicker={{
+            screenReaderLabel: 'Year picker',
+            startYear: 1900,
+            endYear: 2024
+          }}
+        />
+        <DateInput2
+          renderLabel="Short format in current locale"
+          screenReaderLabels={{
+            calendarIcon: 'Calendar',
+            nextMonthButton: 'Next month',
+            prevMonthButton: 'Previous month'
+          }}
+          isInline
+          width="20rem"
+          value={value2}
+          onChange={(e, value) => setValue2(value)}
+          formatDate={shortDateFormatFn}
+          withYearPicker={{
+            screenReaderLabel: 'Year picker',
+            startYear: 1900,
+            endYear: 2024
+          }}
+        />
+        <DateInput2
+          renderLabel="ISO8601"
+          screenReaderLabels={{
+            calendarIcon: 'Calendar',
+            nextMonthButton: 'Next month',
+            prevMonthButton: 'Previous month'
+          }}
+          isInline
+          width="20rem"
+          value={value3}
+          onChange={(e, value) => setValue3(value)}
+          formatDate={isoDateFormatFn}
+          withYearPicker={{
+            screenReaderLabel: 'Year picker',
+            startYear: 1900,
+            endYear: 2024
+          }}
+        />
+    </div>
+  )
+}
+
+render(<Example />)
+```

package/src/DateInput2/index.tsx

@@ -46,10 +46,22 @@ import type { Moment } from '@instructure/ui-i18n'
 
 function parseDate(dateString: string): string {
   const date = new Date(dateString)
-  // return empty string if not a valid date
   return isNaN(date.getTime()) ? '' : date.toISOString()
 }
 
+function defaultDateFormatter(
+  dateString: string,
+  locale: string,
+  timezone: string
+) {
+  return new Date(dateString).toLocaleDateString(locale, {
+    month: 'long',
+    year: 'numeric',
+    day: 'numeric',
+    timeZone: timezone
+  })
+}
+
 /**
 ---
 category: components
@@ -73,6 +85,8 @@ const DateInput2 = ({
   locale,
   timezone,
   placeholder,
+  formatDate = defaultDateFormatter,
+  // margin, TODO enable this prop
   ...rest
 }: DateInput2Props) => {
   const [selectedDate, setSelectedDate] = useState<string>('')
@@ -83,7 +97,7 @@ const DateInput2 = ({
   const localeContext = useContext(ApplyLocaleContext)
 
   useEffect(() => {
-    // when `value` is changed, validation runs again and removes the error message if validation passes
+    // when `value` is changed, validation removes the error message if passes
     // but it's NOT adding error message if validation fails for better UX
     validateInput(true)
   }, [value])
@@ -92,12 +106,20 @@ const DateInput2 = ({
     setInputMessages(messages || [])
   }, [messages])
 
-  const handleInputChange = (e: SyntheticEvent, value: string) => {
-    onChange?.(e, value)
-    // blur event formats the input which should trigger parsing
+  useEffect(() => {
+    setSelectedDate(parseDate(value || ''))
+  }, [])
+
+  const handleInputChange = (
+    e: SyntheticEvent,
+    newValue: string,
+    parsedDate: string = ''
+  ) => {
+    // blur event formats the input which shouldn't trigger parsing
     if (e.type !== 'blur') {
-      setSelectedDate(parseDate(value))
+      setSelectedDate(parseDate(newValue))
     }
+    onChange?.(e, newValue, parsedDate)
   }
 
   const handleDateSelected = (
@@ -105,14 +127,10 @@ const DateInput2 = ({
     _momentDate: Moment,
     e: SyntheticEvent
   ) => {
-    const formattedDate = new Date(dateString).toLocaleDateString(getLocale(), {
-      month: 'long',
-      year: 'numeric',
-      day: 'numeric',
-      timeZone: getTimezone()
-    })
-    handleInputChange(e, formattedDate)
-    setSelectedDate(dateString)
+    const formattedDate = formatDate(dateString, getLocale(), getTimezone())
+    const parsedDate = parseDate(dateString)
+    setSelectedDate(parsedDate)
+    handleInputChange(e, formattedDate, parsedDate)
     setShowPopover(false)
     onRequestValidateDate?.(dateString, true)
   }
@@ -163,16 +181,8 @@ const DateInput2 = ({
   const handleBlur = (e: SyntheticEvent) => {
     const isInputValid = validateInput(false)
     if (isInputValid && selectedDate) {
-      const formattedDate = new Date(selectedDate).toLocaleDateString(
-        getLocale(),
-        {
-          month: 'long',
-          year: 'numeric',
-          day: 'numeric',
-          timeZone: getTimezone()
-        }
-      )
-      handleInputChange(e, formattedDate)
+      const formattedDate = formatDate(selectedDate, getLocale(), getTimezone())
+      handleInputChange(e, formattedDate, selectedDate)
     }
     onRequestValidateDate?.(value, isInputValid)
     onBlur?.(e)
@@ -181,6 +191,7 @@ const DateInput2 = ({
   return (
     <TextInput
       {...passthroughProps(rest)}
+      // margin={'large'} TODO add this prop to TextInput
       renderLabel={renderLabel}
       onChange={handleInputChange}
       onBlur={handleBlur}
@@ -219,8 +230,8 @@ const DateInput2 = ({
             onDateSelected={handleDateSelected}
             selectedDate={selectedDate}
             visibleMonth={selectedDate}
-            locale={locale}
-            timezone={timezone}
+            locale={getLocale()}
+            timezone={getTimezone()}
             role="listbox"
             renderNextMonthButton={
               <IconButton

package/src/DateInput2/props.ts

@@ -28,7 +28,11 @@ import type { SyntheticEvent, InputHTMLAttributes } from 'react'
 import { controllable } from '@instructure/ui-prop-types'
 import { FormPropTypes } from '@instructure/ui-form-field'
 import type { FormMessage } from '@instructure/ui-form-field'
-import type { OtherHTMLAttributes, Renderable, PropValidators } from '@instructure/shared-types'
+import type {
+  OtherHTMLAttributes,
+  Renderable,
+  PropValidators
+} from '@instructure/shared-types'
 
 type DateInput2OwnProps = {
   /**
@@ -56,7 +60,11 @@ type DateInput2OwnProps = {
   /**
    * Callback fired when the input changes.
    */
-  onChange?: (event: React.SyntheticEvent, value: string) => void
+  onChange?: (
+    event: React.SyntheticEvent,
+    inputValue: string,
+    dateString: string
+  ) => void
   /**
    * Callback executed when the input fires a blur event.
    */
@@ -157,6 +165,18 @@ type DateInput2OwnProps = {
     startYear: number
     endYear: number
   }
+
+  /**
+   * Formatting function for how the date should be displayed inside the input field. It will be applied if the user clicks on a date in the date picker of after blur event from the input field.
+   */
+  formatDate?: (isoDate: string, locale: string, timezone: string) => string
+
+  /**
+   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+   */
+  // margin?: Spacing TODO enable this prop
 }
 
 type PropKeys = keyof DateInput2OwnProps
@@ -189,7 +209,8 @@ const propTypes: PropValidators<PropKeys> = {
   ]),
   locale: PropTypes.string,
   timezone: PropTypes.string,
-  withYearPicker: PropTypes.object
+  withYearPicker: PropTypes.object,
+  formatDate: PropTypes.func
 }
 
 export type { DateInput2Props }