Flutter全局快捷键管理插件galactic_hotkeys的使用

使用

要使用Galactic Hotkeys，你需要将你的主部件包裹在GalacticHotkeys部件中，并提供所需的快捷键和一个回调函数来处理当快捷键被按下时的操作。

GalacticHotkeys<String>(
  shortcuts: {
    '保存': [
      [LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.keyS],
      [LogicalKeyboardKey.metaLeft, LogicalKeyboardKey.keyS],
    ],
    '复制': [
      [LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.keyC],
      [LogicalKeyboardKey.metaLeft, LogicalKeyboardKey.keyC],
    ],
    // 添加更多快捷键
  },
  onShortcutPressed: (String identifier, List<LogicalKeyboardKey> pressedKeys) {
    // 处理快捷键按下事件
    print('快捷键已按下: $identifier');
  },
  child: const Container(),
)

在这个例子中，GalacticHotkeys部件用于捕获键盘快捷键并触发带有相应标识符的onShortcutPressed回调。

此外，你还可以使用GalacticHotkeysBuilder部件来根据当前按下的按键构建你的UI。

GalacticHotkeysBuilder(
  builder: (context, List<LogicalKeyboardKey> pressedKeys) {
    // 示例：检查是否仅Control键被按下
    final onlyControlIsPressed = pressedKeys.length == 1 && pressedKeys.first == LogicalKeyboardKey.controlLeft;
    
    // 使用pressedKeys信息来根据条件构建你的自定义部件
    return YourCustomWidget(
      showControlMessage: onlyControlIsPressed,
    );
  },
)

在这个例子中，GalacticHotkeysBuilder用于获取当前按下的按键列表，并根据仅Control键被按下的条件来构建一个自定义部件。根据你的应用需求定制builder函数。 注意： GalacticHotkeysBuilder应在组件树中有一个父级的GalacticHotkeys部件才能正常工作。确保你已经用GalacticHotkeys或其等效祖先部件包装了你的主部件。

示例代码

以下是完整的示例代码：

import 'dart:async';

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

void main() {
  runApp(const ExampleGalacticHotkeys());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Galactic Hotkeys 示例',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const _HomePage(),
    );
  }
}

enum Shortcut {
  撤销,
  重做,
  剪切,
  复制,
  粘贴,
}

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

  [@override](/user/override)
  State<_HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<_HomePage> {
  Shortcut? _latestPressedShortcut;
  Timer? _delayToClearShortcutPressed;

  [@override](/user/override)
  void dispose() {
    _delayToClearShortcutPressed?.cancel();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Galactic Hotkeys'),
      ),
      body: GalacticHotkeys<Shortcut>(
        shortcuts: const {
          Shortcut.撤销: [
            [LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.keyZ],
            [LogicalKeyboardKey.metaLeft, LogicalKeyboardKey.keyZ],
          ],
          Shortcut.重做: [
            [LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.keyY],
            [LogicalKeyboardKey.metaLeft, LogicalKeyboardKey.keyY],
            [
              LogicalKeyboardKey.controlLeft,
              LogicalKeyboardKey.shiftLeft,
              LogicalKeyboardKey.keyZ
            ],
            [
              LogicalKeyboardKey.metaLeft,
              LogicalKeyboardKey.shiftLeft,
              LogicalKeyboardKey.keyZ
            ],
          ],
          Shortcut.剪切: [
            [LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.keyX],
            [LogicalKeyboardKey.metaLeft, LogicalKeyboardKey.keyX],
          ],
          Shortcut.复制: [
            [LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.keyC],
            [LogicalKeyboardKey.metaLeft, LogicalKeyboardKey.keyC],
          ],
          Shortcut.粘贴: [
            [LogicalKeyboardKey.controlLeft, LogicalKeyboardKey.keyV],
            [LogicalKeyboardKey.metaLeft, LogicalKeyboardKey.keyV],
          ],
        },
        onShortcutPressed: (Shortcut shortcut, pressedKeys) {
          setState(() => _latestPressedShortcut = shortcut);

          _delayToClearShortcutPressed?.cancel();
          _delayToClearShortcutPressed = Timer(const Duration(seconds: 2), () {
            if (mounted) {
              setState(() => _latestPressedShortcut = null);
            }
          });
          // switch (shortcut) {
          //   case Shortcut.撤销:
          //     break;
          //   case Shortcut.重做:
          //     break;
          //   case Shortcut.剪切:
          //     break;
          //   case Shortcut.复制:
          //     break;
          //   case Shortcut.粘贴:
          //     break;
          // }
        },
        child: ListView(
          children: [
            for (final shortcut in Shortcut.values)
              ListTile(
                title: Text(
                  shortcut.name,
                  style: TextStyle(
                    color: shortcut == _latestPressedShortcut ? Colors.red : null,
                  ),
                ),
              ),
          ],
        ),
      ),
    );
  }
}