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.

Sign up for GitHub

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

Jump to bottom

Flutter views can gain focus #54985

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Flutter views can gain focus #54985

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
eea5707
Flutter view can gain focus.
tugorez Sep 5, 2024
bb10b63
Merge branch 'main' into view-focus-semantics
ditman Nov 5, 2024
b1c044d
Minor PR changes.
ditman Nov 6, 2024
8f843a7
Attach focusin/out to the rootElement of the view.
ditman Nov 12, 2024
9a28cfb
Merge branch 'main' into view-focus-semantics
ditman Nov 12, 2024
c096407
Use state properly in changeViewFocus.
ditman Nov 12, 2024
d735a65
Address PR comments.
ditman Nov 13, 2024
8ec21bb
Merge branch 'main' into view-focus-semantics
ditman Nov 14, 2024
5ef3d70
Merge branch 'main' into view-focus-semantics
ditman Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions lib/web_ui/lib/src/engine/platform_dispatcher/view_focus_binding.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ final class ViewFocusBinding {
direction: _viewFocusDirection,
);
}
_maybeMarkViewAsFocusable(_lastViewId, reachableByKeyboard: true);
_maybeMarkViewAsFocusable(viewId, reachableByKeyboard: false);
_updateViewFocusStatus(_lastViewId, reachableByKeyboard: true);
_updateViewFocusStatus(viewId, reachableByKeyboard: false);
_lastViewId = viewId;
_onViewFocusChange(event);
}
Expand All @@ -127,10 +127,10 @@ final class ViewFocusBinding {
}

void _handleViewCreated(int viewId) {
_maybeMarkViewAsFocusable(viewId, reachableByKeyboard: true);
_updateViewFocusStatus(viewId, reachableByKeyboard: true);
}

void _maybeMarkViewAsFocusable(
void _updateViewFocusStatus(
int? viewId, {
required bool reachableByKeyboard,
}) {
Expand All @@ -139,17 +139,13 @@ final class ViewFocusBinding {
}

final DomElement? rootElement = _viewManager[viewId]?.dom.rootElement;
if (EngineSemantics.instance.semanticsEnabled) {
rootElement?.removeAttribute('tabindex');
} else {
// A tabindex with value zero means the DOM element can be reached by using
// the keyboard (tab, shift + tab). When its value is -1 it is still focusable
// but can't be focused by the result of keyboard events This is specially
// important when the semantics tree is enabled as it puts DOM nodes inside
// the flutter view and having it with a zero tabindex messes the focus
// traversal order when pressing tab or shift tab.
rootElement?.setAttribute('tabindex', reachableByKeyboard ? 0 : -1);
}
// A tabindex with value zero means the DOM element can be reached by using
ditman marked this conversation as resolved.
Show resolved Hide resolved
// the keyboard (tab, shift + tab). When its value is -1 it is still focusable
// but can't be focused by the result of keyboard events This is specially
ditman marked this conversation as resolved.
Show resolved Hide resolved
// important when the semantics tree is enabled as it puts DOM nodes inside
// the flutter view and having it with a zero tabindex messes the focus
// traversal order when pressing tab or shift tab.
rootElement?.setAttribute('tabindex', reachableByKeyboard ? 0 : -1);
}

static const String _focusin = 'focusin';
Expand Down
22 changes: 0 additions & 22 deletions lib/web_ui/test/engine/platform_dispatcher/view_focus_binding_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,28 +68,6 @@ void testMain() {
expect(view2.dom.rootElement.getAttribute('tabindex'), '0');
});

test('never marks the views as focusable with semantincs enabled', () async {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also add some tests? :)

Copy link
Member

Choose a reason for hiding this comment

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

Well, there's tests already (this file is just showing the removed test, but there's others to verify the rest of the functionality!)

EngineSemantics.instance.semanticsEnabled = true;

final EngineFlutterView view1 = createAndRegisterView(dispatcher);
final EngineFlutterView view2 = createAndRegisterView(dispatcher);

expect(view1.dom.rootElement.getAttribute('tabindex'), isNull);
expect(view2.dom.rootElement.getAttribute('tabindex'), isNull);

view1.dom.rootElement.focusWithoutScroll();
expect(view1.dom.rootElement.getAttribute('tabindex'), isNull);
expect(view2.dom.rootElement.getAttribute('tabindex'), isNull);

view2.dom.rootElement.focusWithoutScroll();
expect(view1.dom.rootElement.getAttribute('tabindex'), isNull);
expect(view2.dom.rootElement.getAttribute('tabindex'), isNull);

view2.dom.rootElement.blur();
expect(view1.dom.rootElement.getAttribute('tabindex'), isNull);
expect(view2.dom.rootElement.getAttribute('tabindex'), isNull);
});

test('fires a focus event - a view was focused', () async {
final EngineFlutterView view = createAndRegisterView(dispatcher);

Expand Down