mirror of https://github.com/flutter/flutter.git synced 2025-06-03 00:51:18 +00:00

History

davidhicks980 b29f8f7fb9 Implement RawMenuAnchor (#158255 ) This PR adds a `RawMenuAnchor()` widget to widgets.dart. The purpose of this widget is to provide a menu primitive for the Material and Cupertino libraries (and others) to build upon. Additionally, this PR makes MenuController an inherited widget to simplify nested access to the menu (e.g. if you want to launch a context menu from a deeply-nested widget). This PR: * Centralizes core menu logic to a private class,` _RawMenuAnchor()`, * Provides the internals for interacting with menus: * TapRegion interop * DismissMenuAction handler * Close on scroll/resize * Focus traversal information, if applicable * Subclasses override `_open`, `_close`, `_isOpen`, `_buildAnchor`, and `_menuScopeNode` * State is accessible by descendents via `MenuController.maybeOf(context)._anchor` * Adds 2 public constructors, backed by a `_RawMenuAnchor()` that contains shared logic. * `RawMenuAnchor()` * Users build the overlay from scratch. * Provides anchor/overlay position information and TapRegionGroupId to builder * Does not provide FocusScope management. * `RawMenuAnchorGroup()` * A primitive for menus that do not have overlays (menu bars). * This was previously called RawMenuAnchor.node(), but @dkwingsmt made a good case for splitting out the constructor. <s>Documentation examples have been added, and can be viewed at https://menu-anchor.web.app/</s> <s>https://github.com/user-attachments/assets/25d35f23-2aad-4d07-9172-5c3fd65d53cf</s> @dkwingsmt List which issues are fixed by this PR. https://github.com/flutter/flutter/pull/143712 Some issues that need to be addressed: Semantics: <img width="1027" alt="image" src="https://github.com/user-attachments/assets/d69661c9-8435-4d9c-b200-474968cb57eb"> I'm basing the menu semantics off of the comment [here](`ef3ca70db2/lib/web_ui/lib/src/engine/semantics/semantics.dart (L382)`), but I'm unsure whether the route should be given a name. There is no menubar/menu/menuitem role in Flutter, so I'm assuming the menu should be composed of nested dialogs <s>Unlike the menubar pattern from [W3C](https://www.w3.org/WAI/ARIA/apg/patterns/menubar/examples/menubar-navigation/), the RawMenuAnchor - does not close on tab/shift-tab. I left this behavior out of the menu so that users could customize tab behavior, but I'm not opinionated either way - does not open on ArrowUp/ArrowDown, because this could interfere with user focus behavior in unconventional menu setups (e.g. a vertical menu). - does not automatically focus the first item in a menu overlay when activated via enter/spacebar, but does focus the first item when horizontal traversal opens a submenu. Automatically focusing the first item whenever an overlay opens interferes with hover traversal, and I couldn't think of a good way to only focus the first item when an overlay is triggered via enter/spacebar. - doesn't focus disabled items (I wasn't sure how to address this without editing MenuItemButton) While it is possible to nest menus -- for example, a dropdown anchor within a full-app context menu area -- nested menus behave as a single group. I was considering adding an additional parameter that separates nested root menus from their parents, and am interested to hear your feedback.</s> If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy]. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md --------- Co-authored-by: Bruno Leroux <bruno.leroux@gmail.com> Co-authored-by: chunhtai <47866232+chunhtai@users.noreply.github.com>		2025-02-03 23:55:03 +00:00
..
api	Implement RawMenuAnchor (#158255 )	2025-02-03 23:55:03 +00:00
flutter_view	Bump characters, collection, meta (#161066 )	2025-01-03 02:23:10 +00:00
hello_world	Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (#162325 )	2025-01-30 15:26:56 +00:00
image_list	Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (#162325 )	2025-01-30 15:26:56 +00:00
layers	Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (#162325 )	2025-01-30 15:26:56 +00:00
platform_channel	Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (#162325 )	2025-01-30 15:26:56 +00:00
platform_channel_swift	Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (#162325 )	2025-01-30 15:26:56 +00:00
platform_view	Bump characters, collection, meta (#161066 )	2025-01-03 02:23:10 +00:00
splash	Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (#162325 )	2025-01-30 15:26:56 +00:00
texture	Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (#162325 )	2025-01-30 15:26:56 +00:00
.clang-format	Implement Linux part of examples (#108068 )	2022-12-08 08:44:11 +13:00
flutter_gallery.readme	Move flutter_gallery to the testing folder (#52532 )	2020-03-16 10:31:42 +01:00
README.md	Update flutter.dev links from misc packages to more permanent destinations (#150532 )	2024-06-20 23:09:08 +00:00

README.md

Flutter Examples

This directory contains several examples of using Flutter. To run an example, use flutter run inside that example's directory. See the getting started guide to install the flutter tool.

For additional samples, see the flutter/samples repo.

Available examples include:

Hello, world The hello world app is a minimal Flutter app that shows the text "Hello, world!"
Flutter gallery The flutter gallery app no longer lives in this repo. Please see the gallery repo.
Layers The layers vignettes show how to use the various layers in the Flutter framework. For details, see the layers README.
Platform Channel The platform channel app demonstrates how to connect a Flutter app to platform-specific APIs. For documentation, see https://flutter.dev/to/platform-channels/.
Platform Channel Swift The platform channel swift app is the same as platform channel but the iOS version is in Swift and there is no Android version.

Notes

Note on Gradle wrapper files in .gitignore:

Gradle wrapper files should normally be checked into source control. The example projects don't do that to avoid having several copies of the wrapper binary in the Flutter repo. Instead, the Gradle wrapper is injected by Flutter tooling, and the wrapper files are .gitignore'd to avoid making the Flutter repository dirty as a side effect of running the examples.