Repository navigation
Closed
Labels
P1High-priority issues at the top of the work listHigh-priority issues at the top of the work lista: desktopRunning on desktopRunning on desktopa: text inputEntering text in a text field or keyboard related problemsEntering text in a text field or keyboard related problemscustomer: todofound in release: 2.2Found to occur in 2.2Found to occur in 2.2found in release: 2.4Found to occur in 2.4Found to occur in 2.4frameworkflutter/packages/flutter repository. See also f: labels.flutter/packages/flutter repository. See also f: labels.has reproducible stepsThe issue has been confirmed reproducible and is ready to work onThe issue has been confirmed reproducible and is ready to work onplatform-macosBuilding on or for macOS specificallyBuilding on or for macOS specificallyr: fixedIssue is closed as already fixed in a newer versionIssue is closed as already fixed in a newer version
Description
When using composing keyboards on native Mac, the arrow keys can be used to navigate the composing tooltip. In Flutter, the arrow keys continue to be intercepted by Flutter when the composing tooltip is visible, so it doesn't receive the keys. We should not intercept the keys when composing is happening.
| Native Mac | Flutter Mac |
|---|---|
![]() |
![]() |
Steps to reproduce
- Run any app with a text input, like the one given below, on a Mac.
- Set your keyboard to a composing keyboard, such as Chinese Pinyin.
- Type some text so that the composing tooltip appears, such as "ni".
- Attempt to navigate in the tooltip using the arrow keys.
Result: The cursor moves, not the selection in the composing tooltip.
Expected result: The selection in the composing tooltip moves.
Code
import 'package:flutter/material.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatelessWidget {
// This widget is the root of your application.
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Demo',
theme: ThemeData(
// This is the theme of your application.
//
// Try running your application with "flutter run". You'll see the
// application has a blue toolbar. Then, without quitting the app, try
// changing the primarySwatch below to Colors.green and then invoke
// "hot reload" (press "r" in the console where you ran "flutter run",
// or simply save your changes to "hot reload" in a Flutter IDE).
// Notice that the counter didn't reset back to zero; the application
// is not restarted.
primarySwatch: Colors.blue,
// This makes the visual density adapt to the platform that you run
// the app on. For desktop platforms, the controls will be smaller and
// closer together (more dense) than on mobile platforms.
visualDensity: VisualDensity.adaptivePlatformDensity,
),
home: MyHomePage(title: 'Flutter Demo Home Page'),
);
}
}
class MyHomePage extends StatefulWidget {
MyHomePage({Key key, this.title}) : super(key: key);
// This widget is the home page of your application. It is stateful, meaning
// that it has a State object (defined below) that contains fields that affect
// how it looks.
// This class is the configuration for the state. It holds the values (in this
// case the title) provided by the parent (in this case the App widget) and
// used by the build method of the State. Fields in a Widget subclass are
// always marked "final".
final String title;
@override
_MyHomePageState createState() => _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
int _counter = 0;
void _incrementCounter() {
setState(() {
// This call to setState tells the Flutter framework that something has
// changed in this State, which causes it to rerun the build method below
// so that the display can reflect the updated values. If we changed
// _counter without calling setState(), then the build method would not be
// called again, and so nothing would appear to happen.
_counter++;
});
}
@override
Widget build(BuildContext context) {
// This method is rerun every time setState is called, for instance as done
// by the _incrementCounter method above.
//
// The Flutter framework has been optimized to make rerunning build methods
// fast, so that you can just rebuild anything that needs updating rather
// than having to individually change instances of widgets.
return Scaffold(
appBar: AppBar(
// Here we take the value from the MyHomePage object that was created by
// the App.build method, and use it to set our appbar title.
title: Text(widget.title),
),
body: Center(
// Center is a layout widget. It takes a single child and positions it
// in the middle of the parent.
child: TextField(),
),
floatingActionButton: FloatingActionButton(
onPressed: _incrementCounter,
tooltip: 'Increment',
child: Icon(Icons.add),
), // This trailing comma makes auto-formatting nicer for build methods.
);
}
}Reacted by Crossle Song, Britannio Jarrett, Pepe and Chris Bracken
Metadata
Metadata
Assignees
Labels
P1High-priority issues at the top of the work listHigh-priority issues at the top of the work lista: desktopRunning on desktopRunning on desktopa: text inputEntering text in a text field or keyboard related problemsEntering text in a text field or keyboard related problemscustomer: todofound in release: 2.2Found to occur in 2.2Found to occur in 2.2found in release: 2.4Found to occur in 2.4Found to occur in 2.4frameworkflutter/packages/flutter repository. See also f: labels.flutter/packages/flutter repository. See also f: labels.has reproducible stepsThe issue has been confirmed reproducible and is ready to work onThe issue has been confirmed reproducible and is ready to work onplatform-macosBuilding on or for macOS specificallyBuilding on or for macOS specificallyr: fixedIssue is closed as already fixed in a newer versionIssue is closed as already fixed in a newer version
Type
Projects
- StatusShow more project fieldsDone


Activity
maheshj01 commentedon Jul 12, 2021
Reproducible on the latest stable and the master channel, When the composable tooltip is visible, using the side arrow keys the cursor moves in the TextField instead of navigating through the tooltip suggestions.
flutter doctor -v
cbracken commentedon Jul 28, 2021
Keep in mind that arrow keys behave differently depending on the language and IME.
For example, with Japanese input on macOS, left and right arrow should move the cursor within the composing region when the candidates drop-down is not present (either before it comes up, or if you hit ESC), and when it is visible, it's navigated using up/down (right/left have no effect either on cursor position or candidate selection):
Screen.Recording.2021-07-28.at.15.09.47.mov
In this case:
At least on macOS, I believe that so long as the candidates list is visible, the correct behaviour is to hand the keypresses to the IME. Once the candidates list is hidden (e.g. via ESC), then we're back to moving the cursor. Since changes from the IME trigger us to update the text editing state from the engine back to the framework, I think it may be safe to always send those keypresses to the IME in composing mode... but I'd verify the above test case steps work as expected.
cbracken commentedon Jul 28, 2021
I know this issue is mac-specific, but it's worth noting that behaviour on Linux (GTK) is quite different to this.
[-]Can't navigate composing tooltip with arrow keys on Mac[/-][+]Can't navigate composing candidates list with arrow keys on Mac[/+]21 remaining items
cbracken commentedon Jun 3, 2022
Agreed this seems like potentially a cleaner path forward; also nice that it allows for stripping out some more embedder-specific code from the framework. @LongCatIsLooong / @dkwingsmt was this considered during the key event work for macOS? If so, do you remember why it was rejected?
knopp commentedon Jun 4, 2022
PR to fix emoji picker. Not sure why it doesn't show as reference here.
knopp commentedon Jun 5, 2022
PR for engine and framework to use editing intents instead from engine of hardcoded shortcuts in framework. These are bit raw but any feedback on whether this goes in the right direction is appreciated. Together with flutter-team-archive/engine#33827 this should be a proper solution for all IMEs (CJK, Latin and Emoji).
maheshj01 commentedon Jun 21, 2022
@knopp Was this issue accidentally reopened? Also, the linked PRs seem to be merged.
knopp commentedon Jun 21, 2022
It wasn't accidentally reopened. flutter-team-archive/engine#33838 and #105407 have not been merged yet. They are needed to completely fix the issue.
github-actions commentedon Aug 12, 2022
This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of
flutter doctor -vand a minimal reproduction of the issue.