# fluttertpc_flutter_custom_cursor

**Repository Path**: openharmony-sig/fluttertpc_flutter_custom_cursor

## Basic Information

- **Project Name**: fluttertpc_flutter_custom_cursor
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-06-25
- **Last Updated**: 2025-05-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🚨 **重要提示 | IMPORTANT**
>
> **⚠️ 此代码仓已归档。新地址请访问 [fluttertpc_flutter_custom_cursor](https://gitcode.com/openharmony-sig/fluttertpc_flutter_custom_cursor)。| ⚠️ This repository has been archived. For the new address, please visit [fluttertpc_flutter_custom_cursor](https://gitcode.com/openharmony-sig/fluttertpc_flutter_custom_cursor).**
>
---
>
# flutter_custom_cursor

![](https://img.shields.io/pub/v/flutter_custom_cursor?color=green)
![](https://img.shields.io/pub/publisher/flutter_custom_cursor)

This plugin allows to create/set a custom mouse cursor directly from a memory buffer.



Big thanks to imiskolee to create the [base of this plugin](https://github.com/imiskolee/flutter_custom_cursor).

## Platforms

- [x] macOS
- [x] Windows
- [x] Linux

Note: Currently, the api required by this plugin on Windows is included in flutter `master` branch. It means that u need to use this plugin with flutter master branch on Windows platform. See [flutter engine PR#36143](https://github.com/flutter/engine/pull/36143) for details.

Update: the latest Flutter `3.7.0` does not contain PR above, which merges to `flutter-3.7.0-candidate.2`, while Flutter stable `3.7.0` is using `flutter-3.7.0-candidate.1`. This limitation will be lifted maybe in the next Flutter stable release.

# Get prepared

## Register your custom cursor before

```dart
// register this cursor
cursorName = await CursorManager.instance.registerCursor(CursorData()
  ..name = "test"
  ..buffer =
      Platform.isWindows ? memoryCursorDataRawBGRA : memoryCursorDataRawPNG
  ..height = img.height
  ..width = img.width
  ..hotX = 0
  ..hotY = 0);
```

Note that a String `cacheName` will be returned by the function `registerCursor`, which can be used to set this cursor to system or delete this cursor.

`CursorData.buffer` is a `Uint8List` which contains the cursor data. Be aware that on Windows, `buffer` is formatted by `rawBGRA`, other OS(s) are `rawPNG`.

see the example project for details.

## Set the custom cursor

We have implemented the `FlutterCustomMemoryImageCursor` class, which is a subclass of `MouseCursor`. This class will automatically set the memory cursor for you. Keep it simple.

```dart
MouseRegion(
  cursor: FlutterCustomMemoryImageCursor(key: cursorName),
  child: Row(
    children: [
      Text("Memory image here", style: style),
    ],
  ),
),
```

## Delete the cursor 

You can delete a cursor with the `cursorName`.

```dart
await CursorManager.instance.deleteCursor("cursorName");
```