@openmrs/esm-framework 6.3.1-pre.3105 → 6.3.1-pre.3106

package/docs/interfaces/OpenmrsDatePickerProps.md

@@ -1,594 +1,701 @@
-[O3 Framework](../API.md) / OpenmrsDatePickerProps
+[@openmrs/esm-framework](../API.md) / OpenmrsDatePickerProps
 
 # Interface: OpenmrsDatePickerProps
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L46)
-
 Properties for the OpenmrsDatePicker
 
-## Extends
-
-- `Omit`\<`DatePickerProps`\<`CalendarDate`\>, `"className"` \| `"onChange"` \| `"defaultValue"` \| `"value"`\>
+## Hierarchy
+
+- `Omit`<`DatePickerProps`<`CalendarDate`\>, ``"className"`` \| ``"onChange"`` \| ``"defaultValue"`` \| ``"value"``\>
+
+  ↳ **`OpenmrsDatePickerProps`**
+
+## Table of contents
+
+### Properties
+
+- [aria-describedby](OpenmrsDatePickerProps.md#aria-describedby)
+- [aria-details](OpenmrsDatePickerProps.md#aria-details)
+- [aria-label](OpenmrsDatePickerProps.md#aria-label)
+- [aria-labelledby](OpenmrsDatePickerProps.md#aria-labelledby)
+- [autoFocus](OpenmrsDatePickerProps.md#autofocus)
+- [children](OpenmrsDatePickerProps.md#children)
+- [className](OpenmrsDatePickerProps.md#classname)
+- [defaultOpen](OpenmrsDatePickerProps.md#defaultopen)
+- [defaultValue](OpenmrsDatePickerProps.md#defaultvalue)
+- [firstDayOfWeek](OpenmrsDatePickerProps.md#firstdayofweek)
+- [granularity](OpenmrsDatePickerProps.md#granularity)
+- [hideTimeZone](OpenmrsDatePickerProps.md#hidetimezone)
+- [hourCycle](OpenmrsDatePickerProps.md#hourcycle)
+- [id](OpenmrsDatePickerProps.md#id)
+- [invalid](OpenmrsDatePickerProps.md#invalid)
+- [invalidText](OpenmrsDatePickerProps.md#invalidtext)
+- [isDisabled](OpenmrsDatePickerProps.md#isdisabled)
+- [isInvalid](OpenmrsDatePickerProps.md#isinvalid)
+- [isOpen](OpenmrsDatePickerProps.md#isopen)
+- [isReadOnly](OpenmrsDatePickerProps.md#isreadonly)
+- [isRequired](OpenmrsDatePickerProps.md#isrequired)
+- [label](OpenmrsDatePickerProps.md#label)
+- [labelText](OpenmrsDatePickerProps.md#labeltext)
+- [light](OpenmrsDatePickerProps.md#light)
+- [maxDate](OpenmrsDatePickerProps.md#maxdate)
+- [maxValue](OpenmrsDatePickerProps.md#maxvalue)
+- [minDate](OpenmrsDatePickerProps.md#mindate)
+- [minValue](OpenmrsDatePickerProps.md#minvalue)
+- [name](OpenmrsDatePickerProps.md#name)
+- [pageBehavior](OpenmrsDatePickerProps.md#pagebehavior)
+- [placeholderValue](OpenmrsDatePickerProps.md#placeholdervalue)
+- [short](OpenmrsDatePickerProps.md#short)
+- [shouldCloseOnSelect](OpenmrsDatePickerProps.md#shouldcloseonselect)
+- [shouldForceLeadingZeros](OpenmrsDatePickerProps.md#shouldforceleadingzeros)
+- [size](OpenmrsDatePickerProps.md#size)
+- [slot](OpenmrsDatePickerProps.md#slot)
+- [style](OpenmrsDatePickerProps.md#style)
+- [validationBehavior](OpenmrsDatePickerProps.md#validationbehavior)
+- [value](OpenmrsDatePickerProps.md#value)
+
+### Methods
+
+- [isDateUnavailable](OpenmrsDatePickerProps.md#isdateunavailable)
+- [onBlur](OpenmrsDatePickerProps.md#onblur)
+- [onChange](OpenmrsDatePickerProps.md#onchange)
+- [onChangeRaw](OpenmrsDatePickerProps.md#onchangeraw)
+- [onFocus](OpenmrsDatePickerProps.md#onfocus)
+- [onFocusChange](OpenmrsDatePickerProps.md#onfocuschange)
+- [onKeyDown](OpenmrsDatePickerProps.md#onkeydown)
+- [onKeyUp](OpenmrsDatePickerProps.md#onkeyup)
+- [onOpenChange](OpenmrsDatePickerProps.md#onopenchange)
+- [validate](OpenmrsDatePickerProps.md#validate)
 
 ## Properties
 
-### aria-describedby?
-
-> `optional` **aria-describedby**: `string`
+### aria-describedby
 
-Defined in: node\_modules/@react-types/shared/src/dom.d.ts:40
+• `Optional` **aria-describedby**: `string`
 
 Identifies the element (or elements) that describes the object.
 
 #### Inherited from
 
-`Omit.aria-describedby`
+Omit.aria-describedby
 
-***
+#### Defined in
 
-### aria-details?
+node_modules/@react-types/shared/src/dom.d.ts:40
 
-> `optional` **aria-details**: `string`
+___
 
-Defined in: node\_modules/@react-types/shared/src/dom.d.ts:45
+### aria-details
+
+• `Optional` **aria-details**: `string`
 
 Identifies the element (or elements) that provide a detailed, extended description for the object.
 
 #### Inherited from
 
-`Omit.aria-details`
+Omit.aria-details
+
+#### Defined in
 
-***
+node_modules/@react-types/shared/src/dom.d.ts:45
 
-### aria-label?
+___
 
-> `optional` **aria-label**: `string`
+### aria-label
 
-Defined in: node\_modules/@react-types/shared/src/dom.d.ts:30
+• `Optional` **aria-label**: `string`
 
 Defines a string value that labels the current element.
 
 #### Inherited from
 
-`Omit.aria-label`
+Omit.aria-label
+
+#### Defined in
 
-***
+node_modules/@react-types/shared/src/dom.d.ts:30
 
-### aria-labelledby?
+___
 
-> `optional` **aria-labelledby**: `string`
+### aria-labelledby
 
-Defined in: node\_modules/@react-types/shared/src/dom.d.ts:35
+• `Optional` **aria-labelledby**: `string`
 
 Identifies the element (or elements) that labels the current element.
 
 #### Inherited from
 
-`Omit.aria-labelledby`
+Omit.aria-labelledby
 
-***
+#### Defined in
 
-### autoFocus?
+node_modules/@react-types/shared/src/dom.d.ts:35
 
-> `optional` **autoFocus**: `boolean`
+___
 
-Defined in: node\_modules/@react-types/shared/src/events.d.ts:128
+### autoFocus
+
+• `Optional` **autoFocus**: `boolean`
 
 Whether the element should receive focus on render.
 
 #### Inherited from
 
-`Omit.autoFocus`
+Omit.autoFocus
+
+#### Defined in
 
-***
+node_modules/@react-types/shared/src/events.d.ts:128
 
-### children?
+___
 
-> `optional` **children**: `ReactNode` \| (`values`) => `ReactNode`
+### children
 
-Defined in: node\_modules/react-aria-components/dist/types.d.ts:53
+• `Optional` **children**: `ReactNode` \| (`values`: `DatePickerRenderProps` & { `defaultChildren`: `ReactNode`  }) => `ReactNode`
 
 The children of the component. A function may be provided to alter the children based on component state.
 
 #### Inherited from
 
-`Omit.children`
+Omit.children
+
+#### Defined in
 
-***
+node_modules/react-aria-components/dist/types.d.ts:53
 
-### className?
+___
 
-> `optional` **className**: `Argument`
+### className
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:50](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L50)
+• `Optional` **className**: `Argument`
 
 Any CSS classes to add to the outer div of the date picker
 
-***
+#### Defined in
 
-### defaultOpen?
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L50)
 
-> `optional` **defaultOpen**: `boolean`
+___
 
-Defined in: node\_modules/@react-types/overlays/src/index.d.ts:112
+### defaultOpen
+
+• `Optional` **defaultOpen**: `boolean`
 
 Whether the overlay is open by default (uncontrolled).
 
 #### Inherited from
 
-`Omit.defaultOpen`
+Omit.defaultOpen
+
+#### Defined in
 
-***
+node_modules/@react-types/overlays/src/index.d.ts:112
 
-### defaultValue?
+___
 
-> `optional` **defaultValue**: `DateInputValue`
+### defaultValue
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L52)
+• `Optional` **defaultValue**: `DateInputValue`
 
 The default value (uncontrolled)
 
-***
+#### Defined in
+
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L52)
 
-### firstDayOfWeek?
+___
 
-> `optional` **firstDayOfWeek**: `"sun"` \| `"mon"` \| `"tue"` \| `"wed"` \| `"thu"` \| `"fri"` \| `"sat"`
+### firstDayOfWeek
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:78
+• `Optional` **firstDayOfWeek**: ``"sun"`` \| ``"mon"`` \| ``"tue"`` \| ``"wed"`` \| ``"thu"`` \| ``"fri"`` \| ``"sat"``
 
 The day that starts the week.
 
 #### Inherited from
 
-`Omit.firstDayOfWeek`
+Omit.firstDayOfWeek
 
-***
+#### Defined in
 
-### granularity?
+node_modules/@react-types/datepicker/src/index.d.ts:78
 
-> `optional` **granularity**: `Granularity`
+___
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:52
+### granularity
+
+• `Optional` **granularity**: `Granularity`
 
 Determines the smallest unit that is displayed in the date picker. By default, this is `"day"` for dates, and `"minute"` for times.
 
 #### Inherited from
 
-`Omit.granularity`
+Omit.granularity
 
-***
+#### Defined in
 
-### hideTimeZone?
+node_modules/@react-types/datepicker/src/index.d.ts:52
 
-> `optional` **hideTimeZone**: `boolean`
+___
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:57
+### hideTimeZone
 
-Whether to hide the time zone abbreviation.
+• `Optional` **hideTimeZone**: `boolean`
 
-#### Default
+Whether to hide the time zone abbreviation.
 
-```ts
-false
-```
+**`default`** false
 
 #### Inherited from
 
-`Omit.hideTimeZone`
+Omit.hideTimeZone
 
-***
+#### Defined in
 
-### hourCycle?
+node_modules/@react-types/datepicker/src/index.d.ts:57
 
-> `optional` **hourCycle**: `12` \| `24`
+___
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:50
+### hourCycle
+
+• `Optional` **hourCycle**: ``12`` \| ``24``
 
 Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale.
 
 #### Inherited from
 
-`Omit.hourCycle`
+Omit.hourCycle
+
+#### Defined in
 
-***
+node_modules/@react-types/datepicker/src/index.d.ts:50
 
-### id?
+___
 
-> `optional` **id**: `string`
+### id
 
-Defined in: node\_modules/@react-types/shared/src/dom.d.ts:62
+• `Optional` **id**: `string`
 
 The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
 
 #### Inherited from
 
-`Omit.id`
+Omit.id
 
-***
+#### Defined in
 
-### invalid?
+node_modules/@react-types/shared/src/dom.d.ts:62
 
-> `optional` **invalid**: `boolean`
+___
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L54)
+### invalid
 
-Whether the input value is invalid.
+• `Optional` **invalid**: `boolean`
 
-***
-
-### invalidText?
-
-> `optional` **invalidText**: `string`
-
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L56)
-
-Text to show if the input is invalid e.g. an error message
-
-***
-
-### isDateUnavailable()?
-
-> `optional` **isDateUnavailable**: (`date`) => `boolean`
-
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:46
-
-Callback that is called for each date of the calendar. If it returns true, then the date is unavailable.
+Whether the input value is invalid.
 
-#### Parameters
+#### Defined in
 
-##### date
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L54)
 
-`DateValue`
+___
 
-#### Returns
+### invalidText
 
-`boolean`
+• `Optional` **invalidText**: `string`
 
-#### Inherited from
+Text to show if the input is invalid e.g. an error message
 
-`Omit.isDateUnavailable`
+#### Defined in
 
-***
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L56)
 
-### isDisabled?
+___
 
-> `optional` **isDisabled**: `boolean`
+### isDisabled
 
-Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:60
+• `Optional` **isDisabled**: `boolean`
 
 Whether the input is disabled.
 
 #### Inherited from
 
-`Omit.isDisabled`
+Omit.isDisabled
+
+#### Defined in
 
-***
+node_modules/@react-types/shared/src/inputs.d.ts:60
 
-### isInvalid?
+___
 
-> `optional` **isInvalid**: `boolean`
+### isInvalid
 
-Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:25
+• `Optional` **isInvalid**: `boolean`
 
 Whether the input value is invalid.
 
 #### Inherited from
 
-`Omit.isInvalid`
+Omit.isInvalid
+
+#### Defined in
 
-***
+node_modules/@react-types/shared/src/inputs.d.ts:25
 
-### isOpen?
+___
 
-> `optional` **isOpen**: `boolean`
+### isOpen
 
-Defined in: node\_modules/@react-types/overlays/src/index.d.ts:110
+• `Optional` **isOpen**: `boolean`
 
 Whether the overlay is open by default (controlled).
 
 #### Inherited from
 
-`Omit.isOpen`
+Omit.isOpen
 
-***
+#### Defined in
 
-### isReadOnly?
+node_modules/@react-types/overlays/src/index.d.ts:110
 
-> `optional` **isReadOnly**: `boolean`
+___
 
-Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:62
+### isReadOnly
+
+• `Optional` **isReadOnly**: `boolean`
 
 Whether the input can be selected but not changed by the user.
 
 #### Inherited from
 
-`Omit.isReadOnly`
+Omit.isReadOnly
+
+#### Defined in
 
-***
+node_modules/@react-types/shared/src/inputs.d.ts:62
 
-### isRequired?
+___
 
-> `optional` **isRequired**: `boolean`
+### isRequired
 
-Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:23
+• `Optional` **isRequired**: `boolean`
 
 Whether user input is required on the input before form submission.
 
 #### Inherited from
 
-`Omit.isRequired`
+Omit.isRequired
+
+#### Defined in
 
-***
+node_modules/@react-types/shared/src/inputs.d.ts:23
 
-### ~~label?~~
+___
 
-> `optional` **label**: `string` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
+### label
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:61](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L61)
+• `Optional` **label**: `string` \| `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`\>\>
 
 The label for this DatePicker element
 
-#### Deprecated
+**`deprecated`** Use labelText instead
 
-Use labelText instead
+#### Defined in
 
-***
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L61)
 
-### labelText?
+___
 
-> `optional` **labelText**: `string` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
+### labelText
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:63](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L63)
+• `Optional` **labelText**: `string` \| `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`\>\>
 
 The label for this DatePicker element.
 
-***
+#### Defined in
 
-### light?
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L63)
 
-> `optional` **light**: `boolean`
+___
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:65](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L65)
+### light
+
+• `Optional` **light**: `boolean`
 
 'true' to use the light version.
 
-***
+#### Defined in
+
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L65)
 
-### maxDate?
+___
 
-> `optional` **maxDate**: `DateInputValue`
+### maxDate
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L67)
+• `Optional` **maxDate**: `DateInputValue`
 
 The latest date it is possible to select
 
-***
+#### Defined in
+
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L67)
 
-### maxValue?
+___
 
-> `optional` **maxValue**: `null` \| `DateValue`
+### maxValue
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:44
+• `Optional` **maxValue**: ``null`` \| `DateValue`
 
 The maximum allowed date that a user may select.
 
 #### Inherited from
 
-`Omit.maxValue`
+Omit.maxValue
 
-***
+#### Defined in
 
-### minDate?
+node_modules/@react-types/datepicker/src/index.d.ts:44
 
-> `optional` **minDate**: `DateInputValue`
+___
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:69](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L69)
+### minDate
+
+• `Optional` **minDate**: `DateInputValue`
 
 The earliest date it is possible to select
 
-***
+#### Defined in
+
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L69)
 
-### minValue?
+___
 
-> `optional` **minValue**: `null` \| `DateValue`
+### minValue
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:42
+• `Optional` **minValue**: ``null`` \| `DateValue`
 
 The minimum allowed date that a user may select.
 
 #### Inherited from
 
-`Omit.minValue`
+Omit.minValue
 
-***
+#### Defined in
 
-### name?
+node_modules/@react-types/datepicker/src/index.d.ts:42
 
-> `optional` **name**: `string`
+___
 
-Defined in: node\_modules/@react-types/shared/src/dom.d.ts:130
+### name
+
+• `Optional` **name**: `string`
 
 The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
 
 #### Inherited from
 
-`Omit.name`
+Omit.name
 
-***
+#### Defined in
 
-### onBlur()?
+node_modules/@react-types/shared/src/dom.d.ts:130
 
-> `optional` **onBlur**: (`e`) => `void`
+___
 
-Defined in: node\_modules/@react-types/shared/src/events.d.ts:87
+### pageBehavior
 
-Handler that is called when the element loses focus.
+• `Optional` **pageBehavior**: `PageBehavior`
 
-#### Parameters
+Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration.
 
-##### e
+**`default`** visible
 
-`FocusEvent`\<`Element`\>
+#### Inherited from
 
-#### Returns
+Omit.pageBehavior
 
-`void`
+#### Defined in
+
+node_modules/@react-types/datepicker/src/index.d.ts:74
+
+___
+
+### placeholderValue
+
+• `Optional` **placeholderValue**: ``null`` \| `CalendarDate`
+
+A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight.
 
 #### Inherited from
 
-`Omit.onBlur`
+Omit.placeholderValue
 
-***
+#### Defined in
 
-### onChange()?
+node_modules/@react-types/datepicker/src/index.d.ts:48
 
-> `optional` **onChange**: (`value`) => `void`
+___
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:71](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L71)
+### short
 
-Handler that is called when the value changes.
+• `Optional` **short**: `boolean`
 
-#### Parameters
+'true' to use the short version.
 
-##### value
+#### Defined in
 
-`undefined` | `null` | `Date`
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L77)
 
-#### Returns
+___
 
-`void`
+### shouldCloseOnSelect
 
-***
+• `Optional` **shouldCloseOnSelect**: `boolean` \| () => `boolean`
 
-### onChangeRaw()?
+Determines whether the date picker popover should close automatically when a date is selected.
 
-> `optional` **onChangeRaw**: (`value`) => `void`
+**`default`** true
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:73](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L73)
+#### Inherited from
 
-Handler that is called when the value changes. Note that this provides types from @internationalized/date.
+Omit.shouldCloseOnSelect
 
-#### Parameters
+#### Defined in
 
-##### value
+node_modules/@react-stately/datepicker/dist/types.d.ts:21
 
-`null` | `DateValue`
+___
 
-#### Returns
+### shouldForceLeadingZeros
 
-`void`
+• `Optional` **shouldForceLeadingZeros**: `boolean`
 
-***
+Whether to always show leading zeros in the month, day, and hour fields.
+By default, this is determined by the user's locale.
 
-### onFocus()?
+#### Inherited from
 
-> `optional` **onFocus**: (`e`) => `void`
+Omit.shouldForceLeadingZeros
 
-Defined in: node\_modules/@react-types/shared/src/events.d.ts:85
+#### Defined in
 
-Handler that is called when the element receives focus.
+node_modules/@react-types/datepicker/src/index.d.ts:62
 
-#### Parameters
+___
 
-##### e
+### size
 
-`FocusEvent`\<`Element`\>
+• `Optional` **size**: ``"sm"`` \| ``"md"`` \| ``"lg"``
 
-#### Returns
+Specifies the size of the input. Currently supports either `sm`, `md`, or `lg` as an option
 
-`void`
+#### Defined in
 
-#### Inherited from
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L75)
+
+___
 
-`Omit.onFocus`
+### slot
 
-***
+• `Optional` **slot**: ``null`` \| `string`
 
-### onFocusChange()?
+A slot name for the component. Slots allow the component to receive props from a parent component.
+An explicit `null` value indicates that the local props completely override all props received from a parent.
 
-> `optional` **onFocusChange**: (`isFocused`) => `void`
+#### Inherited from
 
-Defined in: node\_modules/@react-types/shared/src/events.d.ts:89
+Omit.slot
 
-Handler that is called when the element's focus status changes.
+#### Defined in
 
-#### Parameters
+node_modules/react-aria-components/dist/types.d.ts:70
 
-##### isFocused
+___
 
-`boolean`
+### style
 
-#### Returns
+• `Optional` **style**: `CSSProperties` \| (`values`: `DatePickerRenderProps` & { `defaultStyle`: `CSSProperties`  }) => `undefined` \| `CSSProperties`
 
-`void`
+The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
 
 #### Inherited from
 
-`Omit.onFocusChange`
+Omit.style
 
-***
+#### Defined in
 
-### onKeyDown()?
+node_modules/react-aria-components/dist/types.d.ts:47
 
-> `optional` **onKeyDown**: (`e`) => `void`
+___
 
-Defined in: node\_modules/@react-types/shared/src/events.d.ts:78
+### validationBehavior
 
-Handler that is called when a key is pressed.
+• `Optional` **validationBehavior**: ``"aria"`` \| ``"native"``
 
-#### Parameters
+Whether to use native HTML form validation to prevent form submission
+when the value is missing or invalid, or mark the field as required
+or invalid via ARIA.
 
-##### e
+**`default`** 'native'
 
-`KeyboardEvent`
+#### Inherited from
 
-#### Returns
+Omit.validationBehavior
 
-`void`
+#### Defined in
 
-#### Inherited from
+node_modules/react-aria-components/dist/types.d.ts:81
 
-`Omit.onKeyDown`
+___
 
-***
+### value
 
-### onKeyUp()?
+• `Optional` **value**: `DateInputValue`
 
-> `optional` **onKeyUp**: (`e`) => `void`
+The value (controlled)
 
-Defined in: node\_modules/@react-types/shared/src/events.d.ts:80
+#### Defined in
 
-Handler that is called when a key is released.
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L79)
 
-#### Parameters
+## Methods
+
+### isDateUnavailable
 
-##### e
+▸ `Optional` **isDateUnavailable**(`date`): `boolean`
 
-`KeyboardEvent`
+Callback that is called for each date of the calendar. If it returns true, then the date is unavailable.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `date` | `DateValue` |
 
 #### Returns
 
-`void`
+`boolean`
 
 #### Inherited from
 
-`Omit.onKeyUp`
+Omit.isDateUnavailable
 
-***
+#### Defined in
 
-### onOpenChange()?
+node_modules/@react-types/datepicker/src/index.d.ts:46
 
-> `optional` **onOpenChange**: (`isOpen`) => `void`
+___
 
-Defined in: node\_modules/@react-types/overlays/src/index.d.ts:114
+### onBlur
 
-Handler that is called when the overlay's open state changes.
+▸ `Optional` **onBlur**(`e`): `void`
+
+Handler that is called when the element loses focus.
 
 #### Parameters
 
-##### isOpen
-
-`boolean`
+| Name | Type |
+| :------ | :------ |
+| `e` | `FocusEvent`<`Target`, `Element`\> |
 
 #### Returns
 
@@ -596,181 +703,211 @@ Handler that is called when the overlay's open state changes.
 
 #### Inherited from
 
-`Omit.onOpenChange`
+Omit.onBlur
 
-***
+#### Defined in
 
-### pageBehavior?
+node_modules/@react-types/shared/src/events.d.ts:87
 
-> `optional` **pageBehavior**: `PageBehavior`
+___
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:74
+### onChange
 
-Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration.
+▸ `Optional` **onChange**(`value`): `void`
 
-#### Default
+Handler that is called when the value changes.
 
-```ts
-visible
-```
+#### Parameters
 
-#### Inherited from
+| Name | Type |
+| :------ | :------ |
+| `value` | `undefined` \| ``null`` \| `Date` |
 
-`Omit.pageBehavior`
+#### Returns
 
-***
+`void`
 
-### placeholderValue?
+#### Defined in
 
-> `optional` **placeholderValue**: `null` \| `CalendarDate`
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L71)
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:48
+___
 
-A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight.
+### onChangeRaw
 
-#### Inherited from
+▸ `Optional` **onChangeRaw**(`value`): `void`
+
+Handler that is called when the value changes. Note that this provides types from @internationalized/date.
+
+#### Parameters
 
-`Omit.placeholderValue`
+| Name | Type |
+| :------ | :------ |
+| `value` | ``null`` \| `DateValue` |
 
-***
+#### Returns
 
-### short?
+`void`
 
-> `optional` **short**: `boolean`
+#### Defined in
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:77](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L77)
+[packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L73)
 
-'true' to use the short version.
+___
 
-***
+### onFocus
 
-### shouldCloseOnSelect?
+▸ `Optional` **onFocus**(`e`): `void`
 
-> `optional` **shouldCloseOnSelect**: `boolean` \| () => `boolean`
+Handler that is called when the element receives focus.
 
-Defined in: node\_modules/@react-stately/datepicker/dist/types.d.ts:21
+#### Parameters
 
-Determines whether the date picker popover should close automatically when a date is selected.
+| Name | Type |
+| :------ | :------ |
+| `e` | `FocusEvent`<`Target`, `Element`\> |
 
-#### Default
+#### Returns
 
-```ts
-true
-```
+`void`
 
 #### Inherited from
 
-`Omit.shouldCloseOnSelect`
+Omit.onFocus
 
-***
+#### Defined in
 
-### shouldForceLeadingZeros?
+node_modules/@react-types/shared/src/events.d.ts:85
 
-> `optional` **shouldForceLeadingZeros**: `boolean`
+___
 
-Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:62
+### onFocusChange
 
-Whether to always show leading zeros in the month, day, and hour fields.
-By default, this is determined by the user's locale.
+▸ `Optional` **onFocusChange**(`isFocused`): `void`
+
+Handler that is called when the element's focus status changes.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `isFocused` | `boolean` |
+
+#### Returns
+
+`void`
 
 #### Inherited from
 
-`Omit.shouldForceLeadingZeros`
+Omit.onFocusChange
 
-***
+#### Defined in
 
-### size?
+node_modules/@react-types/shared/src/events.d.ts:89
 
-> `optional` **size**: `"sm"` \| `"md"` \| `"lg"`
+___
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:75](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L75)
+### onKeyDown
 
-Specifies the size of the input. Currently supports either `sm`, `md`, or `lg` as an option
+▸ `Optional` **onKeyDown**(`e`): `void`
 
-***
+Handler that is called when a key is pressed.
 
-### slot?
+#### Parameters
 
-> `optional` **slot**: `null` \| `string`
+| Name | Type |
+| :------ | :------ |
+| `e` | `KeyboardEvent` |
 
-Defined in: node\_modules/react-aria-components/dist/types.d.ts:70
+#### Returns
 
-A slot name for the component. Slots allow the component to receive props from a parent component.
-An explicit `null` value indicates that the local props completely override all props received from a parent.
+`void`
 
 #### Inherited from
 
-`Omit.slot`
+Omit.onKeyDown
 
-***
+#### Defined in
 
-### style?
+node_modules/@react-types/shared/src/events.d.ts:78
 
-> `optional` **style**: `CSSProperties` \| (`values`) => `undefined` \| `CSSProperties`
+___
 
-Defined in: node\_modules/react-aria-components/dist/types.d.ts:47
+### onKeyUp
 
-The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
+▸ `Optional` **onKeyUp**(`e`): `void`
+
+Handler that is called when a key is released.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `e` | `KeyboardEvent` |
+
+#### Returns
+
+`void`
 
 #### Inherited from
 
-`Omit.style`
+Omit.onKeyUp
 
-***
+#### Defined in
 
-### validate()?
+node_modules/@react-types/shared/src/events.d.ts:80
 
-> `optional` **validate**: (`value`) => `undefined` \| `null` \| `true` \| `ValidationError`
+___
 
-Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:41
+### onOpenChange
 
-A function that returns an error message if a given value is invalid.
-Validation errors are displayed to the user when the form is submitted
-if `validationBehavior="native"`. For realtime validation, use the `isInvalid`
-prop instead.
+▸ `Optional` **onOpenChange**(`isOpen`): `void`
 
-#### Parameters
+Handler that is called when the overlay's open state changes.
 
-##### value
+#### Parameters
 
-`CalendarDate`
+| Name | Type |
+| :------ | :------ |
+| `isOpen` | `boolean` |
 
 #### Returns
 
-`undefined` \| `null` \| `true` \| `ValidationError`
+`void`
 
 #### Inherited from
 
-`Omit.validate`
+Omit.onOpenChange
 
-***
+#### Defined in
 
-### validationBehavior?
+node_modules/@react-types/overlays/src/index.d.ts:114
 
-> `optional` **validationBehavior**: `"aria"` \| `"native"`
+___
 
-Defined in: node\_modules/react-aria-components/dist/types.d.ts:81
+### validate
 
-Whether to use native HTML form validation to prevent form submission
-when the value is missing or invalid, or mark the field as required
-or invalid via ARIA.
+▸ `Optional` **validate**(`value`): `undefined` \| ``null`` \| ``true`` \| `ValidationError`
 
-#### Default
+A function that returns an error message if a given value is invalid.
+Validation errors are displayed to the user when the form is submitted
+if `validationBehavior="native"`. For realtime validation, use the `isInvalid`
+prop instead.
 
-```ts
-'native'
-```
+#### Parameters
 
-#### Inherited from
+| Name | Type |
+| :------ | :------ |
+| `value` | `T` |
 
-`Omit.validationBehavior`
+#### Returns
 
-***
+`undefined` \| ``null`` \| ``true`` \| `ValidationError`
 
-### value?
+#### Inherited from
 
-> `optional` **value**: `DateInputValue`
+Omit.validate
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:79](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L79)
+#### Defined in
 
-The value (controlled)
+node_modules/@react-types/shared/src/inputs.d.ts:41