Flutter全局键盘快捷键绑定插件 keybinder 的使用

keybinder 是一个用于将回调函数绑定到一个或多个物理键盘按键组合的实用工具类，它利用了全局的 RawKeyboard 实例。

安装

在 pubspec.yaml 文件中添加依赖：

dependencies:
  keybinder: ^最新版本号

然后运行 flutter pub get 来安装插件。

使用示例

导入包

首先需要导入 keybinder 包：

import 'package:keybinder/keybinder.dart';

KeyCodes

KeyCode 表示一组一个或多个键ID，这些键ID对应于物理或逻辑键盘键。如果 KeyCode 中的任意一个键被按下，则该 KeyCode 被认为是按下的。

创建 KeyCode

// 创建一个表示左、右控制键的 KeyCode
final ctrl = KeyCode.fromSet({LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.controlRight});

// 创建一个仅表示左控制键的 KeyCode
final ctrlLeft = KeyCode.from(LogicalKeyboardKey.controlLeft);

// 使用预定义的常量创建 KeyCode
final alt = KeyCode.alt;
final shift = KeyCode.shift;

Keybindings

Keybinding 是一组 KeyCode，用于将回调函数绑定到键盘上的零个或多个键的组合。

创建 Keybinding

// 创建一个当同时按下 Ctrl 和 Shift 键时触发的 Keybinding
final exclusiveCtrlShift = Keybinding({KeyCode.ctrl, KeyCode.shift});

// 创建一个即使有其他键也被按下也视为有效的 Keybinding
final inclusiveCtrlShift = Keybinding({KeyCode.ctrl, KeyCode.shift}, inclusive: true);

绑定和解除绑定

使用 Keybinder 类来绑定和解除绑定 Keybinding 及其对应的回调函数。

绑定回调

// 定义回调函数
void onPressed() {
  print('Keybinding was pressed');
}

void onToggle(bool pressed) {
  print('Keybinding was ${pressed ? 'pressed' : 'released'}');
}

void onKeyToggled(Keybinding keybinding, bool pressed) {
  print('$keybinding was ${pressed ? 'pressed' : 'released'}');
}

// 创建与空格键关联的 Keybinding
final spaceKeybinding = Keybinding.from({LogicalKeyboardKey.space}, debugLabel: 'space');

// 将所有三个回调绑定到空格键
Keybinder.bind(spaceKeybinding, onPressed);
Keybinder.bind(spaceKeybinding, onToggle);
Keybinder.bind(spaceKeybinding, onKeyToggled);

解除绑定

// 解除特定的 Keybinding 及其回调
Keybinder.remove(spaceKeybinding, onPressed);

// 清除所有绑定的 Keybinding 及其回调，并移除监听器
Keybinder.dispose();

完整示例 Demo

以下是一个完整的 Flutter 应用程序示例，演示如何使用 keybinder 插件来实现全局键盘快捷键功能：

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

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Keybinder Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String _statusText = '';

  [@override](/user/override)
  void initState() {
    super.initState();

    // 创建 Keybinding
    final ctrlC = Keybinding.from({LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.keyC});

    // 绑定回调
    Keybinder.bind(ctrlC, () {
      setState(() {
        _statusText = 'Ctrl + C was pressed';
      });
    });

    Keybinder.bind(ctrlC, (bool pressed) {
      setState(() {
        _statusText = 'Ctrl + C was ${pressed ? 'pressed' : 'released'}';
      });
    });

    Keybinder.bind(ctrlC, (Keybinding keybinding, bool pressed) {
      setState(() {
        _statusText = '$keybinding was ${pressed ? 'pressed' : 'released'}';
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Keybinder Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(_statusText),
          ],
        ),
      ),
    );
  }
}