SemanticsHintOverrides

data class SemanticsHintOverrides
kotlin.Any
   ↳ androidx.ui.core.semantics.SemanticsHintOverrides

Provides hint values which override the default hints on supported platforms.

On iOS, these values are always ignored.

Summary

Public constructors

<init>(onTapHint: String?, onLongPressHint: String?)

Provides hint values which override the default hints on supported platforms.

Properties

Boolean

Whether there are any non-null hint values.

String?

The hint text for a long press action.

String?

The hint text for a tap action.

Public constructors

<init>

SemanticsHintOverrides(
    onTapHint: String?,
    onLongPressHint: String?)

Provides hint values which override the default hints on supported platforms.

On iOS, these values are always ignored.

Properties

isNotEmpty

val isNotEmpty: Boolean

Whether there are any non-null hint values.

onLongPressHint

val onLongPressHint: String?

The hint text for a long press action.

If null, the standard hint is used instead.

The hint should describe what happens when a long press occurs, not the manner in which the long press is accomplished.

Bad: 'Double tap and hold to show tooltip'. Good: 'show tooltip'.

onTapHint

val onTapHint: String?

The hint text for a tap action.

If null, the standard hint is used instead.

The hint should describe what happens when a tap occurs, not the manner in which a tap is accomplished.

Bad: 'Double tap to show movies'. Good: 'show movies'.