Add backButtonClicked event to page component #2316
Merged
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
github-actions
bot
temporarily deployed
to
pr-2119-add-back-button-click-event-to-page
MadsBuchmann
suggested changes
Jun 14, 2022
| @@ -161,6 +161,7 @@ export class PageComponent | |||
| @Output() enter = new EventEmitter<void>(); | |||
| @Output() leave = new EventEmitter<void>(); | |||
| @Output() refresh = new EventEmitter<PullToRefreshEvent>(); | |||
| @Output() backButtonClicked = new EventEmitter<Event>(); | |||
There was a problem hiding this comment.
Looking at this again i think we should change the name to be in imperative form, considering other events are named like that as well :D
Suggested change
| @Output() backButtonClicked = new EventEmitter<Event>(); | |
| @Output() backButtonClick = new EventEmitter<Event>(); |
| @@ -259,6 +262,16 @@ export class PageComponent | |||
| this.windowRef.nativeWindow.addEventListener(selectedTabClickEvent, () => { | |||
| this.content.scrollToTop(KirbyAnimation.Duration.LONG); | |||
| }); | |||
|
|
|||
| // Intercept back-button click events, defaulting to the built-in click-handler. | |||
| if (this.backButtonClicked.length == 0) { | |||
There was a problem hiding this comment.
Are there a specific reason for using the equality - instead of the identity operator?
Personally i prefer the more strict identity operator as it is more predictable how it will behave 😄
Suggested change
| if (this.backButtonClicked.length == 0) { | |
| if (this.backButtonClicked.length === 0) { |
Comment on lines
266
to
274
| // Intercept back-button click events, defaulting to the built-in click-handler. | ||
| if (this.backButtonClicked.length == 0) { | ||
| this.backButtonClicked | ||
| .pipe(takeUntil(this.ngOnDestroy$)) | ||
| .subscribe(this.backButtonDelegate.onClick.bind(this.backButtonDelegate)); | ||
| } | ||
| this.backButtonDelegate.onClick = (event: Event) => { | ||
| this.backButtonClicked.emit(event); | ||
| }; |
There was a problem hiding this comment.
We could consider separating all of this into a InterceptBackButtonClicksSetup method (or similar) to make it more clear that this code belongs together and what its responsibility is
Comment on lines
144
to
169
| describe('with a back-button-clicked observer', () => { | ||
| it('should emit an event when the back button is clicked', () => { | ||
| const ionBackButton = spectator.queryHost('ion-toolbar ion-buttons ion-back-button'); | ||
| const subscriber = jasmine.createSpy(); | ||
| spectator.output('backButtonClicked').subscribe(subscriber); | ||
|
|
||
| spectator.click(ionBackButton); | ||
| spectator.detectComponentChanges(); | ||
|
|
||
| expect(subscriber).toHaveBeenCalledTimes(1); | ||
| }); | ||
| }); | ||
|
|
There was a problem hiding this comment.
We could also add a test which checks that the default behaviour is executed whenever no observer is present
mictro
force-pushed
the
enhancement/2119-add-back-button-click-event-to-page
branch
from
de9e84b to
e7d9041
Compare
mictro
force-pushed
the
enhancement/2119-add-back-button-click-event-to-page
branch
from
e7d9041 to
fc9fa15
Compare
mictro
requested review from
RasmusKjeldgaard and
MadsBuchmann
and removed request for
MadsBuchmann
github-actions
bot
temporarily deployed
to
pr-2119-add-back-button-click-event-to-page
github-actions
bot
temporarily deployed
to
pr-2119-add-back-button-click-event-to-page
MadsBuchmann
suggested changes
Jun 17, 2022
| @@ -86,6 +86,12 @@ export class PageShowcaseComponent { | |||
| description: 'Emitted when leaving the page', | |||
| signature: 'func', | |||
| }, | |||
| { | |||
| name: 'backButtonClicked', | |||
There was a problem hiding this comment.
Suggested change
| name: 'backButtonClicked', | |
| name: 'backButtonClick', |
There was a problem hiding this comment.
Updated and regenerated mock
mictro
force-pushed
the
enhancement/2119-add-back-button-click-event-to-page
branch
from
4d19f42 to
a998ff9
Compare
Merged
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.
Which issue does this PR close?
This PR closes #2119
What is the new behavior?
Add a back-button event-emitter outpput option to page component. When set the default back-button behaviour is removed.
Does this PR introduce a breaking change?
Are there any additional context?
This change allows applications to navigate past the routing restrictions present in micro-frontends.
Checklist:
The following tasks should be carried out in sequence in order to follow the process of contributing correctly.
Reminders
Review
When the pull request has been approved it will be merged to
developby Team Kirby.