screen_retriever

⚠️ Migration Notice: This plugin is being migrated to libnativeapi/nativeapi-flutter

The new version is based on a unified C++ core library (libnativeapi/nativeapi), providing more complete and consistent cross-platform native API support. r

screen_retriever

This plugin allows Flutter desktop apps to Retrieve information about screen size, displays, cursor position, etc.

---

---

English | 简体中文

---

• Platform Support
• Documentation
• Quick Start
  • Installation
  • Usage
  • Listening events
• Who's using it?
• API
  • ScreenRetriever
• Contributors ✨
• License

Platform Support

Linux	macOS	Windows
✔️	✔️	✔️

Documentation

• Quick Start
• API Reference
• Changelog

Quick Start

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  screen_retriever: ^0.2.0

Or

dependencies:
  screen_retriever:
    git:
      url: https://github.com/leanflutter/screen_retriever.git
      path: packages/screen_retriever
      ref: main

Usage

Display? _primaryDisplay;
List<Display> _displayList = [];

void _init() async {
  _primaryDisplay = await screenRetriever.getPrimaryDisplay();
  _displayList = await screenRetriever.getAllDisplays();
  setState(() {});
}

Listening events

class HomePage extends StatefulWidget {
  const HomePage({Key? key}) : super(key: key);

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> 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);
  }
}

Please see the example app of this plugin for a full example.

Who's using it?

• Biyi (比译) - A convenient translation and dictionary app.
• FastForge - An efficient tool for rapid application development and prototyping.

API

ScreenRetriever

Method	Description	Linux	macOS	Windows
getCursorScreenPoint	Returns Offset - The current absolute position of the mouse pointer.	✔️	✔️	✔️
getPrimaryDisplay	Returns Display - The primary display.	✔️	✔️	✔️
getAllDisplays	Returns List<Display> - An array of displays that are currently available.	✔️	✔️	✔️

Contributors ✨

Thanks goes to these wonderful people (emoji key):

LiJianying 💻	Christian Padilla 💻	J-P Nurmi 💻	Kingtous 💻	fufesou 💻	lukasz-lukasz-lukasz 💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT