SemanticsProperties

Added in 1.0.0

Cmn
```
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`	Cmn
`SemanticsPropertyKey<CollectionItemInfo>`	`CollectionItemInfo`	Cmn
`SemanticsPropertyKey<List<String>>`	`ContentDescription`	Cmn
`SemanticsPropertyKey<Unit>`	`Disabled`	Cmn
`SemanticsPropertyKey<AnnotatedString>`	`EditableText`	Cmn
`SemanticsPropertyKey<String>`	`Error`	Cmn
`SemanticsPropertyKey<Boolean>`	`Focused`	Cmn
`SemanticsPropertyKey<Unit>`	`Heading`	Cmn
`SemanticsPropertyKey<Unit>`	`HideFromAccessibility`	Cmn
`SemanticsPropertyKey<ScrollAxisRange>`	`HorizontalScrollAxisRange`	Cmn
`SemanticsPropertyKey<ImeAction>`	`ImeAction`	Cmn
`SemanticsPropertyKey<(Any) -> Int>`	`IndexForKey`	Cmn
`SemanticsPropertyKey<Unit>`	`@ExperimentalComposeUiApi InvisibleToUser` This property is deprecated. Use `hideFromAccessibility` instead.	Cmn
`SemanticsPropertyKey<Boolean>`	`IsContainer` This property is deprecated. Use `isTraversalGroup` instead.	Cmn
`SemanticsPropertyKey<Unit>`	`IsDialog`	Cmn
`SemanticsPropertyKey<Boolean>`	`IsEditable`	Cmn
`SemanticsPropertyKey<Unit>`	`IsPopup`	Cmn
`SemanticsPropertyKey<Boolean>`	`IsShowingTextSubstitution`	Cmn
`SemanticsPropertyKey<Boolean>`	`IsTraversalGroup`	Cmn
`SemanticsPropertyKey<Unit>`	`LinkTestMarker` 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>`	`LiveRegion`	Cmn
`SemanticsPropertyKey<Int>`	`MaxTextLength`	Cmn
`SemanticsPropertyKey<String>`	`PaneTitle`	Cmn
`SemanticsPropertyKey<Unit>`	`Password`	Cmn
`SemanticsPropertyKey<ProgressBarRangeInfo>`	`ProgressBarRangeInfo`	Cmn
`SemanticsPropertyKey<Role>`	`Role` The type of user interface element.	Cmn
`SemanticsPropertyKey<Unit>`	`SelectableGroup`	Cmn
`SemanticsPropertyKey<Boolean>`	`Selected`	Cmn
`SemanticsPropertyKey<String>`	`StateDescription`	Cmn
`SemanticsPropertyKey<String>`	`TestTag`	Cmn
`SemanticsPropertyKey<List<AnnotatedString>>`	`Text`	Cmn
`SemanticsPropertyKey<TextRange>`	`TextSelectionRange`	Cmn
`SemanticsPropertyKey<AnnotatedString>`	`TextSubstitution`	Cmn
`SemanticsPropertyKey<ToggleableState>`	`ToggleableState`	Cmn
`SemanticsPropertyKey<Float>`	`TraversalIndex`	Cmn
`SemanticsPropertyKey<ScrollAxisRange>`	`VerticalScrollAxisRange`	Cmn

Public properties

CollectionInfo

Cmn

Added in 1.0.0

val CollectionInfo: SemanticsPropertyKey<CollectionInfo>

See also
`collectionInfo`

CollectionItemInfo

Cmn

Added in 1.0.0

val CollectionItemInfo: SemanticsPropertyKey<CollectionItemInfo>

See also
`collectionItemInfo`

ContentDescription

Cmn

Added in 1.0.0

val ContentDescription: SemanticsPropertyKey<List<String>>

See also
`contentDescription`

Disabled

Cmn

Added in 1.0.0

val Disabled: SemanticsPropertyKey<Unit>

See also
`disabled`

EditableText

Cmn

Added in 1.0.0

val EditableText: SemanticsPropertyKey<AnnotatedString>

See also
`editableText`

Error

Cmn

Added in 1.0.0

val Error: SemanticsPropertyKey<String>

See also
`error`

Focused

Cmn

Added in 1.0.0

val Focused: SemanticsPropertyKey<Boolean>

See also
`focused`

Heading

Cmn

Added in 1.0.0

val Heading: SemanticsPropertyKey<Unit>

See also
`heading`

HideFromAccessibility

Cmn

Added in 1.8.0-alpha04

val HideFromAccessibility: SemanticsPropertyKey<Unit>

See also
`hideFromAccessibility`

HorizontalScrollAxisRange

Cmn

Added in 1.0.0

val HorizontalScrollAxisRange: SemanticsPropertyKey<ScrollAxisRange>

See also
`horizontalScrollAxisRange`

ImeAction

Cmn

Added in 1.0.0

val ImeAction: SemanticsPropertyKey<ImeAction>

See also
`onImeAction`

IndexForKey

Cmn

Added in 1.0.0

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

See also
`indexForKey`

InvisibleToUser

Cmn

Added in 1.0.0

Deprecated in 1.8.0-alpha04

@ExperimentalComposeUiApi
val InvisibleToUser: SemanticsPropertyKey<Unit>

See also
`invisibleToUser`

IsContainer

Cmn

Added in 1.4.0

Deprecated in 1.5.0

val IsContainer: SemanticsPropertyKey<Boolean>

See also
`isContainer`

IsDialog

Cmn

Added in 1.0.0

val IsDialog: SemanticsPropertyKey<Unit>

See also
`dialog`

IsEditable

Cmn

Added in 1.7.0

val IsEditable: SemanticsPropertyKey<Boolean>

See also
`isEditable`

IsPopup

Cmn

Added in 1.0.0

val IsPopup: SemanticsPropertyKey<Unit>

See also
`popup`

IsShowingTextSubstitution

Cmn

Added in 1.6.0

val IsShowingTextSubstitution: SemanticsPropertyKey<Boolean>

See also
`isShowingTextSubstitution`

IsTraversalGroup

Cmn

Added in 1.5.0

val IsTraversalGroup: SemanticsPropertyKey<Boolean>

See also
`isTraversalGroup`

LinkTestMarker

Cmn

Added in 1.8.0-alpha04

val LinkTestMarker: 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. This property is for internal use only and not intended for general use by developers.

LiveRegion

Cmn

Added in 1.0.0

val LiveRegion: SemanticsPropertyKey<LiveRegionMode>

See also
`liveRegion`

MaxTextLength

Cmn

Added in 1.7.0

val MaxTextLength: SemanticsPropertyKey<Int>

See also
`maxTextLength`

PaneTitle

Cmn

Added in 1.0.0

val PaneTitle: SemanticsPropertyKey<String>

See also
`paneTitle`

Password

Cmn

Added in 1.0.0

val Password: SemanticsPropertyKey<Unit>

See also
`password`

ProgressBarRangeInfo

Cmn

Added in 1.0.0

val ProgressBarRangeInfo: SemanticsPropertyKey<ProgressBarRangeInfo>

See also
`progressBarRangeInfo`

Role

Cmn

Added in 1.0.0

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

Cmn

Added in 1.0.0

val SelectableGroup: SemanticsPropertyKey<Unit>

See also
`selectableGroup`

Selected

Cmn

Added in 1.0.0

val Selected: SemanticsPropertyKey<Boolean>

See also
`selected`

StateDescription

Cmn

Added in 1.0.0

val StateDescription: SemanticsPropertyKey<String>

See also
`stateDescription`

TestTag

Cmn

Added in 1.0.0

val TestTag: SemanticsPropertyKey<String>

See also
`testTag`

Text

Cmn

Added in 1.0.0

val Text: SemanticsPropertyKey<List<AnnotatedString>>

See also
`text`

TextSelectionRange

Cmn

Added in 1.0.0

val TextSelectionRange: SemanticsPropertyKey<TextRange>

See also
`textSelectionRange`

TextSubstitution

Cmn

Added in 1.6.0

val TextSubstitution: SemanticsPropertyKey<AnnotatedString>

See also
`textSubstitution`

ToggleableState

Cmn

Added in 1.0.0

val ToggleableState: SemanticsPropertyKey<ToggleableState>

See also
`toggleableState`

TraversalIndex

Cmn

Added in 1.5.0

val TraversalIndex: SemanticsPropertyKey<Float>

See also
`traversalIndex`

VerticalScrollAxisRange

Cmn

Added in 1.0.0

val VerticalScrollAxisRange: SemanticsPropertyKey<ScrollAxisRange>

See also
`verticalScrollAxisRange`