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<ColorProducer>
Cmn
SemanticsPropertyKey<CollectionInfo>
Cmn
SemanticsPropertyKey<CollectionItemInfo>
Cmn
SemanticsPropertyKey<ContentDataType>
Cmn
SemanticsPropertyKey<List<String>>
Cmn
SemanticsPropertyKey<ContentType>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<AnnotatedString>
Cmn
SemanticsPropertyKey<String>
Cmn
SemanticsPropertyKey<FillableData>
Cmn
SemanticsPropertyKey<Boolean>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<String>
Cmn
SemanticsPropertyKey<ScrollAxisRange>
Cmn
SemanticsPropertyKey<ImeAction>
Cmn
SemanticsPropertyKey<(Any) -> Int>
Cmn
SemanticsPropertyKey<AnnotatedString>
Cmn
SemanticsPropertyKey<InputTextSuggestionState>
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<Boolean>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<Boolean>
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<Shape>
Cmn
SemanticsPropertyKey<String>
Cmn
SemanticsPropertyKey<String>
Cmn
SemanticsPropertyKey<List<AnnotatedString>>
Cmn
SemanticsPropertyKey<TextRange?>
Cmn
SemanticsPropertyKey<Unit>
Cmn
SemanticsPropertyKey<TextRange>
Cmn
SemanticsPropertyKey<AnnotatedString>
Cmn
SemanticsPropertyKey<ToggleableState>
Cmn
SemanticsPropertyKey<Float>
Cmn
SemanticsPropertyKey<ScrollAxisRange>
Cmn

Public properties

BackgroundColor

val BackgroundColor: SemanticsPropertyKey<ColorProducer>
See also
backgroundColor

CollectionInfo

val CollectionInfo: SemanticsPropertyKey<CollectionInfo>
See also
collectionInfo

CollectionItemInfo

val CollectionItemInfo: SemanticsPropertyKey<CollectionItemInfo>

ContentDataType

val ContentDataType: SemanticsPropertyKey<ContentDataType>
See also
contentDataType

ContentDescription

val ContentDescription: SemanticsPropertyKey<List<String>>

ContentType

val ContentType: SemanticsPropertyKey<ContentType>
See also
contentType

Disabled

val Disabled: SemanticsPropertyKey<Unit>
See also
disabled

EditableText

val EditableText: SemanticsPropertyKey<AnnotatedString>
See also
editableText

Error

val Error: SemanticsPropertyKey<String>
See also
error

FillableData

val FillableData: SemanticsPropertyKey<FillableData>
See also
fillableData

Focused

val Focused: SemanticsPropertyKey<Boolean>
See also
focused

Heading

val Heading: SemanticsPropertyKey<Unit>
See also
heading

HideFromAccessibility

val HideFromAccessibility: SemanticsPropertyKey<Unit>

HintText

val HintText: SemanticsPropertyKey<String>
See also
hintText

HorizontalScrollAxisRange

val HorizontalScrollAxisRange: SemanticsPropertyKey<ScrollAxisRange>

ImeAction

val ImeAction: SemanticsPropertyKey<ImeAction>
See also
onImeAction

IndexForKey

val IndexForKey: SemanticsPropertyKey<(Any) -> Int>
See also
indexForKey

InputText

val InputText: SemanticsPropertyKey<AnnotatedString>
See also
inputText

InvisibleToUser

val InvisibleToUser: SemanticsPropertyKey<Unit>
See also
invisibleToUser

IsContainer

val IsContainer: SemanticsPropertyKey<Boolean>
See also
isContainer

IsDialog

val IsDialog: SemanticsPropertyKey<Unit>
See also
dialog

IsEditable

val IsEditable: SemanticsPropertyKey<Boolean>
See also
isEditable

IsPasswordObfuscated

val IsPasswordObfuscated: SemanticsPropertyKey<Boolean>
See also
password

IsPopup

val IsPopup: SemanticsPropertyKey<Unit>
See also
popup

IsSensitiveData

val IsSensitiveData: SemanticsPropertyKey<Boolean>
See also
isSensitiveData

IsShowingTextSubstitution

val IsShowingTextSubstitution: SemanticsPropertyKey<Boolean>

IsTraversalGroup

val IsTraversalGroup: SemanticsPropertyKey<Boolean>
See also
isTraversalGroup

LinkTestMarker

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

val LiveRegion: SemanticsPropertyKey<LiveRegionMode>
See also
liveRegion

MaxTextLength

val MaxTextLength: SemanticsPropertyKey<Int>
See also
maxTextLength

PaneTitle

val PaneTitle: SemanticsPropertyKey<String>
See also
paneTitle

Password

val Password: SemanticsPropertyKey<Unit>
See also
password

ProgressBarRangeInfo

val ProgressBarRangeInfo: SemanticsPropertyKey<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

Shape

val Shape: SemanticsPropertyKey<Shape>
See also
shape

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

TextCompositionRange

val TextCompositionRange: SemanticsPropertyKey<TextRange?>

TextEntryKey

val TextEntryKey: SemanticsPropertyKey<Unit>
See also
textEntryKey

TextSelectionRange

val TextSelectionRange: SemanticsPropertyKey<TextRange>

TextSubstitution

val TextSubstitution: SemanticsPropertyKey<AnnotatedString>
See also
textSubstitution

ToggleableState

val ToggleableState: SemanticsPropertyKey<ToggleableState>
See also
toggleableState

TraversalIndex

val TraversalIndex: SemanticsPropertyKey<Float>
See also
traversalIndex

VerticalScrollAxisRange

val VerticalScrollAxisRange: SemanticsPropertyKey<ScrollAxisRange>