Google is committed to advancing racial equity for Black communities. See how.

androidx.compose.foundation

Interfaces

Indication

Generic interface to define visual effects when certain interaction happens.

IndicationInstance

Generic interface to define the instance if the Indication to draw visual effects when certain interaction happens.

Interaction

An Interaction represents transient UI state for a component, typically separate from the actual 'business' state that a component may control.

Classes

BorderStroke

Class to specify the stroke to draw border with.

InteractionState

InteractionState represents a Set of Interactions present on a given component.

MutatorMutex

Mutual exclusion for UI state mutation over time.

ScrollState

State of the scroll.

Annotations

ExperimentalFoundationApi

InternalFoundationApi

Enums

MutatePriority

Priorities for performing mutation on state.

Top-level functions summary

Unit
BaseTextField(value: TextFieldValue, onValueChange: (TextFieldValue) -> Unit, modifier: Modifier = Modifier, textColor: Color = Color.Unspecified, textStyle: TextStyle = AmbientTextStyle.current, keyboardType: KeyboardType = KeyboardType.Text, imeAction: ImeAction = ImeAction.Unspecified, onImeActionPerformed: (ImeAction) -> Unit = {}, visualTransformation: VisualTransformation = VisualTransformation.None, onTextLayout: (TextLayoutResult) -> Unit = {}, onTextInputStarted: (SoftwareKeyboardController) -> Unit = {}, cursorColor: Color = AmbientContentColor.current)

Composable that enables users to edit text via hardware or software keyboard.

BorderStroke
BorderStroke(width: Dp, color: Color)

Create BorderStroke class with width and Color

Unit
Canvas(modifier: Modifier, onDraw: DrawScope.() -> Unit)

Component that allow you to specify an area on the screen and perform canvas drawing on this area.

Unit
ClickableText(text: AnnotatedString, modifier: Modifier = Modifier, style: TextStyle = TextStyle.Default, softWrap: Boolean = true, overflow: TextOverflow = TextOverflow.Clip, maxLines: Int = Int.MAX_VALUE, onTextLayout: (TextLayoutResult) -> Unit = {}, onClick: (Int) -> Unit)

A continent version of BasicText component to be able to handle click event on the text.

Unit
Icon(imageVector: ImageVector, modifier: Modifier = Modifier, tint: Color = AmbientContentColor.current)

Icon component that draws imageVector using tint, defaulting to AmbientContentColor.

Unit
Icon(bitmap: ImageBitmap, modifier: Modifier = Modifier, tint: Color = AmbientContentColor.current)

Icon component that draws bitmap using tint, defaulting to AmbientContentColor.

Unit
Icon(painter: Painter, modifier: Modifier = Modifier, tint: Color = AmbientContentColor.current)

Icon component that draws a painter using tint, defaulting to AmbientContentColor.

Unit
Image(bitmap: ImageBitmap, modifier: Modifier = Modifier, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null)

A composable that lays out and draws a given ImageBitmap.

Unit
Image(imageVector: ImageVector, modifier: Modifier = Modifier, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null)

A composable that lays out and draws a given ImageVector.

Unit
Image(painter: Painter, modifier: Modifier = Modifier, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = Defau