We use essential cookies for the website to function, as well as analytics cookies for analyzing and creating statistics of the website performance. To agree to the use of analytics cookies, click "Accept All". You can manage your preferences at any time by clicking "Cookie Settings" on the footer. More Information.

Cookie Settings
Only Essential Cookies
Accept All
MaterialsConsole

HarmonyOS

输入关键字搜索
HMS Core
AppGallery Connect
HUAWEI HiAI
CTRL+K
Advanced filters
API versionAll
DeviceAll
Atomic service APIsNot filter by this
ReferencesApplication FrameworkArkUIArkTS ComponentsUniversal AttributesInteraction AttributesCursor Control

Cursor Control

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
Last updated: 2026-09-04 06:52
Content overview

You can control the display style of the mouse cursor.

NOTE

This feature is supported since API version 11. Updates will be marked with a superscript to indicate their earliest API version.

cursorControl

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

setCursor

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

setCursor(value: PointerStyle): void

Sets the current mouse cursor style. This API can be used globally in method statements.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Expand
Name Type Mandatory Description
value PointerStyle All consistent Cursor style.

restoreDefault

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

restoreDefault(): void

Restores the mouse cursor to the default arrow style. This API can be used globally in method statements.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.ArkUI.ArkUI.Full

PointerStyle

type PointerStyle = pointer.PointerStyle

Defines the pointer style.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.ArkUI.ArkUI.Full

Expand
Type Description
pointer.PointerStyle Pointer style.
NOTE

Directly using cursorControl can lead to the issue of ambiguous UI context. To avoid this, obtain the UIContext object using the getUIContext() API and then obtain the cursorControl bound to the instance using the getCursorController API.

Example

This example demonstrates how to change the mouse cursor style using setCursor.

Collapse
Word wrap
Dark theme
Copy code
  1. // xxx.ets
  2. import { pointer } from '@kit.InputKit';
  3. 

  4. @Entry
  5. @Component
  6. struct CursorControlExample {
  7.   @State text: string = '';
  8.   controller: TextInputController = new TextInputController()
  9. 

  10.   build() {
  11.     Column() {
  12.       Row()
  13.         .height(200)
  14.         .width(200)
  15.         .backgroundColor(Color.Green)
  16.         .position({ x: 60, y: 70 })
  17.         .onHover((flag) => {
  18.           if (flag) {
  19.             // You are advised to use this.getUIContext().getCursorController().setCursor().
  20.             cursorControl.setCursor(pointer.PointerStyle.EAST)
  21.           } else {
  22.             // You are advised to use this.getUIContext().getCursorController().restoreDefault().
  23.             cursorControl.restoreDefault()
  24.           }
  25.         })
  26.       Row()
  27.         .height(200)
  28.         .width(200)
  29.         .backgroundColor(Color.Blue)
  30.         .position({ x: 130, y: 120 })
  31.         .onHover((flag) => {
  32.           if (flag) {
  33.             // You are advised to use this.getUIContext().getCursorController().setCursor().
  34.             cursorControl.setCursor(pointer.PointerStyle.WEST)
  35.           } else {
  36.             // You are advised to use this.getUIContext().getCursorController().restoreDefault().
  37.             cursorControl.restoreDefault()
  38.           }
  39.         })
  40.     }.width('100%')
  41.   }
  42. }

Diagrams:

When the mouse hovers over the blue area, it displays a west-pointing arrow cursor style.

When the mouse hovers over the green area, it displays an east-pointing arrow cursor style.

Event Monopolization
Polymorphic Style
English
©2026 HUAWEI Developers. All rights reserved.
Terms of Use
Statement About HUAWEI Developers and Privacy
Cookies
Cookie Settings
Open-Source Software Notice
Search in References
Enter a keyword.