Golden file changes have been found for this pull request. Click here to view and triage (e.g. because this is an intentional change).

If you are still iterating on this change and are not ready to resolve the images on the Flutter Gold dashboard, consider marking this PR as a draft pull request above. You will still be able to view image results on the dashboard, commenting will be silenced, and the check will not try to resolve itself until marked ready for review.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Changes reported for pull request #150125 at sha 95268c3

Golden file changes are available for triage from new commit, Click here to view.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Changes reported for pull request #150125 at sha 94471f9

I wonder if this could be handled by turning the tap outside behavior that happens inside of EditableText into an Intent. That would allow overriding of the action, allow passing of the FocusNode and event to the action, and not introduce yet another InheritedWidget that people need to discover.

It would be implemented similar to DeleteCharacterIntent/_DeleteTextAction, which is an overridable action on the text field in editable_text.dart.

Something like this:

class EditableTextTapOutsideIntent extends Intent {
	const EditableTextTapOutsideIntent({required this.focusNode, this.pointerDownEvent});

	final FocusNode focusNode;
	final PointerDownEvent pointerDownEvent;
}

And then, in editable_text.dart, you would create an action and make it overridable:

  late final Map<Type, Action<Intent>> _actions = <Type, Action<Intent>>{ // already exists
	// ...
  	EditableTextTapOutsideIntent: _makeOverridable(_EditableTextTapOutsideAction<EditableTextTapOutsideIntent>()),
	// ...
  };

class _EditableTextTapOutsideAction<T extends EditableTextTapOutsideIntent> extends ContextAction<T> {
	const _EditableTextTapOutsideAction();

  @override
  Object? invoke(T intent, [BuildContext? context]) {
    /// The focus dropping behavior is only present on desktop platforms
    /// and mobile browsers.
    switch (defaultTargetPlatform) {
      case TargetPlatform.android:
      case TargetPlatform.iOS:
      case TargetPlatform.fuchsia:
        // On mobile platforms, we don't unfocus on touch events unless they're
        // in the web browser, but we do unfocus for all other kinds of events.
        switch (intent.pointerDownEvent.kind) {
          case ui.PointerDeviceKind.touch:
            if (kIsWeb) {
              intentl.focusNode.unfocus();
            }
          case ui.PointerDeviceKind.mouse:
          case ui.PointerDeviceKind.stylus:
          case ui.PointerDeviceKind.invertedStylus:
          case ui.PointerDeviceKind.unknown:
            intent.focusNode.unfocus();
          case ui.PointerDeviceKind.trackpad:
            throw UnimplementedError(
                'Unexpected pointer down event for trackpad');
        }
      case TargetPlatform.linux:
      case TargetPlatform.macOS:
      case TargetPlatform.windows:
        intent.focusNode.unfocus();
    }
  }
}

And finally invoke it in EditableTextState:

  void _defaultOnTapOutside(PointerDownEvent event) {
	Actions.maybeInvoke(context, EditableTextTapOutsideIntent(event, widget.focusNode));
  }

To override it, you just define an Actions widget above the EditableText somewhere in the widget tree that maps EditableTextTapOutsideIntent to your custom action.

This way it would use an existing mechanism that is already part of EditableText, allows for overriding, and doesn't create a separate new mechanism that people need to discover and understand.

(fyi, I haven't tried compiling or running the above, it's just hot off the top of my keyboard)

(triage) @kubatatami Do you still have plans to follow up on the feedback given above?

@goderbauer Yes. I will try to follow up on the feedback early next week.

@gspencergoog @goderbauer I changed PR to use Intent and Actions. I used code prepared by @gspencergoog with minor changes. The only major changes I had to do were:

• change order of TextFieldTapRegion and Actions
• add a Builder widget to have a context that I can use to invoke Actions.invoke
• use Actions.invoke instead of Actions.maybeInvoke because we want to be sure that some action is always invoked (default or custom)

Hi @kubatatami , do you still plan to come back to this pr?

Hi @kubatatami , do you still plan to come back to this pr?

Yes. I will improve docs this week.

@gspencergoog @chunhtai More description added. Please let me know if there is anything else to improve.

A few nits here, but there's one thing that I think we should do before merging this. In the docs for onTapOutside, can you mention the new EditableTextTapOutsideIntent? I want to make sure both APIs are discoverable and avoid confusing users that might not realize setting onTapOutside will prevent triggering EditableTextTapOutsideIntent.

@justinmc Done. Please let me know if there is anything else to improve.