pointerHoverIcon

Modifier in Compose Ui

Modifier that lets a developer define a pointer icon to display when the cursor is hovered over the element. When [overrideDescendants] is set to true, descendants cannot override the pointer icon using this modifier.

Last updated: 2024-09-07 14:23

Installation

dependencies {
   implementation("androidx.compose.ui:ui:1.8.0-alpha01")
}

Overloads

@Stable
fun Modifier.pointerHoverIcon(icon: PointerIcon, overrideDescendants: Boolean = false)

Parameters

name	description
icon	The icon to set
overrideDescendants	when false (by default) descendants are able to set their own pointer icon. If true, no descendants under this parent are eligible to change the icon (it will be set to the this [the parent's] icon).

Code Example

PointerIconSample

@Composable
fun PointerIconSample() {
    Column(Modifier.pointerHoverIcon(PointerIcon.Crosshair)) {
        SelectionContainer {
            Column {
                Text("Selectable text")
                Text(
                    modifier = Modifier.pointerHoverIcon(PointerIcon.Hand, true),
                    text = "Selectable text with hand"
                )
            }
        }
        Text("Just text with global pointerIcon")
    }
}