README.md

desktop_cursor

Flutter plugin which allows the developer to set the shape of the cursor on Desktop. Linux, Windows and MacOs are all supported. The native side is implemented using go-flutter. To get setup and running using go-flutter I recommend getting started with its examples.

• desktop_cursor
  • Getting Started
    • Flutter
    • Desktop
  • Usage example
    • Setting the shape
    • Retrieving the current shape
    • onHover extension
    • CursorArea widget

Getting Started

Flutter

In your flutter project add the dependency:

dependencies:
  ...
  desktop_cursor: ^0.1.0

For help getting started with Flutter, view the online documentation.

Desktop

For installing and using the go implementation of the plugin, please read the README.

Usage example

An example with all features implemented can be found here.

Import desktop_cursor.dart

import 'package:desktop_cursor/desktop_cursor.dart';

Setting the shape

Currently go-lang only supports GLFW. Although GLFW allows for custom shapes, this library currently only supports its standard shapes:

• ArrowCursor
• IBeamCursor
• CrosshairCursor
• HandCursor
• HResizeCursor
• VResizeCursor

DesktopCursor.setShape(CursorShape.hand);

Retrieving the current shape

This will provide the current shape of the Cursor. Note that by default it will return CursorShape.arrowCursor

CursorShape shape;
try{
    shape = await DesktopCursor.currentShape;
} on PlatformException{
    print("Could not get the shape");
}

onHover extension

desktop_cursor provides a helper extension to set the cursor when hovering over any Widget. This extension wraps the widget inside a MouseRegion.

NOTE: When the cursor leaves the widget, the shape will always be set to CursorShape.arrow.

...
IconButton(
    ...
).onHover(CursorShape.hoverCursor)
...

CursorArea widget

When requirements demand to be more flexible regarding when to set the shape and to which shape or simply prever to implement it declaratively, the widget CursorArea can be used. This widget wraps the provided child widget with Listener, and sets the onEnter and onExit variables.

...
CursorArea(
    onEnter: CursorShape.crosshair,
    onExit: CursorShape.arrow,
    child: Text("Shoot me")
)
...