[pickers] Add new properties to PickerOwnerState and PickerContextValue
#15415
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flaviendelangle
added
the
component: pickers
flaviendelangle
force-pushed
the
variant-orientation-context
branch
from
0c9c094 to
6b86c85
Compare
flaviendelangle
commented
Nov 14, 2024
| extends Pick<PickerProviderProps, 'localeText'> { | ||
| pickerValueResponse: UsePickerValueResponse<TValue, FieldSection, any>; | ||
| ownerState: PickerOwnerState; | ||
| function getOrientation(): PickerOrientation { |
There was a problem hiding this comment.
This logic of getOrientation and usePickerOrientation comes from useIsLandscape which is used in usePickerLayoutProps and will be removed once we stop passing isLandscape as a prop to PickersLayout
|
Deploy preview: https://deploy-preview-15415--material-ui-x.netlify.app/ |
flaviendelangle
force-pushed
the
variant-orientation-context
branch
from
6b86c85 to
e82a694
Compare
flaviendelangle
changed the title
ownerState and to usePickerContextPickerOwnerState and PickerContextValue
flaviendelangle
force-pushed
the
variant-orientation-context
branch
from
e82a694 to
ea217ec
Compare
flaviendelangle
commented
Nov 14, 2024
| */ | ||
| export interface UsePickerProviderProps extends FormProps { | ||
| /** | ||
| * Force rendering in particular orientation. |
There was a problem hiding this comment.
It's the JSDoc we currently have in usePickersLayoutProps but it's probably not great 🤔
If you have a better one, I can apply it in a follow up (to avoid poluting this PR with all the doc gen)
There was a problem hiding this comment.
I would go with something like "Specifies the picker's orientation"
…o the private context
flaviendelangle
force-pushed
the
variant-orientation-context
branch
from
ea217ec to
b27b009
Compare
flaviendelangle
changed the title
PickerOwnerState and PickerContextValuePickerOwnerState and PickerContextValue
github-actions
bot
added
the
PR: out-of-date
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
github-actions
bot
removed
the
PR: out-of-date
packages/x-date-pickers/src/internals/hooks/usePicker/usePickerLayoutProps.ts
Show resolved
Hide resolved
arthurbalduini
approved these changes
Nov 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extracted from #15300
Part of #14475
Part of #14718
In this PR
Rename
wrapperVariantintovariant.I always found this name confusing. What is the "wrapper"? For now
wrapperVariantis only public in someownerStateand as a prop received byPickersLayout(and the toolbars have an equivalent prop namedtoolbarVariant), but if we add it to the public context and to all theownerState, we will make it widely used so I think it's important to think about its naming now.Side note: I did not rename them on any public API since the goal is to remove them and use the context instead.
Add
variant,orientation,disabledandreadOnlyto thePickerContextValueinterface (accessed viausePickerContext).I want to stop passing props to
PickersLayoutand to the toolbar components to prepare for the composition API so I need another way to access them. I'm adding it to the public context not to the private one because when creating a custom toolbar people currently have access to this info (through the props) and should continue to have access to it.Add
pickerVariantandpickerOrientationto thePickerOwnerStateinterface.I was relunctant to do it, but while working on [pickers] ON HOLD - Use the new
ownerStatein all the toolbars and stop passing variant and isLandscape to any component #15300 it was clear that we have a lot of slots (especiallystyled()components) that uses it and it's a pain to manually add it everytime.I went for
orientation/pickerOrientationinstead ofisLandscapebecause I think it provides a better DX and if we change how people access this information, it's also the right time to change the value. But I can revert toisLandscape/isPickerInLandscapeinstead if you prefer.