Skip to content

[6.x] Tweak modelValue descriptions for DatePicker components #13860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
duncanmcclean wants to merge 1 commit into
base: 6.x
Choose a base branch
from
Open

[6.x] Tweak modelValue descriptions for DatePicker components #13860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions resources/js/components/ui/DatePicker/DatePicker.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br><br> 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. <br><br> 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. <br><br> 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. <br><br> 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. <br><br> 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. <br><br> 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. <br><br> Options: `day`, `hour`, `minute`, `second` */
granularity: { type: String, default: null },
Expand Down
6 changes: 3 additions & 3 deletions resources/js/components/ui/DateRangePicker/DateRangePicker.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br><br> 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. <br><br> 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. <br><br> 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. <br><br> 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. <br><br> 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. <br><br> 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. <br><br> Options: `day`, `hour`, `minute`, `second` */
granularity: { type: String, default: null },
Expand Down
4 changes: 2 additions & 2 deletions resources/js/stories/DatePicker.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br><br> Returns a [`DateValue` object](https://reka-ui.com/docs/guides/dates).',
table: {
category: 'events',
type: { summary: '(value: string) => void' }
type: { summary: '(value: DateValue) => void' }
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions resources/js/stories/DateRangePicker.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ const meta = {
options: ['day', 'hour', 'minute', 'second'],
},
'update:modelValue': {
description: 'Event handler called when the date range value changes. <br><br> 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. <br><br> 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' }
}
}
},
Expand Down