SemanticsProperties


General semantics properties, mainly used for accessibility and testing.

Each of these is intended to be set by the respective SemanticsPropertyReceiver extension instead of used directly.

Summary

Public properties

SemanticsPropertyKey<CollectionInfo>
Cmn
SemanticsPropertyKey<CollectionItemInfo>
Cmn
SemanticsPropertyKey<List<String>>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<AnnotatedString>
Cmn
SemanticsPropertyKey<String>
Cmn
SemanticsPropertyKey<Boolean>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<ScrollAxisRange>
Cmn
SemanticsPropertyKey<ImeAction>
Cmn
SemanticsPropertyKey<(Any) -> Int>
Cmn
SemanticsPropertyKey<Unit>

This property is deprecated. Use `hideFromAccessibility` instead.

Cmn
SemanticsPropertyKey<Boolean>

This property is deprecated. Use `isTraversalGroup` instead.

Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<Boolean>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<Boolean>
Cmn
SemanticsPropertyKey<Boolean>
Cmn
SemanticsPropertyKey<Unit>

Marks a link within a text node (a link is represented by a androidx.compose.ui.text.LinkAnnotation) for identification during automated testing.

Cmn
SemanticsPropertyKey<LiveRegionMode>
Cmn
SemanticsPropertyKey<Int>
Cmn
SemanticsPropertyKey<String>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<ProgressBarRangeInfo>
Cmn
SemanticsPropertyKey<Role>

The type of user interface element.

Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<Boolean>
Cmn
SemanticsPropertyKey<String>
Cmn
SemanticsPropertyKey<String>
Cmn
SemanticsPropertyKey<List<AnnotatedString>>
Cmn
SemanticsPropertyKey<TextRange>
Cmn
SemanticsPropertyKey<AnnotatedString>
Cmn
SemanticsPropertyKey<ToggleableState>
Cmn
SemanticsPropertyKey<Float>
Cmn
SemanticsPropertyKey<ScrollAxisRange>
Cmn

Public properties

CollectionInfo

val CollectionInfoSemanticsPropertyKey<CollectionInfo>
See also
collectionInfo

CollectionItemInfo

val CollectionItemInfoSemanticsPropertyKey<CollectionItemInfo>

ContentDescription

val ContentDescriptionSemanticsPropertyKey<List<String>>

Disabled

val DisabledSemanticsPropertyKey<Unit>
See also
disabled

EditableText

val EditableTextSemanticsPropertyKey<AnnotatedString>
See also
editableText

Error

val ErrorSemanticsPropertyKey<String>
See also
error

Focused

val FocusedSemanticsPropertyKey<Boolean>
See also
focused

Heading

val HeadingSemanticsPropertyKey<Unit>
See also
heading

HideFromAccessibility

val HideFromAccessibilitySemanticsPropertyKey<Unit>

HorizontalScrollAxisRange

val HorizontalScrollAxisRangeSemanticsPropertyKey<ScrollAxisRange>

ImeAction

val ImeActionSemanticsPropertyKey<ImeAction>
See also
onImeAction

IndexForKey

val IndexForKeySemanticsPropertyKey<(Any) -> Int>
See also
indexForKey

InvisibleToUser

@ExperimentalComposeUiApi
val InvisibleToUserSemanticsPropertyKey<Unit>
See also
invisibleToUser

IsContainer

val IsContainerSemanticsPropertyKey<Boolean>
See also
isContainer

IsDialog

val IsDialogSemanticsPropertyKey<Unit>
See also
dialog

IsEditable

val IsEditableSemanticsPropertyKey<Boolean>
See also
isEditable

IsPopup

val IsPopupSemanticsPropertyKey<Unit>
See also
popup

IsShowingTextSubstitution

val IsShowingTextSubstitutionSemanticsPropertyKey<Boolean>

IsTraversalGroup

val IsTraversalGroupSemanticsPropertyKey<Boolean>
See also
isTraversalGroup

LinkTestMarker

val LinkTestMarkerSemanticsPropertyKey<Unit>

Marks a link within a text node (a link is represented by a androidx.compose.ui.text.LinkAnnotation) for identification during automated testing. This property is for internal use only and not intended for general use by developers.

LiveRegion

val LiveRegionSemanticsPropertyKey<LiveRegionMode>
See also
liveRegion

MaxTextLength

val MaxTextLengthSemanticsPropertyKey<Int>
See also
maxTextLength

PaneTitle

val PaneTitleSemanticsPropertyKey<String>
See also
paneTitle

Password

val PasswordSemanticsPropertyKey<Unit>
See also
password

ProgressBarRangeInfo

val ProgressBarRangeInfoSemanticsPropertyKey<ProgressBarRangeInfo>

Role

val RoleSemanticsPropertyKey<Role>

The type of user interface element. Accessibility services might use this to describe the element or do customizations. Most roles can be automatically resolved by the semantics properties of this element. But some elements with subtle differences need an exact role. If an exact role is not listed in Role, this property should not be set and the framework will automatically resolve it.

See also
role

SelectableGroup

val SelectableGroupSemanticsPropertyKey<Unit>
See also
selectableGroup

Selected

val SelectedSemanticsPropertyKey<Boolean>
See also
selected

StateDescription

val StateDescriptionSemanticsPropertyKey<String>
See also
stateDescription

TestTag

val TestTagSemanticsPropertyKey<String>
See also
testTag

Text

val TextSemanticsPropertyKey<List<AnnotatedString>>
See also
text

TextSelectionRange

val TextSelectionRangeSemanticsPropertyKey<TextRange>

TextSubstitution

val TextSubstitutionSemanticsPropertyKey<AnnotatedString>
See also
textSubstitution

ToggleableState

val ToggleableStateSemanticsPropertyKey<ToggleableState>
See also
toggleableState

TraversalIndex

val TraversalIndexSemanticsPropertyKey<Float>
See also
traversalIndex

VerticalScrollAxisRange

val VerticalScrollAxisRangeSemanticsPropertyKey<ScrollAxisRange>