@instructure/ui-date-input 10.12.1-snapshot-0 → 10.12.1-snapshot-2

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [10.12.1-snapshot-0](https://github.com/instructure/instructure-ui/compare/v10.12.0...v10.12.1-snapshot-0) (2025-02-26)
+## [10.12.1-snapshot-2](https://github.com/instructure/instructure-ui/compare/v10.12.0...v10.12.1-snapshot-2) (2025-03-04)
 
 
 ### Bug Fixes
@@ -11,6 +11,11 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 * **many:** fix form label not read by NVDA in hover mode and other layout issues ([ef77281](https://github.com/instructure/instructure-ui/commit/ef77281890511e8eea794196445d3ef2454537ba))
 
 
+### Features
+
+* **ui-date-input:** add feature to disable dates and access the input's ref ([411219e](https://github.com/instructure/instructure-ui/commit/411219e4347c75ed2ffeda320b33c591ffc05329))
+
+
 
 
 

package/es/DateInput2/index.js

@@ -110,8 +110,6 @@ function parseLocaleDate(dateString = '', locale, timeZone) {
 ---
 category: components
 ---
-
-@module experimental
 **/
 const DateInput2 = ({
   renderLabel,
@@ -131,8 +129,10 @@ const DateInput2 = ({
   placeholder,
   dateFormat,
   onRequestValidateDate,
+  disabledDates,
   renderCalendarIcon,
   margin,
+  inputRef,
   ...rest
 }) => {
   const localeContext = useContext(ApplyLocaleContext);
@@ -250,6 +250,7 @@ const DateInput2 = ({
   };
   const selectedDate = parseDate(value)[1];
   return jsx(TextInput, Object.assign({}, passthroughProps(rest), {
+    inputRef: inputRef,
     renderLabel: renderLabel,
     onChange: handleInputChange,
     onBlur: handleBlur,
@@ -280,6 +281,7 @@ const DateInput2 = ({
       withYearPicker: withYearPicker,
       onDateSelected: handleDateSelected,
       selectedDate: selectedDate,
+      disabledDates: disabledDates,
       visibleMonth: selectedDate,
       locale: getLocale(),
       timezone: getTimezone(),

package/es/DateInput2/props.js

@@ -44,6 +44,8 @@ const propTypes = {
   dateFormat: PropTypes.oneOfType([PropTypes.string, PropTypes.object]),
   onRequestValidateDate: PropTypes.func,
   renderCalendarIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-  margin: PropTypes.string
+  margin: PropTypes.string,
+  disabledDates: PropTypes.oneOfType([PropTypes.array, PropTypes.func]),
+  inputRef: PropTypes.func
 };
 export { propTypes };

package/lib/DateInput2/index.js

@@ -120,8 +120,6 @@ function parseLocaleDate(dateString = '', locale, timeZone) {
 ---
 category: components
 ---
-
-@module experimental
 **/
 const DateInput2 = ({
   renderLabel,
@@ -141,8 +139,10 @@ const DateInput2 = ({
   placeholder,
   dateFormat,
   onRequestValidateDate,
+  disabledDates,
   renderCalendarIcon,
   margin,
+  inputRef,
   ...rest
 }) => {
   const localeContext = (0, _react.useContext)(_ApplyLocaleContext.ApplyLocaleContext);
@@ -260,6 +260,7 @@ const DateInput2 = ({
   };
   const selectedDate = parseDate(value)[1];
   return (0, _emotion.jsx)(_TextInput.TextInput, Object.assign({}, (0, _passthroughProps.passthroughProps)(rest), {
+    inputRef: inputRef,
     renderLabel: renderLabel,
     onChange: handleInputChange,
     onBlur: handleBlur,
@@ -290,6 +291,7 @@ const DateInput2 = ({
       withYearPicker: withYearPicker,
       onDateSelected: handleDateSelected,
       selectedDate: selectedDate,
+      disabledDates: disabledDates,
       visibleMonth: selectedDate,
       locale: getLocale(),
       timezone: getTimezone(),

package/lib/DateInput2/props.js

@@ -51,5 +51,7 @@ const propTypes = exports.propTypes = {
   dateFormat: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.object]),
   onRequestValidateDate: _propTypes.default.func,
   renderCalendarIcon: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-  margin: _propTypes.default.string
+  margin: _propTypes.default.string,
+  disabledDates: _propTypes.default.oneOfType([_propTypes.default.array, _propTypes.default.func]),
+  inputRef: _propTypes.default.func
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-date-input",
-  "version": "10.12.1-snapshot-0",
+  "version": "10.12.1-snapshot-2",
   "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": "10.12.1-snapshot-0",
-    "@instructure/ui-babel-preset": "10.12.1-snapshot-0",
-    "@instructure/ui-buttons": "10.12.1-snapshot-0",
-    "@instructure/ui-scripts": "10.12.1-snapshot-0",
-    "@instructure/ui-test-utils": "10.12.1-snapshot-0",
+    "@instructure/ui-axe-check": "10.12.1-snapshot-2",
+    "@instructure/ui-babel-preset": "10.12.1-snapshot-2",
+    "@instructure/ui-buttons": "10.12.1-snapshot-2",
+    "@instructure/ui-scripts": "10.12.1-snapshot-2",
+    "@instructure/ui-test-utils": "10.12.1-snapshot-2",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.0.1",
     "@testing-library/user-event": "^14.5.2",
@@ -35,20 +35,20 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.26.0",
-    "@instructure/emotion": "10.12.1-snapshot-0",
-    "@instructure/shared-types": "10.12.1-snapshot-0",
-    "@instructure/ui-calendar": "10.12.1-snapshot-0",
-    "@instructure/ui-form-field": "10.12.1-snapshot-0",
-    "@instructure/ui-i18n": "10.12.1-snapshot-0",
-    "@instructure/ui-icons": "10.12.1-snapshot-0",
-    "@instructure/ui-popover": "10.12.1-snapshot-0",
-    "@instructure/ui-position": "10.12.1-snapshot-0",
-    "@instructure/ui-prop-types": "10.12.1-snapshot-0",
-    "@instructure/ui-react-utils": "10.12.1-snapshot-0",
-    "@instructure/ui-selectable": "10.12.1-snapshot-0",
-    "@instructure/ui-testable": "10.12.1-snapshot-0",
-    "@instructure/ui-text-input": "10.12.1-snapshot-0",
-    "@instructure/ui-utils": "10.12.1-snapshot-0",
+    "@instructure/emotion": "10.12.1-snapshot-2",
+    "@instructure/shared-types": "10.12.1-snapshot-2",
+    "@instructure/ui-calendar": "10.12.1-snapshot-2",
+    "@instructure/ui-form-field": "10.12.1-snapshot-2",
+    "@instructure/ui-i18n": "10.12.1-snapshot-2",
+    "@instructure/ui-icons": "10.12.1-snapshot-2",
+    "@instructure/ui-popover": "10.12.1-snapshot-2",
+    "@instructure/ui-position": "10.12.1-snapshot-2",
+    "@instructure/ui-prop-types": "10.12.1-snapshot-2",
+    "@instructure/ui-react-utils": "10.12.1-snapshot-2",
+    "@instructure/ui-selectable": "10.12.1-snapshot-2",
+    "@instructure/ui-testable": "10.12.1-snapshot-2",
+    "@instructure/ui-text-input": "10.12.1-snapshot-2",
+    "@instructure/ui-utils": "10.12.1-snapshot-2",
     "moment-timezone": "^0.5.45",
     "prop-types": "^15.8.1"
   },

package/src/DateInput/README.md

@@ -2,7 +2,7 @@
 describes: DateInput
 ---
 
-> _Note:_ you can now try the updated (but still experimental) [`DateInput2`](/#DateInput2) which is easier to configure for developers, has a better UX, better accessibility features and a year picker. We recommend using that instead of `DateInput` which will be deprecated in the future.
+> _Note:_ we recommend to update to the new [`DateInput2`](/#DateInput2) which is easier to configure for developers, has a better UX, better accessibility features and a year picker. `DateInput` will be deprecated in the future.
 
 The `DateInput` component provides a visual interface for inputting date data.
 

package/src/DateInput2/README.md

@@ -305,3 +305,38 @@ render(<Example />)
 ### Date format hint
 
 If the `placeholder` property is undefined it will display a hint for the date format (like `DD/MM/YYYY`). Usually it is recommended to leave it as it is for a better user experience.
+
+### Disabling dates
+
+You can use the `disabledDates` prop to disable specific dates. It accepts either an array of ISO8601 date strings or a function. Keep in mind that this will only disable the dates in the calendar and does not prevent the user the enter them into the input field. To validate those values please use the `onRequestValidateDate` prop.
+
+```js
+---
+type: example
+---
+const Example = () => {
+  const [inputValue, setInputValue] = useState('2/5/2025')
+  const [dateString, setDateString] = useState('')
+  return (
+    <DateInput2
+      renderLabel="Choose a date"
+      disabledDates={['2025-02-11', '2025-02-12', '2025-02-13']}
+      screenReaderLabels={{
+        calendarIcon: 'Calendar',
+        nextMonthButton: 'Next month',
+        prevMonthButton: 'Previous month'
+      }}
+      value={inputValue}
+      locale="en-us"
+      width="20rem"
+      onChange={(e, inputValue, dateString) => {
+        setInputValue(inputValue)
+        setDateString(dateString)
+      }}
+      invalidDateErrorMessage="Invalid date"
+    />
+  )
+}
+
+render(<Example />)
+```

package/src/DateInput2/index.tsx

@@ -131,8 +131,6 @@ function parseLocaleDate(
 ---
 category: components
 ---
-
-@module experimental
 **/
 const DateInput2 = ({
   renderLabel,
@@ -152,8 +150,10 @@ const DateInput2 = ({
   placeholder,
   dateFormat,
   onRequestValidateDate,
+  disabledDates,
   renderCalendarIcon,
   margin,
+  inputRef,
   ...rest
 }: DateInput2Props) => {
   const localeContext = useContext(ApplyLocaleContext)
@@ -275,9 +275,11 @@ const DateInput2 = ({
   }
 
   const selectedDate = parseDate(value)[1]
+
   return (
     <TextInput
       {...passthroughProps(rest)}
+      inputRef={inputRef}
       renderLabel={renderLabel}
       onChange={handleInputChange}
       onBlur={handleBlur}
@@ -318,6 +320,7 @@ const DateInput2 = ({
             withYearPicker={withYearPicker}
             onDateSelected={handleDateSelected}
             selectedDate={selectedDate}
+            disabledDates={disabledDates}
             visibleMonth={selectedDate}
             locale={getLocale()}
             timezone={getTimezone()}

package/src/DateInput2/props.ts

@@ -175,6 +175,17 @@ type DateInput2OwnProps = {
    * Margin around the component. Accepts a `Spacing` token. See token values and example usage in [this guide](https://instructure.design/#layout-spacing).
    */
   margin?: Spacing
+  /*
+   * Specify which date(s) will be shown as disabled in the calendar.
+   * You can either supply an array of ISO8601 timeDate strings or
+   * a function that will be called for each date shown in the calendar.
+   */
+  disabledDates?: string[] | ((isoDateToCheck: string) => boolean)
+
+  /**
+   * A function that provides a reference to the inner input element
+   */
+  inputRef?: (inputElement: HTMLInputElement | null) => void
 }
 
 type PropKeys = keyof DateInput2OwnProps
@@ -207,7 +218,9 @@ const propTypes: PropValidators<PropKeys> = {
   dateFormat: PropTypes.oneOfType([PropTypes.string, PropTypes.object]),
   onRequestValidateDate: PropTypes.func,
   renderCalendarIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-  margin: PropTypes.string
+  margin: PropTypes.string,
+  disabledDates: PropTypes.oneOfType([PropTypes.array, PropTypes.func]),
+  inputRef: PropTypes.func
 }
 
 export type { DateInput2Props }