Cursor - ZoboUI Docs

The Cursor utility controls the mouse cursor's appearance when hovering over UI elements. This utility is crucial for providing interactive feedback and enhancing the user experience in the Unity Editor.

Warning

This utility only works for Unity Editor UI. It will not affect the cursor at runtime or in a built game. For runtime cursor customization, you'll need to use the Cursor Image utility.

Utility Class	USS Properties
cursor-arrow	cursor: arrow;
cursor-text	cursor: text;
cursor-resize-vertical	cursor: resize-vertical;
cursor-resize-horizontal	cursor: resize-horizontal;
cursor-link	cursor: link;
cursor-slide-arrow	cursor: slide-arrow;
cursor-resize-up-right	cursor: resize-up-right;
cursor-resize-up-left	cursor: resize-up-left;
cursor-move-arrow	cursor: move-arrow;
cursor-rotate-arrow	cursor: rotate-arrow;
cursor-scale-arrow	cursor: scale-arrow;
cursor-arrow-plus	cursor: arrow-plus;
cursor-arrow-minus	cursor: arrow-minus;
cursor-pan	cursor: pan;
cursor-orbit	cursor: orbit;
cursor-zoom	cursor: zoom;
cursor-fps	cursor: fps;
cursor-split-resize-up-down	cursor: split-resize-up-down;
cursor-split-resize-left-right	cursor: split-resize-left-right;

Basic Usage in UXML

Arrow Cursor

<ui:VisualElement class="cursor-arrow">
    <!-- Element with an arrow cursor -->
</ui:VisualElement>

Customize

Modifier Variations

You can customize which modifier variations of the Cursor utility are generated, such as pseudo-classes (e.g., hover, focus) and custom modifiers.

By default, no modifier variations are defined for the Cursor utility.

By fine-tuning the utility variations, you maintain control over your stylesheet's size and complexity, ensuring that only necessary styles are included. To update these values:

Open the Theme Config Asset: Find the asset within your Unity project.
Navigate to the 'Utilities' Section: Locate the Cursor utility.
Adjust Modifier Variations: Select which modifiers you want to be generated for the utility. Keep in mind that the order of the modifiers will affect the order and specificity of the generated USS classes.

Class Tags and Properties

The Cursor utility generates classes based on predefined tags and their associated USS properties. While we recommend keeping these defaults for consistency and ease of reference in our documentation, you have the option to customize them to suit your project's specific needs.

These values are prepended to the defined values in this format tag-{value}. If a tag is empty, the generated class will simply be the value by itself.

Here are the default tags and the USS properties they set for the Cursor utility:

cursor : cursor

To customize these tags and properties, you can edit the Tag Property Map field for the Cursor utility in the Theme Config asset. This allows you to define new tags or modify existing ones, thus tailoring the generated classes to your preferences.

Extending Core Fields

The Cursor utility does not extend any fields from the Core section of the Theme Config asset. Before you try to extend any fields, we recommend checking Unity's documentation to verify which types of values are expected by the relevant USS properties.

To customize or define these extended fields:

Open the Theme Config Asset: Locate the asset within your Unity project.
Navigate to the 'Utilities' Section: Find the Cursor utility.
Customize Extend Fields: Modify or add fields in the Extend Fields array to change the core configuration values that are extended. You'll only be able to extend fields of the same type.

Disable Utility

The Cursor utility is enabled by default. You can disable it by unchecking the Enabled option in the Theme Config asset. This will prevent the generation of the utility's styles.