The [TextFieldValue] to be shown in the [BaseTextField].

value

Called when the input service updates values in [TextFieldValue].

onValueChange

modifier

[Color] to apply to the text. If [Color.Unspecified], and [textStyle] has no color set, this will be [AmbientContentColor].

textColor

Style configuration that applies at character level such as color, font etc. The default [textStyle] uses the [AmbientTextStyle] defined by the theme

textStyle

The keyboard type to be used in this text field. Note that this input type is honored by IME and shows corresponding keyboard but this is not guaranteed. For example, some IME may send non-ASCII character even if you set [KeyboardType.Ascii].

keyboardType

The IME action. This IME action is honored by IME and may show specific icons on the keyboard. For example, search icon may be shown if [ImeAction.Search] is specified. Then, when user tap that key, the [onImeActionPerformed] callback is called with specified ImeAction.

imeAction

Called when the input service requested an IME action. When the input service emitted an IME action, this callback is called with the emitted IME action. Note that this IME action may be different from what you specified in [imeAction].

onImeActionPerformed

The visual transformation filter for changing the visual representation of the input. By default no visual transformation is applied.

visualTransformation

Callback that is executed when a new text layout is calculated.

onTextLayout

Callback that is executed when the initialization has done for communicating with platform text input service, e.g. software keyboard on Android. Called with [SoftwareKeyboardController] instance which can be used for requesting input show/hide software keyboard.

onTextInputStarted

Color of the cursor. If [Color.Unspecified], there will be no cursor drawn  @see TextFieldValue @see ImeAction @see KeyboardType @see VisualTransformatio

cursorColor

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

BaseTextField

[TextFieldState] object that holds the internal state of a [BasicTextField2].

state

controls the enabled state of the [BasicTextField2]. When `false`, the text field will be neither editable nor focusable, the input of the text field will not be selectable.

enabled

Called when the user submits a form either by pressing the action button in the input method editor (IME), or by pressing the enter key on a hardware keyboard. If the user submits the form by pressing the action button in the IME, the provided IME action is passed to the function. If the user submits the form by pressing the enter key on a hardware keyboard, the defined [imeAction] parameter is passed to the function. Return true to indicate that the action has been handled completely, which will skip the default behavior, such as hiding the keyboard for the [ImeAction.Done] action.

onSubmit

The IME action. This IME action is honored by keyboard and may show specific icons on the keyboard.

Determines the method used to obscure the input text.

textObfuscationMode

The keyboard type to be used in this text field. It is set to [KeyboardType.Password] by default. Use [KeyboardType.NumberPassword] for numerical password fields.

Optional [TextEditFilter] that will be used to filter changes to the [TextFieldState] made by the user. The filter will be applied to changes made by hardware and software keyboard events, pasting or dropping text, accessibility services, and tests. The filter will _not_ be applied when changing the [state] programmatically, or when the filter is changed. If the filter is changed on an existing text field, it will be applied to the next user edit. the filter will not immediately affect the current [state].

filter

Style configuration for text content that's displayed in the editor.

the [MutableInteractionSource] representing the stream of [Interaction]s for this TextField. You can create and pass in your own remembered [MutableInteractionSource] if you want to observe [Interaction]s and customize the appearance / behavior of this TextField for different [Interaction]s.

interactionSource

[Brush] to paint cursor with. If [SolidColor] with [Color.Unspecified] provided, there will be no cursor drawn

cursorBrush

Used to manage the horizontal scroll when the input content exceeds the bounds of the text field. It controls the state of the scroll for the text field.

scrollState

Callback that is executed when a new text layout is calculated. A [TextLayoutResult] object that callback provides contains paragraph information, size of the text, baselines and other details. The callback can be used to add additional decoration or functionality to the text. For example, to draw a cursor or selection around the text. [Density] scope is the one that was used while creating the given text layout.

Composable lambda that allows to add decorations around text field, such as icon, placeholder, helper messages or similar, and automatically increase the hit target area of the text field. To allow you to control the placement of the inner text field relative to your decorations, the text field implementation will pass in a framework-controlled composable parameter "innerTextField" to the decorationBox lambda you provide. You must call innerTextField exactly once

decorationBox

BasicSecureTextField is a new text input component that is still in heavy development.

BasicSecureTextField

text

Style configuration for the text such as color, font, line height etc.

style

Callback that is executed when a new text layout is calculated. A [TextLayoutResult] object that callback provides contains paragraph information, size of the text, baselines and other details. The callback can be used to add additional decoration or functionality to the text. For example, to draw selection around the text.

overflow

Whether the text should break at soft line breaks. If false, the glyphs in the text will be positioned as if there was unlimited horizontal space. If [softWrap] is false, [overflow] and TextAlign may have unexpected effects.

softWrap

An optional maximum number of lines for the text to span, wrapping if necessary. If the text exceeds the given number of lines, it will be truncated according to [overflow] and [softWrap]. It is required that 1 <= [minLines] <= [maxLines].

maxLines

The minimum height in terms of minimum number of visible lines. It is required that 1 <= [minLines] <= [maxLines].

minLines

Overrides the text color provided in [style

color

Basic element that displays text and provides semantics / accessibility information.

BasicText

the input [String] text to be shown in the text field

the callback that is triggered when the input service updates the text. An updated text comes as a parameter of the callback

controls the enabled state of the [BasicTextField]. When `false`, the text field will be neither editable nor focusable, the input of the text field will not be selectable

controls the editable state of the [BasicTextField]. When `true`, the text field can not be modified, however, a user can focus it and copy text from it. Read-only text fields are usually used to display pre-filled forms that user can not edit

readOnly

Style configuration that applies at character level such as color, font etc.

software keyboard options that contains configuration such as [KeyboardType] and [ImeAction].

keyboardOptions

when the input service emits an IME action, the corresponding callback is called. Note that this IME action may be different from what you specified in [KeyboardOptions.imeAction].

keyboardActions

when set to true, this text field becomes a single horizontally scrolling text field instead of wrapping onto multiple lines. The keyboard will be informed to not show the return key as the [ImeAction]. [maxLines] and [minLines] are ignored as both are automatically set to 1.

singleLine

the maximum height in terms of maximum number of visible lines. It is required that 1 <= [minLines] <= [maxLines]. This parameter is ignored when [singleLine] is true.

the minimum height in terms of minimum number of visible lines. It is required that 1 <= [minLines] <= [maxLines]. This parameter is ignored when [singleLine] is true.

Callback that is executed when a new text layout is calculated. A [TextLayoutResult] object that callback provides contains paragraph information, size of the text, baselines and other details. The callback can be used to add additional decoration or functionality to the text. For example, to draw a cursor or selection around the text.

the [MutableInteractionSource] representing the stream of [Interaction]s for this TextField. You can create and pass in your own remembered [MutableInteractionSource] if you want to observe [Interaction]s and customize the appearance / behavior of this TextField in different [Interaction]s.

Basic composable that enables users to edit text via hardware or software keyboard, but provides no decorations like hint or placeholder.

BasicTextField

shape

The [Color] for background with. If [Color.Transparent], there will be no background

backgroundColor

[BorderStroke] object that specifies border appearance, such as size and color. If `null`, there will be no border

border

The padding to be applied inside Box, along its edges. Unless otherwise specified, content will be padded by the [BorderStroke.width], if [border] is provided

padding

sets the padding of the start edge. Setting this will override [padding] for the start edge

paddingStart

sets the padding of the top edge. Setting this will override [padding] for the top edge

paddingTop

sets the padding of the end edge. Setting this will override [padding] for the end edge

paddingEnd

sets the padding of the bottom edge. Setting this will override [padding] for the bottom edge

paddingBottom

gravity

A convenience composable that combines common layout and draw logic.

Whether the text should break at soft line breaks. If false, the glyphs in the text will be positioned as if there was unlimited horizontal space. If [softWrap] is false, [overflow] and [TextAlign] may have unexpected effects.

An optional maximum number of lines for the text to span, wrapping if necessary. If the text exceeds the given number of lines, it will be truncated according to [overflow] and [softWrap]. If it is not null, then it must be greater than zero.

Callback that is executed when users click the text. This callback is called with clicked character's offset

onClick

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

ClickableText

A map store composables that replaces certain ranges of the text. It's used to insert composables into text layout. Check [InlineTextContent] for more information.

inlineContent

Callback that is executed when a new text layout is calculated

CoreText is a low level element that displays text with multiple different styles.

CoreText

The [androidx.compose.ui.text.input.TextFieldValue] to be shown in the [CoreTextField].

Called when the input service updates the values in [TextFieldValue].

The [InteractionState] representing the different [Interaction]s present on this TextField. You can create and pass in your own remembered [InteractionState] if you want to read the [InteractionState] and customize the appearance / behavior of this TextField in different [Interaction]s.

interactionState

Color of the cursor. If [Color.Unspecified], there will be no cursor drawn

Whether the text should break at soft line breaks. If false, the glyphs in the text will be positioned as if there was unlimited horizontal space.

The maximum height in terms of maximum number of visible lines. Should be equal or greater than 1.

Contains different IME configuration options.

imeOptions

controls the enabled state of the text field. When `false`, the text field will be neither editable nor focusable, the input of the text field will not be selectable

controls the editable state of the [CoreTextField]. When `true`, the text field can not be modified, however, a user can focus it and copy text from it. Read-only text fields are usually used to display pre-filled forms that user can not edit

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

CoreTextField

callback to be called at the start of fling so the final value for fling can be adjuste

adjustTarget

defaultFlingConfig

[State] to delegate [LazyLayoutItemProvider] functionality to

delegate

Delegating version of [LazyLayoutItemProvider], abstracting internal [State] access.

DelegatingLazyLayoutItemProvider

Executes when the user tries to dismiss the Dialog.

onCloseRequest

The content to be displayed inside the dialog

children

Dialog

Disables text selection for its direct or indirect children.

DisableSelection

width of the border. Use [Dp.Hairline] for a hairline border.

size

Returns a [Modifier] that adds border with appearance specified with [size], [color] and a [shape]  @sample androidx.

DrawBorder

A modifier instance to be applied to this Pager outer layout

a padding around the whole content. This will add padding for the content after it has been clipped, which is not possible via [modifier] param. You can use it to add a padding before the first page or after the last one. Use [pageSpacing] to add spacing between the pages.

contentPadding

Use this to change how the pages will look like inside this pager.

pageSize

Pages to load before and after the list of visible pages. Note: Be aware that using a large value for [beyondBoundsPageCount] will cause a lot of pages to be composed, measured and placed which will defeat the purpose of using lazy loading. This should be used as an optimization to pre-load a couple of pages before and after the visible ones.

beyondBoundsPageCount

The amount of space to be used to separate the pages in this Pager

pageSpacing

How pages are aligned vertically in this Pager.

verticalAlignment

The [FlingBehavior] to be used for post scroll gestures.

flingBehavior

whether the scrolling via the user gestures or accessibility actions is allowed. You can still scroll programmatically using [PagerState.scroll] even when it is disabled.

userScrollEnabled

reverse the direction of scrolling and layout.

reverseLayout

a stable and unique key representing the item. When you specify the key the scroll position will be maintained based on the key, which means if you add/remove items before the current visible item the item with the given key will be kept as the first visible one.

A [NestedScrollConnection] that dictates how this [Pager] behaves with nested lists. The default behavior will see [Pager] to consume all nested deltas.

pageNestedScrollConnection

pageContent

HorizontalPager

imageVector

tint to be applied to [asset]. If [Color.Unspecified] is provided, then no  tint is applie

tint

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

Icon

bitmap

text used by accessibility services to describe what this image represents. This should always be provided unless this image is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using [androidx.compose.ui.res.stringResource] or similar

contentDescription

Modifier used to adjust the layout algorithm or draw decoration content (ex. background)

Optional alignment parameter used to place the [ImageBitmap] in the given bounds defined by the width and height

alignment

Optional scale parameter used to determine the aspect ratio scaling to be used if the bounds are a different size from the intrinsic size of the [ImageBitmap]

contentScale

Optional opacity to be applied to the [ImageBitmap] when it is rendered onscreen

alpha

Optional ColorFilter to apply for the [ImageBitmap] when it is rendered onscree

colorFilter

A composable that lays out and draws a given [ImageBitmap].

Image

the state object to be used to control or observe the list's state.

a padding around the whole content. This will add padding for the. content after it has been clipped, which is not possible via [modifier] param. You can use it to add a padding before the first item or after the last one. If you want to add a spacing between each item use [verticalArrangement].

reverse the direction of scrolling and layout. When `true`, items are laid out in the reverse order and [LazyListState.firstVisibleItemIndex] == 0 means that column is scrolled to the bottom. Note that [reverseLayout] does not change the behavior of [verticalArrangement], e.g. with [Arrangement.Top] (top) 123### (bottom) becomes (top) 321### (bottom).

The vertical arrangement of the layout's children. This allows to add a spacing between items and specify the arrangement of the items when we have not enough of them to fill the whole minimum size.

verticalArrangement

the horizontal alignment applied to the items.

horizontalAlignment

whether the scrolling via the user gestures or accessibility actions is allowed. You can still scroll programmatically using the state even when it is disabled

a block which describes the content. Inside this block you can use methods like [LazyListScope.item] to add a single item or [LazyListScope.items] to add a list of items

content

The vertically scrolling list that only composes and lays out the currently visible items.

LazyColumn

items

the state object to be used to control or observe the list's state

reverse the direction of scrolling and layout, when `true` items will be composed from the bottom to the top and [LazyListState.firstVisibleItemIndex] == 0 will mean we scrolled to the bottom.

the horizontal alignment applied to the items

emits the UI for an item from [items] list. May emit any number of components, which will be stacked vertically. Note that [LazyColumnFor] can start scrolling incorrectly if you emit nothing and then lazily recompose with the real content, so even if you load the content asynchronously please reserve some space for the item, for example using [Spacer]. Use [LazyColumnForIndexed] if you need to have both index and item params

itemContent

A vertically scrolling list that only composes and lays out the currently visible items.

LazyColumnFor

We extracted all components found in the Foundation library in one place. Explore all available and add them to your project.

Jetpack Compose Foundation components

Bring your next idea to life with Compose UI