feat(modal): programmatically move to a breakpoint #24648
Conversation
# Conflicts: # core/src/components/modal/gestures/sheet.ts
# Conflicts: # core/src/components/modal/gestures/sheet.ts
# Conflicts: # core/src/components/modal/gestures/sheet.ts
Have one suggested change for the public API naming for setting the breakpoint value.
Reviewed most of the changes here and they align with our internal feature design document. I would like to introduce a set of e2e tests on this new behavior, mainly to verify correct event emission and a few screenshot tests. I'll clone your fork this week and experiment with your changes to verify everything works correctly and will suggest a few tests on the new behavior.
Thanks for the great work here!
|
@sean-perkins Changes applied |
We are getting close! Had one question.
I need to sync with the team tomorrow, trying to figure out the best way to test/validate a breakpoint is transitioned to correctly. Currently added coverage for events emitting/breakpoint values being set correctly.
Also due to the way we overwrite the implementation of ion-modal in Angular, I need to add a small set of e2e tests to our Angular test app to validate event emissions. I should be able to finish this piece tonight.
Did a fresh review based on the current state and I do not see any outstanding changes. I am going to add the team for review. They may come back with changes or additional suggestions.
I opted for not documenting the new API extensively in our usage docs, since it's a public method API and not really a usage pattern. I'm open to ideas on how to document it, if we feel there is value in doing so. Currently I could not justify it over vs. people looking at the generated API docs and seeing getBreakpoint and setCurrentBreakpoint.
Thanks for the heavy lifting on this feature and being available for quick changes + answering questions via Discord. Really appreciate the help on this. This is such a cool feature!
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally and any changes were pushednpm run lint) has passed locally and any fixes were made for failuresPull request type
Please check the type of change your PR introduces:
What is the current behavior?
Developers cannot programmatically move a sheet modal breakpoint with an API.
Issue Number: #23917
What is the new behavior?
setCurrentBreakpoint(breakpoint: number)to programmatically change the breakpoint of a sheet modal.getBreakpoint()to get the active breakpoint value for a sheet modal.ionModalBreakpointWillChange/breakpointWillChangeevent when the breakpoint is about to change.ionModalBreakpointDidChange/breakpointDidChangeevent when the breakpoint changes.Does this introduce a breaking change?
Other information