Skip to content
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.

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

docs(VDatePicker): remove display-value from props list #20879

Merged

Conversation

J-Sek
Copy link
Contributor

@J-Sek J-Sek commented Jan 17, 2025

Description

display-value does not affect VDatePicker and should not appear in API docs to avoid confusion

resolves #20863

@J-Sek J-Sek changed the title docs(VDatePicker): hide displayValue from props list docs(VDatePicker): hide display-value from props list Jan 17, 2025
@J-Sek J-Sek self-assigned this Jan 17, 2025
@KaelWD
Copy link
Member

KaelWD commented Feb 3, 2025

v2 had the ability to display a different date as "today" that seems to be missing in v3: https://v2.vuetifyjs.com/en/components/date-pickers/#show-current

@J-Sek
Copy link
Contributor Author

J-Sek commented Feb 3, 2025

Not sure if show-current is even in the same ballpark. The issue touches more on picker-date in v2 that got split into two props but might surprise people that expect 2-way binding to work. Personally I don't find it big of a problem at the moment and would opt for keeping the current behavior while making sure API docs are tidy.

@J-Sek J-Sek requested a review from johnleider February 3, 2025 12:34
Comment on lines 61 to 64
const { daysInMonth, model, weekNumbers } = useCalendar({
...props,
displayValue: null,
})
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts on reverting this and instead making displayValue optional in the CalendarProps interface?
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, it should not be required in CalendarProps.

@J-Sek J-Sek force-pushed the fix/20863-datepicker-displayValue branch from 8775ade to 50a4aed Compare February 6, 2025 18:25
@J-Sek J-Sek requested a review from johnleider February 6, 2025 18:25
@johnleider johnleider added this to the v3.7.x milestone Feb 10, 2025
@johnleider johnleider changed the title docs(VDatePicker): hide display-value from props list docs(VDatePicker): remove display-value from props list Feb 10, 2025
@johnleider johnleider merged commit 9d30fa5 into vuetifyjs:master Feb 10, 2025
10 checks passed
@J-Sek J-Sek deleted the fix/20863-datepicker-displayValue branch February 10, 2025 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug Report][3.7.6] VDatePicker display-value prop doesn’t work
3 participants