mirror of
https://github.com/flutter/flutter.git
synced 2026-02-20 02:29:02 +08:00
[widgets/raw_menu_anchor.dart] Fixed minor typos and applied style guide suggestions (#162805)
This PR fixes minor typos in the RawMenuAnchor docs. I didn't include tests because the changes are minor. ## 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]. - [] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [] 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
This commit is contained in:
parent
895cab5bd7
commit
76d7910e95
@ -92,18 +92,19 @@ class RawMenuOverlayInfo {
|
||||
}
|
||||
}
|
||||
|
||||
/// The type of builder function used by [RawMenuAnchor] to build
|
||||
/// the overlay attached to a [RawMenuAnchor].
|
||||
/// Signature for the builder function used by [RawMenuAnchor.overlayBuilder] to
|
||||
/// build a menu's overlay.
|
||||
///
|
||||
/// The `context` is the context that the overlay is being built in.
|
||||
///
|
||||
/// The `info` describes the info of the menu overlay for the
|
||||
/// [RawMenuAnchor] constructor.
|
||||
/// The `info` describes the anchor's [Rect], the [Size] of the overlay,
|
||||
/// the [TapRegion.groupId] used by members of the menu system, and the
|
||||
/// `position` argument passed to [MenuController.open].
|
||||
typedef RawMenuAnchorOverlayBuilder =
|
||||
Widget Function(BuildContext context, RawMenuOverlayInfo info);
|
||||
|
||||
/// The type of builder function used by [RawMenuAnchor.builder] to build the
|
||||
/// widget that the [RawMenuAnchor] surrounds.
|
||||
/// Signature for the builder function used by [RawMenuAnchor.builder] to build
|
||||
/// the widget that the [RawMenuAnchor] surrounds.
|
||||
///
|
||||
/// The `context` is the context in which the anchor is being built.
|
||||
///
|
||||
@ -116,10 +117,8 @@ typedef RawMenuAnchorOverlayBuilder =
|
||||
typedef RawMenuAnchorChildBuilder =
|
||||
Widget Function(BuildContext context, MenuController controller, Widget? child);
|
||||
|
||||
// An inherited widget that provides the [RawMenuAnchor] to its descendants.
|
||||
//
|
||||
// Used to notify anchor descendants when the menu opens and closes, and to
|
||||
// access the anchor's controller.
|
||||
// An [InheritedWidget] used to notify anchor descendants when a menu opens
|
||||
// and closes, and to pass the anchor's controller to descendants.
|
||||
class _MenuControllerScope extends InheritedWidget {
|
||||
const _MenuControllerScope({
|
||||
required this.isOpen,
|
||||
@ -159,7 +158,7 @@ class _MenuControllerScope extends InheritedWidget {
|
||||
///
|
||||
/// {@tool dartpad}
|
||||
///
|
||||
/// This example uses a [RawMenuAnchor] to build an a basic select menu with
|
||||
/// This example uses a [RawMenuAnchor] to build a basic select menu with
|
||||
/// four items.
|
||||
///
|
||||
/// ** See code in examples/api/lib/widgets/raw_menu_anchor/raw_menu_anchor.0.dart **
|
||||
@ -298,7 +297,7 @@ mixin _RawMenuAnchorBaseMixin<T extends StatefulWidget> on State<T> {
|
||||
/// [_RawMenuAnchorBaseMixin] will create and manage its own.
|
||||
MenuController get menuController;
|
||||
|
||||
/// Whether this menu layer is open.
|
||||
/// Whether this submenu's overlay is visible.
|
||||
@protected
|
||||
bool get isOpen;
|
||||
|
||||
@ -648,8 +647,8 @@ class _RawMenuAnchorState extends State<RawMenuAnchor> with _RawMenuAnchorBaseMi
|
||||
/// {@tool dartpad}
|
||||
///
|
||||
/// This example uses [RawMenuAnchorGroup] to build a menu bar with four
|
||||
/// submenus. Hovering over menu items opens their respective submenus.
|
||||
/// Selecting a menu item will close the menu and update the selected item text.
|
||||
/// submenus. Hovering over a menu item opens its respective submenu. Selecting
|
||||
/// a menu item will close the menu and update the selected item text.
|
||||
///
|
||||
/// ** See code in examples/api/lib/widgets/raw_menu_anchor/raw_menu_anchor.1.dart **
|
||||
/// {@end-tool}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user