https://github.com/leanflutter/screen_retriever
This plugin allows Flutter desktop apps to Retrieve information about screen size, displays, cursor position, etc.
https://github.com/leanflutter/screen_retriever
flutter flutter-desktop flutter-desktop-app
Last synced: 3 days ago
JSON representation
This plugin allows Flutter desktop apps to Retrieve information about screen size, displays, cursor position, etc.
- Host: GitHub
- URL: https://github.com/leanflutter/screen_retriever
- Owner: leanflutter
- License: mit
- Created: 2021-09-06T09:52:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-29T03:34:59.000Z (17 days ago)
- Last Synced: 2025-04-05T12:01:39.430Z (10 days ago)
- Topics: flutter, flutter-desktop, flutter-desktop-app
- Language: C++
- Homepage: https://leanflutter.dev/documentation/screen_retriever/
- Size: 438 KB
- Stars: 49
- Watchers: 2
- Forks: 23
- Open Issues: 3
-
Metadata Files:
- Readme: README-ZH.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-flutter-desktop - screen_retriever - This plugin allows Flutter desktop apps to Retrieve information about screen size, displays, cursor position, etc. (Packages)
README
> **🚀 快速发布您的应用**: 试试 [Fastforge](https://fastforge.dev) - 构建、打包和分发您的 Flutter 应用最简单的方式。
# screen_retriever
[![pub version][pub-image]][pub-url] [![][discord-image]][discord-url]
[pub-image]: https://img.shields.io/pub/v/screen_retriever.svg
[pub-url]: https://pub.dev/packages/screen_retriever
[discord-image]: https://img.shields.io/discord/884679008049037342.svg
[discord-url]: https://discord.gg/zPa6EZ2jqb
这个插件允许 Flutter 桌面应用检索关于屏幕大小，显示，光标位置等信息。
---
[English](./README.md) | 简体中文
---
- [平台支持](#%E5%B9%B3%E5%8F%B0%E6%94%AF%E6%8C%81)
- [文档](#%E6%96%87%E6%A1%A3)
- [快速开始](#%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B)
- [安装](#%E5%AE%89%E8%A3%85)
- [用法](#%E7%94%A8%E6%B3%95)
- [监听事件](#%E7%9B%91%E5%90%AC%E4%BA%8B%E4%BB%B6)
- [谁在用使用它？](#%E8%B0%81%E5%9C%A8%E7%94%A8%E4%BD%BF%E7%94%A8%E5%AE%83)
- [API](#api)
- [ScreenRetriever](#screenretriever)
- [贡献者 ✨](#%E8%B4%A1%E7%8C%AE%E8%80%85-)
- [许可证](#%E8%AE%B8%E5%8F%AF%E8%AF%81)
## 平台支持
| Linux | macOS | Windows |
| :---: | :---: | :-----: |
| ✔️ | ✔️ | ✔️ |
## 文档
- [快速开始](https://leanflutter.dev/zh/documentation/screen_retriever/quick-start)
- [API 参考](https://pub.dev/documentation/screen_retriever/latest/screen_retriever/)
- [更新日志](https://pub.dev/packages/screen_retriever/changelog)
## 快速开始
### 安装
将此添加到你的软件包的 pubspec.yaml 文件：
```yaml
dependencies:
screen_retriever: ^0.2.0
```
或
```yaml
dependencies:
screen_retriever:
git:
url: https://github.com/leanflutter/screen_retriever.git
path: packages/screen_retriever
ref: main
```
### 用法
```dart
Display? _primaryDisplay;
List _displayList = [];
void _init() async {
_primaryDisplay = await screenRetriever.getPrimaryDisplay();
_displayList = await screenRetriever.getAllDisplays();
setState(() {});
}
```
### 监听事件
```dart
class HomePage extends StatefulWidget {
const HomePage({Key? key}) : super(key: key);
@override
State createState() => _HomePageState();
}
class _HomePageState extends State with ScreenListener {
@override
void initState() {
screenRetriever.addListener(this);
super.initState();
}
@override
void dispose() {
screenRetriever.removeListener(this);
super.dispose();
}
@override
Widget build(BuildContext context) {
// ...
}
@override
void onScreenEvent(String eventName) {
String log = 'Event received: $eventName)';
print(log);
}
}
```
> 请看这个插件的示例应用，以了解完整的例子。
## 谁在用使用它？
- [Biyi (比译)](https://biyidev.com/) - 一个便捷的翻译和词典应用。
## API
### ScreenRetriever
| Method | Description | Linux | macOS | Windows |
| ---------------------- | --------------------------------------------- | ----- | ----- | ------- |
| `getCursorScreenPoint` | 返回 `Offset` - 鼠标指针的当前绝对位置。 | ✔️ | ✔️ | ✔️ |
| `getPrimaryDisplay` | 返回 `Display` - 主显示屏。 | ✔️ | ✔️ | ✔️ |
| `getAllDisplays` | 返回 `List` - 当前可用的显示器列表。 | ✔️ | ✔️ | ✔️ |
## 贡献者 ✨
感谢这些优秀的人 ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
LiJianying
💻
Christian Padilla
💻
J-P Nurmi
💻
Kingtous
💻
fufesou
💻
lukasz-lukasz-lukasz
💻
Add your contributions
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## 许可证
[MIT](./LICENSE)