diff --git a/resources/js/components/ui/DatePicker/DatePicker.vue b/resources/js/components/ui/DatePicker/DatePicker.vue index 48873df130f..bd6ed6c5c5b 100644 --- a/resources/js/components/ui/DatePicker/DatePicker.vue +++ b/resources/js/components/ui/DatePicker/DatePicker.vue @@ -31,11 +31,11 @@ const props = defineProps({ /** Badge text to display. */ badge: { type: String, default: null }, required: { type: Boolean, default: false }, - /** The controlled date value.

Should be an ISO 8601 date and time string with a UTC offset (eg. `2021-11-07T07:45:00Z` or `2021-11-07T07:45:00-07:00`) */ + /** The controlled date value.

Should be a [`DateValue` object](https://reka-ui.com/docs/guides/dates) or an ISO 8601 datetime string with a UTC offset. */ modelValue: { type: [Object, String], default: null }, - /** The minimum selectable date.

Should be an ISO 8601 date and time string with a UTC offset (eg. `2021-11-07T07:45:00Z` or `2021-11-07T07:45:00-07:00`) */ + /** The minimum selectable date.

Should be a [`DateValue` object](https://reka-ui.com/docs/guides/dates) or an ISO 8601 datetime string with a UTC offset. */ min: { type: [String, Object], default: null }, - /** The maximum selectable date.

Should be an ISO 8601 date and time string with a UTC offset (eg. `2021-11-07T07:45:00Z` or `2021-11-07T07:45:00-07:00`) */ + /** The maximum selectable date.

Should be a [`DateValue` object](https://reka-ui.com/docs/guides/dates) or an ISO 8601 datetime string with a UTC offset. */ max: { type: [String, Object], default: null }, /** The granularity of the date picker.

Options: `day`, `hour`, `minute`, `second` */ granularity: { type: String, default: null }, diff --git a/resources/js/components/ui/DateRangePicker/DateRangePicker.vue b/resources/js/components/ui/DateRangePicker/DateRangePicker.vue index 7f03e9bf8f8..1410c7943b5 100644 --- a/resources/js/components/ui/DateRangePicker/DateRangePicker.vue +++ b/resources/js/components/ui/DateRangePicker/DateRangePicker.vue @@ -31,11 +31,11 @@ const props = defineProps({ /** Badge text to display. */ badge: { type: String, default: null }, required: { type: Boolean, default: false }, - /** The controlled date range value with `start` and `end` properties.

Each should be an ISO 8601 date and time string with a UTC offset (eg. `2021-11-07T07:45:00Z` or `2021-11-07T07:45:00-07:00`) */ + /** The controlled date range value.

Should be a [`DateRange` object](https://reka-ui.com/docs/guides/dates) or an object with `start` and `end` keys, where each value is an ISO 8601 datetime string with a UTC offset. */ modelValue: { type: [Object, String], default: null }, - /** The minimum selectable date.

Should be an ISO 8601 date and time string with a UTC offset (eg. `2021-11-07T07:45:00Z` or `2021-11-07T07:45:00-07:00`) */ + /** The minimum selectable date.

Should be a [`DateValue` object](https://reka-ui.com/docs/guides/dates) or an ISO 8601 datetime string with a UTC offset. */ min: { type: [String, Object], default: null }, - /** The maximum selectable date.

Should be an ISO 8601 date and time string with a UTC offset (eg. `2021-11-07T07:45:00Z` or `2021-11-07T07:45:00-07:00`) */ + /** The maximum selectable date.

Should be a [`DateValue` object](https://reka-ui.com/docs/guides/dates) or an ISO 8601 datetime string with a UTC offset. */ max: { type: [String, Object], default: null }, /** The granularity of the date range picker.

Options: `day`, `hour`, `minute`, `second` */ granularity: { type: String, default: null }, diff --git a/resources/js/stories/DatePicker.stories.ts b/resources/js/stories/DatePicker.stories.ts index 3a48c4073a7..4c88d8800ef 100644 --- a/resources/js/stories/DatePicker.stories.ts +++ b/resources/js/stories/DatePicker.stories.ts @@ -12,10 +12,10 @@ const meta = { options: ['day', 'hour', 'minute', 'second'], }, 'update:modelValue': { - description: 'Event handler called when the date value changes. Returns the date as an ISO 8601 date and time string.', + description: 'Event handler called when the date value changes.

Returns a [`DateValue` object](https://reka-ui.com/docs/guides/dates).', table: { category: 'events', - type: { summary: '(value: string) => void' } + type: { summary: '(value: DateValue) => void' } } } }, diff --git a/resources/js/stories/DateRangePicker.stories.ts b/resources/js/stories/DateRangePicker.stories.ts index cf0179a4b34..4f29506c055 100644 --- a/resources/js/stories/DateRangePicker.stories.ts +++ b/resources/js/stories/DateRangePicker.stories.ts @@ -12,10 +12,10 @@ const meta = { options: ['day', 'hour', 'minute', 'second'], }, 'update:modelValue': { - description: 'Event handler called when the date range value changes.

Returns an object with `start` and `end` properties, each as an ISO 8601 date and time string.', + description: 'Event handler called when the date range value changes.

Returns a [`DateRange` object](https://reka-ui.com/docs/guides/dates).', table: { category: 'events', - type: { summary: '(value: { start: string, end: string }) => void' } + type: { summary: '(value: DateRange) => void' } } } },