Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leanflutter/hotkey_manager
This plugin allows Flutter desktop apps to defines system/inapp wide hotkey (i.e. shortcut).
https://github.com/leanflutter/hotkey_manager
flutter flutter-desktop flutter-desktop-app global-hotkey global-hotkeys global-shortcuts hotkey linux macos shortcuts windows
Last synced: 7 days ago
JSON representation
This plugin allows Flutter desktop apps to defines system/inapp wide hotkey (i.e. shortcut).
- Host: GitHub
- URL: https://github.com/leanflutter/hotkey_manager
- Owner: leanflutter
- License: mit
- Created: 2021-07-20T14:34:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-18T06:53:55.000Z (6 months ago)
- Last Synced: 2024-10-26T14:34:02.745Z (12 days ago)
- Topics: flutter, flutter-desktop, flutter-desktop-app, global-hotkey, global-hotkeys, global-shortcuts, hotkey, linux, macos, shortcuts, windows
- Language: Dart
- Homepage:
- Size: 443 KB
- Stars: 133
- Watchers: 3
- Forks: 36
- Open Issues: 13
-
Metadata Files:
- Readme: README-ZH.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-flutter-desktop - hotkey_manager - This plugin allows Flutter desktop apps to defines system/inapp wide hotkey (i.e. shortcut). (Packages)
README
# hotkey_manager
[![pub version][pub-image]][pub-url] [![][discord-image]][discord-url] ![][visits-count-image]
[pub-image]: https://img.shields.io/pub/v/hotkey_manager.svg
[pub-url]: https://pub.dev/packages/hotkey_manager
[discord-image]: https://img.shields.io/discord/884679008049037342.svg
[discord-url]: https://discord.gg/zPa6EZ2jqb
[visits-count-image]: https://img.shields.io/badge/dynamic/json?label=Visits%20Count&query=value&url=https://api.countapi.xyz/hit/leanflutter.hotkey_manager/visits
这个插件允许 Flutter 桌面应用定义系统/应用范围内的热键（即快捷键）。
---
[English](./README.md) | 简体中文
---
- [hotkey_manager](#hotkey_manager)
- [平台支持](#平台支持)
- [快速开始](#快速开始)
- [安装](#安装)
- [Linux requirements](#linux-requirements)
- [用法](#用法)
- [谁在用使用它？](#谁在用使用它)
- [API](#api)
- [HotKeyManager](#hotkeymanager)
- [相关链接](#相关链接)
- [许可证](#许可证)
## 平台支持
| Linux | macOS | Windows |
| :---: | :---: | :-----: |
| ✔️ | ✔️ | ✔️ |
## 快速开始
### 安装
将此添加到你的软件包的 pubspec.yaml 文件：
```yaml
dependencies:
hotkey_manager: ^0.2.3
```
或
```yaml
dependencies:
hotkey_manager:
git:
path: packages/hotkey_manager
url: https://github.com/leanflutter/hotkey_manager.git
ref: main
```
#### Linux requirements
- [`keybinder-3.0`](https://github.com/kupferlauncher/keybinder)
运行以下命令
```
sudo apt-get install keybinder-3.0
```
### 用法
```dart
import 'package:hotkey_manager/hotkey_manager.dart';
void main() async {
// 必须加上这一行。
WidgetsFlutterBinding.ensureInitialized();
// 对于热重载，`unregisterAll()` 需要被调用。
await hotKeyManager.unregisterAll();
runApp(MyApp());
}
```
注册/卸载一个系统/应用范围的热键。
```dart
// ⌥ + Q
HotKey _hotKey = HotKey(
key: PhysicalKeyboardKey.keyQ,
modifiers: [HotKeyModifier.alt],
// 设置热键范围（默认为 HotKeyScope.system）
scope: HotKeyScope.inapp, // 设置为应用范围的热键。
);
await hotKeyManager.register(
_hotKey,
keyDownHandler: (hotKey) {
print('onKeyDown+${hotKey.toJson()}');
},
// 只在 macOS 上工作。
keyUpHandler: (hotKey){
print('onKeyUp+${hotKey.toJson()}');
} ,
);
await hotKeyManager.unregister(_hotKey);
await hotKeyManager.unregisterAll();
```
使用 `HotKeyRecorder` 小部件帮助您录制一个热键。
```dart
HotKeyRecorder(
onHotKeyRecorded: (hotKey) {
_hotKey = hotKey;
setState(() {});
},
),
```
> 请看这个插件的示例应用，以了解完整的例子。
## 谁在用使用它？
- [Airclap](https://airclap.app/) - 任何文件，任意设备，随意发送。简单好用的跨平台高速文件传输APP。
- [AuthPass](https://authpass.app/) - 基于Flutter的密码管理器，适用于所有平台。兼容Keepass 2.x（kdbx 3.x）。
- [Biyi (比译)](https://biyidev.com/) - 一个便捷的翻译和词典应用程序。
## API
### HotKeyManager
| Method | Description | Linux | macOS | Windows |
| ------------- | --------------------------------- | ----- | ----- | ------- |
| register | 注册一个系统/应用范围的热键。 | ✔️ | ✔️ | ✔️ |
| unregister | 取消注册一个系统/应用范围的热键。 | ✔️ | ✔️ | ✔️ |
| unregisterAll | 取消注册全部系统/应用范围的热键。 | ✔️ | ✔️ | ✔️ |
## 相关链接
- https://github.com/soffes/HotKey
- https://github.com/kupferlauncher/keybinder
## 许可证
[MIT](./LICENSE)