SemanticsProperties

Kotlin |Java

object 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>`	`CollectionInfo`
`SemanticsPropertyKey<CollectionItemInfo>`	`CollectionItemInfo`
`SemanticsPropertyKey<List<String>>`	`ContentDescription`
`SemanticsPropertyKey<Unit>`	`Disabled`
`SemanticsPropertyKey<AnnotatedString>`	`EditableText`
`SemanticsPropertyKey<String>`	`Error`
`SemanticsPropertyKey<Boolean>`	`Focused`
`SemanticsPropertyKey<Unit>`	`Heading`
`SemanticsPropertyKey<ScrollAxisRange>`	`HorizontalScrollAxisRange`
`SemanticsPropertyKey<ImeAction>`	`ImeAction`
`SemanticsPropertyKey<(Any) -> Int>`	`IndexForKey`
`SemanticsPropertyKey<Unit>`	`@ExperimentalComposeUiApi InvisibleToUser`
`SemanticsPropertyKey<Unit>`	`IsDialog`
`SemanticsPropertyKey<Unit>`	`IsPopup`
`SemanticsPropertyKey<LiveRegionMode>`	`LiveRegion`
`SemanticsPropertyKey<String>`	`PaneTitle`
`SemanticsPropertyKey<Unit>`	`Password`
`SemanticsPropertyKey<ProgressBarRangeInfo>`	`ProgressBarRangeInfo`
`SemanticsPropertyKey<Role>`	`Role` The type of user interface element.
`SemanticsPropertyKey<Unit>`	`SelectableGroup`
`SemanticsPropertyKey<Boolean>`	`Selected`
`SemanticsPropertyKey<String>`	`StateDescription`
`SemanticsPropertyKey<String>`	`TestTag`
`SemanticsPropertyKey<List<AnnotatedString>>`	`Text`
`SemanticsPropertyKey<TextRange>`	`TextSelectionRange`
`SemanticsPropertyKey<ToggleableState>`	`ToggleableState`
`SemanticsPropertyKey<ScrollAxisRange>`	`VerticalScrollAxisRange`

Public properties

CollectionInfo

val CollectionInfo: SemanticsPropertyKey<CollectionInfo>

See also
`collectionInfo`

CollectionItemInfo

val CollectionItemInfo: SemanticsPropertyKey<CollectionItemInfo>

See also
`collectionItemInfo`

ContentDescription

val ContentDescription: SemanticsPropertyKey<List<String>>

See also
`contentDescription`

Disabled

val Disabled: SemanticsPropertyKey<Unit>

See also
`disabled`

EditableText

val EditableText: SemanticsPropertyKey<AnnotatedString>

See also
`editableText`

Error

val Error: SemanticsPropertyKey<String>

See also
`error`

Focused

val Focused: SemanticsPropertyKey<Boolean>

See also
`focused`

Heading

val Heading: SemanticsPropertyKey<Unit>

See also
`heading`

HorizontalScrollAxisRange

val HorizontalScrollAxisRange: SemanticsPropertyKey<ScrollAxisRange>

See also
`horizontalScrollAxisRange`

ImeAction

val ImeAction: SemanticsPropertyKey<ImeAction>

See also
`imeAction`

IndexForKey

val IndexForKey: SemanticsPropertyKey<(Any) -> Int>

See also
`indexForKey`

InvisibleToUser

@ExperimentalComposeUiApi
val InvisibleToUser: SemanticsPropertyKey<Unit>

See also
`invisibleToUser`

IsDialog

val IsDialog: SemanticsPropertyKey<Unit>

See also
`dialog`

IsPopup

val IsPopup: SemanticsPropertyKey<Unit>

See also
`popup`

LiveRegion

val LiveRegion: SemanticsPropertyKey<LiveRegionMode>

See also
`liveRegion`

PaneTitle

val PaneTitle: SemanticsPropertyKey<String>

See also
`paneTitle`

Password

val Password: SemanticsPropertyKey<Unit>

See also
`password`

ProgressBarRangeInfo

val ProgressBarRangeInfo: SemanticsPropertyKey<ProgressBarRangeInfo>

See also
`progressBarRangeInfo`

Role

val Role: SemanticsPropertyKey<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 SelectableGroup: SemanticsPropertyKey<Unit>

See also
`selectableGroup`

Selected

val Selected: SemanticsPropertyKey<Boolean>

See also
`selected`

StateDescription

val StateDescription: SemanticsPropertyKey<String>

See also
`stateDescription`

TestTag

val TestTag: SemanticsPropertyKey<String>

See also
`testTag`

Text

val Text: SemanticsPropertyKey<List<AnnotatedString>>

See also
`text`

TextSelectionRange

val TextSelectionRange: SemanticsPropertyKey<TextRange>

See also
`textSelectionRange`

ToggleableState

val ToggleableState: SemanticsPropertyKey<ToggleableState>

See also
`toggleableState`

VerticalScrollAxisRange

val VerticalScrollAxisRange: SemanticsPropertyKey<ScrollAxisRange>

See also
`verticalScrollAxisRange`