Add tooltip support to PlatformMenuItem and PlatformMenu. by ksokolovskyi · Pull Request #180069 · flutter/flutter

ksokolovskyi · 2025-12-18T15:00:54Z

Description

Adds tooltip support to PlatformMenuItem and PlatformMenu
Updates platform_menu_bar_test.dart to cover tooltip related changes and makes test-specific code private
Updates FlutterMenuPlugin.mm to support tooltip
Updates FlutterMenuPluginTest.mm to cover tooltip related changes

tooltips.mov

Code sample

// THIS SAMPLE ONLY WORKS ON MACOS.

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';

/// Flutter code sample for [PlatformMenuBar].

void main() => runApp(const ExampleApp());

enum MenuSelection { about, showMessage }

class ExampleApp extends StatelessWidget {
  const ExampleApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(home: Scaffold(body: PlatformMenuBarExample()));
  }
}

class PlatformMenuBarExample extends StatefulWidget {
  const PlatformMenuBarExample({super.key});

  @override
  State<PlatformMenuBarExample> createState() => _PlatformMenuBarExampleState();
}

class _PlatformMenuBarExampleState extends State<PlatformMenuBarExample> {
  String _message = 'Hello';
  bool _showMessage = false;

  void _handleMenuSelection(MenuSelection value) {
    switch (value) {
      case MenuSelection.about:
        showAboutDialog(
          context: context,
          applicationName: 'MenuBar Sample',
          applicationVersion: '1.0.0',
        );
      case MenuSelection.showMessage:
        setState(() {
          _showMessage = !_showMessage;
        });
    }
  }

  @override
  Widget build(BuildContext context) {
    ////////////////////////////////////
    // THIS SAMPLE ONLY WORKS ON MACOS.
    ////////////////////////////////////

    // This builds a menu hierarchy that looks like this:
    // Flutter API Sample
    //  ├ About
    //  ├ ────────  (group divider)
    //  ├ Hide/Show Message
    //  ├ Messages
    //  │  ├ I am not throwing away my shot.
    //  │  └ There's a million things I haven't done, but just you wait.
    //  └ Quit
    return PlatformMenuBar(
      menus: <PlatformMenuItem>[
        PlatformMenu(
          label: 'Flutter API Sample',
          menus: <PlatformMenuItem>[
            PlatformMenuItemGroup(
              members: <PlatformMenuItem>[
                PlatformMenuItem(
                  label: 'About',
                  tooltip: 'Show information about APP_NAME',
                  onSelected: () {
                    _handleMenuSelection(MenuSelection.about);
                  },
                ),
              ],
            ),
            PlatformMenuItemGroup(
              members: <PlatformMenuItem>[
                PlatformMenuItem(
                  onSelected: () {
                    _handleMenuSelection(MenuSelection.showMessage);
                  },
                  shortcut: const CharacterActivator('m'),
                  label: _showMessage ? 'Hide Message' : 'Show Message',
                  tooltip: _showMessage
                      ? 'The message will be hidden.'
                      : 'The message will be shown.',
                ),
                PlatformMenu(
                  label: 'Messages',
                  menus: <PlatformMenuItem>[
                    PlatformMenuItem(
                      label: 'I am not throwing away my shot.',
                      shortcut: const SingleActivator(
                        LogicalKeyboardKey.digit1,
                        meta: true,
                      ),
                      onSelected: () {
                        setState(() {
                          _message = 'I am not throwing away my shot.';
                        });
                      },
                    ),
                    PlatformMenuItem(
                      label:
                          "There's a million things I haven't done, but just you wait.",
                      shortcut: const SingleActivator(
                        LogicalKeyboardKey.digit2,
                        meta: true,
                      ),
                      onSelected: () {
                        setState(() {
                          _message =
                              "There's a million things I haven't done, but just you wait.";
                        });
                      },
                    ),
                  ],
                ),
              ],
            ),
            if (PlatformProvidedMenuItem.hasMenu(
              PlatformProvidedMenuItemType.quit,
            ))
              const PlatformProvidedMenuItem(
                type: PlatformProvidedMenuItemType.quit,
              ),
          ],
        ),
      ],
      child: Center(
        child: Text(
          _showMessage
              ? _message
              : 'This space intentionally left blank.\n'
                    'Show a message here using the menu.',
        ),
      ),
    );
  }
}

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
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.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

gemini-code-assist

Code Review

This pull request introduces tooltip support for platform menu items in Flutter. The changes involve adding a tooltip property to PlatformMenu and PlatformMenuItem in the Dart API, serializing this property through the platform channel, and implementing its display on the native macOS side. The native implementation also includes logic to replace kAppName within tooltips. Unit tests were updated to reflect these changes, including adding tooltip values to test menu structures and verifying their presence. The reviewer suggested updating the documentation for the PlatformMenu and PlatformMenuItem constructors to explicitly mention the new tooltip parameter, in line with the Flutter Style Guide.

gemini-code-assist · 2025-12-18T15:02:38Z

packages/flutter/lib/src/widgets/platform_menu_bar.dart

@@ -535,7 +536,13 @@ class PlatformMenu extends PlatformMenuItem with DiagnosticableTreeMixin {
  /// Creates a const [PlatformMenu].
  ///
  /// The [label] and [menus] fields are required.


The documentation for the PlatformMenu constructor should be updated to mention the new tooltip parameter. According to the Flutter Style Guide, all public members should have documentation.

Suggested change

/// The [label] and [menus] fields are required.

/// The [label] and [menus] fields are required. The [tooltip] is optional.

References

All public members should have documentation. The constructor is a public member and the new tooltip parameter should be documented. ^(link)

gemini-code-assist · 2025-12-18T15:02:38Z

packages/flutter/lib/src/widgets/platform_menu_bar.dart

@@ -699,6 +707,7 @@ class PlatformMenuItem with Diagnosticable {
  /// The [label] attribute is required.


The documentation for the PlatformMenuItem constructor should be updated to include the new tooltip parameter. According to the Flutter Style Guide, all public members should have documentation.

Suggested change

/// The [label] attribute is required.

/// The [label] attribute is required. The [tooltip] is optional.

References

All public members should have documentation. The constructor is a public member and the new tooltip parameter should be documented. ^(link)

hellohuanlin · 2026-01-05T19:20:17Z

engine/src/flutter/shell/platform/darwin/macos/framework/Source/FlutterMenuPlugin.mm

      [item setTitle:[[item title] stringByReplacingOccurrencesOfString:kAppName
                                                             withString:appName]];
    }
+    if ([item toolTip] && [[item toolTip] containsString:kAppName]) {


no need to check [item toolTip]

ksokolovskyi · 2026-01-06T15:22:21Z

@hellohuanlin thanks a lot for your review!

…utter/flutter#180069)

Roll Flutter from 13b2b91 to 01d37bc (74 revisions) flutter/flutter@13b2b91...01d37bc 2026-01-07 [email protected] Replace Hybrid Composition wiki page with dev-facing content (flutter/flutter#180642) 2026-01-07 [email protected] Improve code quality in `FlutterActivityTest.java` (flutter/flutter#180585) 2026-01-07 [email protected] Roll Dart SDK to 3.11.0-296.1.beta (flutter/flutter#180633) 2026-01-07 [email protected] Bump target Windows version to 10 (flutter/flutter#180624) 2026-01-07 [email protected] Run hook_user_defines and link_hook integration tests on CI (flutter/flutter#180622) 2026-01-07 [email protected] Fix division by zero in RenderTable intrinsic size methods (flutter/flutter#178217) 2026-01-07 [email protected] Remove more `requires 24` anotations (flutter/flutter#180116) 2026-01-07 [email protected] Roll Skia from 3971dbb85d45 to c5359a4d720e (1 revision) (flutter/flutter#180631) 2026-01-07 [email protected] Fix TabBar.image does not render at initialIndex for the first time (flutter/flutter#179616) 2026-01-07 [email protected] Roll Skia from 1e7ad625f6f7 to 3971dbb85d45 (3 revisions) (flutter/flutter#180627) 2026-01-07 [email protected] Unpin DDS (flutter/flutter#180571) 2026-01-07 [email protected] Fix DropdownMenuEntry.style not resolved when entry is highlighted (flutter/flutter#178873) 2026-01-07 [email protected] Remove unnecessary `@RequiresApi24` annotations from FlutterFragment methods (flutter/flutter#180117) 2026-01-07 [email protected] Roll Skia from 7fc63228056b to 1e7ad625f6f7 (1 revision) (flutter/flutter#180616) 2026-01-07 [email protected] Roll Fuchsia Linux SDK from QfR2ZFZ5kGTD3raO3... to dTvN_JVSCfGFRasvH... (flutter/flutter#180612) 2026-01-07 [email protected] [ Widget Preview ] Add support for `dart:ffi` imports (flutter/flutter#180586) 2026-01-07 [email protected] Roll Skia from eec90000a899 to 7fc63228056b (2 revisions) (flutter/flutter#180608) 2026-01-07 [email protected] Add --web-define flag for template variable injection in Flutter web builds (flutter/flutter#175805) 2026-01-07 [email protected] docs(engine): update rbe notes (flutter/flutter#180599) 2026-01-06 [email protected] Roll Skia from b6249496c230 to eec90000a899 (3 revisions) (flutter/flutter#180602) 2026-01-06 [email protected] Forward proxy 404 responses to client (flutter/flutter#179858) 2026-01-06 [email protected] Roll Dart SDK from 40a8c6188f7f to d2e3ce177270 (1 revision) (flutter/flutter#180598) 2026-01-06 [email protected] Restore CLI precedence for web headers and HTTPS over web_dev_config.yaml (flutter/flutter#179639) 2026-01-06 [email protected] Roll Skia from f5d9da13d56d to b6249496c230 (1 revision) (flutter/flutter#180596) 2026-01-06 [email protected] Enable misc leak tracking (flutter/flutter#176992) 2026-01-06 [email protected] [hooks] Don't require NDK for Android targets (flutter/flutter#180594) 2026-01-06 [email protected] [skia] Disable legacy non-const SkData APIs (flutter/flutter#179684) 2026-01-06 [email protected] Fix/ios share context menu (flutter/flutter#176199) 2026-01-06 [email protected] Roll Skia from b970aeffa66f to f5d9da13d56d (5 revisions) (flutter/flutter#180588) 2026-01-06 [email protected] Manually bump dependencies (flutter/flutter#180509) 2026-01-06 [email protected] Roll Dart SDK from 8150be8a0e48 to 40a8c6188f7f (2 revisions) (flutter/flutter#180582) 2026-01-06 [email protected] Roll Packages from 12eb764 to d3f860d (2 revisions) (flutter/flutter#180581) 2026-01-06 [email protected] Roll Fuchsia Test Scripts from MHF-UAfO6sVKqSEYk... to nR2ESa1Gd8yPcWo06... (flutter/flutter#180578) 2026-01-06 [email protected] Add tooltip support to PlatformMenuItem and PlatformMenu. (flutter/flutter#180069) 2026-01-06 [email protected] Add DropdownMenuFormField.errorBuilder (flutter/flutter#179345) 2026-01-06 [email protected] Roll Skia from 1845397e11ba to b970aeffa66f (2 revisions) (flutter/flutter#180566) 2026-01-06 [email protected] Don't embed unreferenced assets (flutter/flutter#179251) 2026-01-06 [email protected] Improve documentation about ValueNotifier's behavior (flutter/flutter#179870) 2026-01-06 [email protected] Roll Skia from 904ba00331ca to 1845397e11ba (5 revisions) (flutter/flutter#180558) 2026-01-06 [email protected] Roll Dart SDK from 2fb9ad834c4d to 8150be8a0e48 (1 revision) (flutter/flutter#180557) 2026-01-06 [email protected] Roll Skia from 98c042dde68c to 904ba00331ca (3 revisions) (flutter/flutter#180550) 2026-01-06 [email protected] Roll Dart SDK from ba9f7f790966 to 2fb9ad834c4d (2 revisions) (flutter/flutter#180548) 2026-01-06 [email protected] Roll Fuchsia Linux SDK from ubBGcRaAKWKihQ4ac... to QfR2ZFZ5kGTD3raO3... (flutter/flutter#180547) 2026-01-06 [email protected] Make sure that a DraggableScrollableSheet doesn't crash in 0x0 enviro… (flutter/flutter#180433) 2026-01-06 [email protected] Make sure that a ColorFiltered doesn't crash 0x0 environment (flutter/flutter#180307) 2026-01-06 [email protected] Make sure that a FadeInImage doesn't crash in 0x0 environment (flutter/flutter#180495) ...

…utter/flutter#180069)

Add tooltips support to PlatformMenuBar.

1bce798

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. engine flutter/engine related. See also e: labels. a: desktop Running on desktop platform-macos labels Dec 18, 2025

gemini-code-assist bot reviewed Dec 18, 2025

View reviewed changes

hellohuanlin requested review from a team and hellohuanlin December 18, 2025 22:41

Merge branch 'master' into add-tooltip-to-platform-menu-bar

eefb93c

hellohuanlin approved these changes Jan 5, 2026

View reviewed changes

Remove excessive toolTip check.

429f7a8

ksokolovskyi added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 6, 2026

auto-submit bot added this pull request to the merge queue Jan 6, 2026

Merged via the queue into flutter:master with commit be03f0d Jan 6, 2026
180 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 6, 2026

engine-flutter-autoroll mentioned this pull request Jan 6, 2026

Roll Flutter from 13b2b912c909 to be03f0d3b148 (41 revisions) flutter/packages#10727

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 6, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

9bc57c5

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 6, 2026

Roll Flutter from 13b2b912c909 to c58d63366199 (43 revisions) flutter/packages#10728

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 6, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

d99d3de

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 6, 2026

Roll Flutter from 13b2b912c909 to 0b67d3dc1430 (44 revisions) flutter/packages#10729

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 6, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

0ce6986

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 6, 2026

Roll Flutter from 13b2b912c909 to fb2fc34ca195 (45 revisions) flutter/packages#10730

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 6, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

531c000

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 6, 2026

Roll Flutter from 13b2b912c909 to 59868c551d01 (46 revisions) flutter/packages#10731

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 6, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

af31bfe

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 7, 2026

Roll Flutter from 13b2b912c909 to 20fc4107d61f (67 revisions) flutter/packages#10740

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 7, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

c3d0d8b

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 7, 2026

Roll Flutter from 13b2b912c909 to a73c1002a6fa (68 revisions) flutter/packages#10741

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 7, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

155d406

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 7, 2026

Roll Flutter from 13b2b912c909 to b2d157623eeb (69 revisions) flutter/packages#10742

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 7, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

c1e59bd

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 7, 2026

Roll Flutter from 13b2b912c909 to 6acc84ee2ce9 (71 revisions) flutter/packages#10743

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 7, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

0e53d81

…utter/flutter#180069)

engine-flutter-autoroll mentioned this pull request Jan 7, 2026

Roll Flutter from 13b2b912c909 to 01d37bc80fd5 (74 revisions) flutter/packages#10745

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 7, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

a3144e5

…utter/flutter#180069)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2026

be03f0d Add tooltip support to PlatformMenuItem and PlatformMenu. (fl…

dd6544f

…utter/flutter#180069)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tooltip support to PlatformMenuItem and PlatformMenu.#180069

Add tooltip support to PlatformMenuItem and PlatformMenu.#180069
auto-submit[bot] merged 3 commits intoflutter:masterfrom
ksokolovskyi:add-tooltip-to-platform-menu-bar

ksokolovskyi commented Dec 18, 2025 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Dec 18, 2025

Uh oh!

gemini-code-assist bot Dec 18, 2025

Uh oh!

hellohuanlin Jan 5, 2026

Uh oh!

ksokolovskyi commented Jan 6, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	/// The [label] and [menus] fields are required.
	/// The [label] and [menus] fields are required. The [tooltip] is optional.

		@@ -699,6 +707,7 @@ class PlatformMenuItem with Diagnosticable {
		/// The [label] attribute is required.

	/// The [label] attribute is required.
	/// The [label] attribute is required. The [tooltip] is optional.

Conversation

ksokolovskyi commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Pre-launch Checklist

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

hellohuanlin Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

ksokolovskyi commented Jan 6, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ksokolovskyi commented Dec 18, 2025 •

edited

Loading