Skip to content

Dismiss modal routes with a keyboard shortcut - #59310

Merged
fluttergithubbot merged 4 commits into
flutter:masterfrom
darrenaustin:keyboard_dismiss
Jun 18, 2020
Merged

Dismiss modal routes with a keyboard shortcut#59310
fluttergithubbot merged 4 commits into
flutter:masterfrom
darrenaustin:keyboard_dismiss

Conversation

@darrenaustin

@darrenaustin darrenaustin commented Jun 12, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Currently there is no support for dismissing modal routes with the keyboard (usually with the 'escape' shortcut key). This PR adds a new general DismissIntent and corresponding DismissAction. The intent is mapped to the escape key in the default shortcut map, and modal routes (dialogs, popups, drawers, etc) will now look for this and dismiss themselves when it is triggered.

Related Issues

#49809

Tests

I added a simple test to verify that a modal dialog can be dismissed with the 'escape' key.

Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I signed the [CLA].
  • I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them?

  • No, no existing tests failed, so this is not a breaking change.

@fluttergithubbot

fluttergithubbot commented Jun 12, 2020

Copy link
Copy Markdown
Contributor

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat.

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

@fluttergithubbot fluttergithubbot added the framework flutter/packages/flutter repository. See also f: labels. label Jun 12, 2020
@darrenaustin
darrenaustin marked this pull request as draft June 12, 2020 07:12
@gspencergoog

gspencergoog commented Jun 12, 2020

Copy link
Copy Markdown
Contributor

This looks pretty good. We'll need to make sure that it is the right thing for the web, but otherwise I think all platforms use escape in this way.

@darrenaustin

darrenaustin commented Jun 12, 2020

Copy link
Copy Markdown
Contributor Author

This looks pretty good. We'll need to make sure that it is the right thing for the web, but otherwise I think all platforms use escape in this way.

Yeah, from a cursory look of a few webapps, it appears that escape to dismiss popups is pretty common.

I'll go ahead and flush this out with docs and tests to get this ready for review. Any thoughts about putting this on the _ModalScope? It seemed like the best place to me, but I am not that familiar with the route code.

@fluttergithubbot fluttergithubbot added p: material_ui material_ui package in flutter/packages work in progress; do not review labels Jun 12, 2020
@darrenaustin darrenaustin changed the title WIP: Modal DismissIntent/Action shortcut Dismiss modal routes with a keyboard shortcut Jun 12, 2020
@darrenaustin
darrenaustin marked this pull request as ready for review June 12, 2020 20:57
@darrenaustin
darrenaustin requested review from HansMuller, goderbauer and gspencergoog and removed request for gspencergoog June 12, 2020 20:57
@darrenaustin
Renamed the DismissIntent and Action to CancelIntent and CancelAction…
0c470a2 
… to reflect a more generic cancel/dismiss/back action.
HansMuller
HansMuller reviewed Jun 15, 2020
View reviewed changes

@HansMuller HansMuller left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, just wanted to get a few small clarifications.

Comment thread packages/flutter/lib/src/widgets/actions.dart Outdated
Comment thread packages/flutter/lib/src/widgets/actions.dart Outdated
HansMuller
HansMuller approved these changes Jun 15, 2020
View reviewed changes

@HansMuller HansMuller left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

Comment thread packages/flutter/lib/src/widgets/actions.dart Outdated
Comment thread packages/flutter/lib/src/widgets/actions.dart Outdated
gspencergoog
gspencergoog approved these changes Jun 18, 2020
View reviewed changes

@gspencergoog gspencergoog left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

32384589-a60f0e74-c078-11e7-9bc1-e5b5287aea9d

@fluttergithubbot
fluttergithubbot merged commit 06de567 into flutter:master Jun 18, 2020
@darrenaustin
darrenaustin deleted the keyboard_dismiss branch June 18, 2020 18:58
zljj0818 pushed a commit to zljj0818/flutter that referenced this pull request Jun 22, 2020
@darrenaustin @zljj0818
Dismiss modal routes with a keyboard shortcut (flutter#59310)
08ef9d7
@emshack emshack mentioned this pull request Jun 29, 2020
Closed
@darrenaustin darrenaustin mentioned this pull request Jul 7, 2020
Closed
mingwandroid pushed a commit to mingwandroid/flutter that referenced this pull request Sep 6, 2020
@darrenaustin @mingwandroid
Dismiss modal routes with a keyboard shortcut (flutter#59310)
99c03d7
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jul 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@gspencergoog gspencergoog gspencergoog approved these changes
@goderbauer goderbauer Awaiting requested review from goderbauer
+1 more reviewer
@HansMuller HansMuller HansMuller approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

framework flutter/packages/flutter repository. See also f: labels. p: material_ui material_ui package in flutter/packages

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@darrenaustin @fluttergithubbot @gspencergoog @HansMuller @googlebot