fix(button): focus method does not respect specified origin #17183
Conversation
This file contains hidden or 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
It looks like `MatButton` at some point has been refactored to implement the `FocusableOption` interface so that it can be used easily in the `FocusKeyManager`. Currently since the `origin` parameter in the `focus` method is not respected, the `FocusKeyManager#setFocusOrigin` method is a noop for button elements. Additionally consumers of `MatButton` who pass in a specific `FocusOrigin` when calling the `focus` method will be surprised that the `origin` is simply ignored (even though it's part of the public method signature; just prefixed with an underscore). We should just respect the focus origin to make the method less confusing and to properly implement the `FocusableOption`. Fixes angular#17174
devversion
added
the
target: patch
googlebot
added
the
cla: yes
jelbourn
added
pr: lgtm
action: merge
paulferaud
reviewed
Sep 27, 2019
| // Note that we aren't using `_origin`, but we need to keep it because some internal consumers | ||
| // use `MatButton` in a `FocusKeyManager` and we need it to match `FocusableOption`. | ||
| this._getHostElement().focus(options); | ||
| focus(origin: FocusOrigin = 'program', options?: FocusOptions): void { |
Contributor
There was a problem hiding this comment.
FocusOrigin has the definition 'touch' | 'mouse' | 'keyboard' | 'program' | null; (Notice the null)
I think the correct(-er) fix would be to do:
focus(origin: FocusOrigin = null, options?: FocusOptions)
And let the FocusMonitor handle it however it wants to handle an unset FocusOrigin (which happens to be to treat it as 'program').
Member
Author
There was a problem hiding this comment.
I see your point. But I feel like explicitly having program as default is reasonable since this method intends to focus the button programmatically (unless a specific origin had been specified)
andrewseguin
pushed a commit
that referenced
this pull request
Sep 30, 2019
It looks like `MatButton` at some point has been refactored to implement the `FocusableOption` interface so that it can be used easily in the `FocusKeyManager`. Currently since the `origin` parameter in the `focus` method is not respected, the `FocusKeyManager#setFocusOrigin` method is a noop for button elements. Additionally consumers of `MatButton` who pass in a specific `FocusOrigin` when calling the `focus` method will be surprised that the `origin` is simply ignored (even though it's part of the public method signature; just prefixed with an underscore). We should just respect the focus origin to make the method less confusing and to properly implement the `FocusableOption`. Fixes #17174 (cherry picked from commit 1c307c8)
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
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.
It looks like
MatButtonat some point has been refactoredto implement the
FocusableOptioninterface so that it canbe used easily in the
FocusKeyManager.Currently since the
originparameter in thefocusmethodis not respected, the
FocusKeyManager#setFocusOriginmethodis a noop for button elements. Additionally consumers of
MatButtonwho pass in a specificFocusOriginwhen callingthe
focusmethod will be surprised that theoriginis simplyignored (even though it's part of the public method signature; just
prefixed with an underscore).
We should just respect the focus origin to make the method
less confusing and to properly implement the
FocusableOption.Fixes #17174