表題の機能を組み込むときに参考情報が少なかったので、メモとして記します。
実現したいこと
アプリにはタップや長押しで呼び出すメニューの他に、スクリーンリーダー(Android→TalkBack、iOS→VoiceOver)向けにコンテキストメニューを提供することができます。
Androidでは
ローカルコンテキストメニュー → 操作
(ローカルコンテキストメニューは上にスワイプしてから右にスワイプで開きます。)
iOSでは縦のスワイプ
でそれぞれ呼び出すことができます。
これにより素早く機能を呼び出すことが可能です。
作成は対象のウィジェットをSemantics()で囲いcustomSemanticsActionsプロパティでメニューを定義します。
またonTapとonLongPressプロパティでタップと長押しの動作も定義できます。
これはGestureDetector()でウィジェットを囲い定義することと同様です。
Semantics()ではそれぞれonTaphintとonLongPressHintプロパティを使うことで、スクリーンリーダーがアナウンスする内容を指定することができます。
それぞれのジェスチャーで何ができるのか、事前に把握できるのはユーザにとって有益です。
が、私が試したところ、onLongPressは動作しませんでした。
解決策としてはジェスチャーはGestureDetector()で定義し、ヒントをSemantics()で定義すればOKです。
下記のサンプルコードは新規プロジェクトで作成されるコードに上記の内容を書き加えた物です。
スクリーンリーダーの挙動はこちらで確認できます。
サンプルコード
sample.dart
import 'package:flutter/material.dart';
import 'package:flutter/semantics.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;
_incrementCounter() {
setState((){
_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: Column(
// Column is also a layout widget. It takes a list of children and
// arranges them vertically. By default, it sizes itself to fit its
// children horizontally, and tries to be as tall as its parent.
//
// Invoke "debug painting" (press "p" in the console, choose the
// "Toggle Debug Paint" action from the Flutter Inspector in Android
// Studio, or the "Toggle Debug Paint" command in Visual Studio Code)
// to see the wireframe for each widget.
//
// Column has various properties to control how it sizes itself and
// how it positions its children. Here we use mainAxisAlignment to
// center the children vertically; the main axis here is the vertical
// axis because Columns are vertical (the cross axis would be
// horizontal).
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
Text(
'You have pushed the button this many times:',
),
Semantics(
child: GestureDetector(
child: Text(
'$_counter',
style: Theme.of(context).textTheme.headline4,
),
// excludeSemantics: true,
// value: _counter,
onTap: _incrementCounter,
onLongPress: () => setState(() => _counter =0 ),
),
button: true,
onTapHint: '値を増加',
onLongPressHint: 'リセット',
customSemanticsActions: <CustomSemanticsAction, VoidCallback>{
CustomSemanticsAction(label: 'Increment'): _incrementCounter,
CustomSemanticsAction(label: 'reset'): () => setState(() => _counter = 0),
},
),
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: () { _incrementCounter (); },
tooltip: 'Increment',
child: Icon(Icons.add),
), // This trailing comma makes auto-formatting nicer for build methods.
);
}
}
補足
ボタンにコンテキストメニューを不可する場合は更に
excludeSemantics: true,
value: 'increment',
button: true,
などのプロパティが必要です。
プロパティがなくても動作しますが、スクリーンリーダーがアナウンスしないため、ユーザがメニューに気が付けません。