A slot for displaying the title of the dialog, expected to be one or two lines of text.

title

A slot for a [Button] indicating negative sentiment (e.g. No). Clicking the button must remove the dialog from the composition hierarchy.

negativeButton

A slot for a [Button] indicating positive sentiment (e.g. Yes). Clicking the button must remove the dialog from the composition hierarchy.

positiveButton

Modifier to be applied to the dialog content.

modifier

Optional slot for an icon to be shown at the top of the dialog.

icon

The scroll state for the dialog so that the scroll position can be displayed e.g. by the [PositionIndicator] passed to [Scaffold].

scrollState

[Color] representing the background color for the dialog.

backgroundColor

[Color] representing the color for [content].

contentColor

[Color] representing the color for [title].

titleColor

Icon [Color] that defaults to [contentColor], unless specifically overridden.

iconColor

The vertical arrangement of the dialog's children. This allows us to add 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 padding to apply around the whole of the dialog's contents.

contentPadding

A slot for additional content, expected to be 2-3 lines of text

content

[Alert] lays out the content for an opinionated, alert screen.

Alert

called when the user tries to dismiss the Dialog by clicking outside or pressing the back button. This is not called when the dismiss button is clicked.

onDismissRequest

button which is meant to confirm a proposed action, thus resolving what triggered the dialog. The dialog does not set up any events for this button so they need to be set up by the caller.

confirmButton

the [Modifier] to be applied to this dialog

button which is meant to dismiss the dialog. The dialog does not set up any events for this button so they need to be set up by the caller.

dismissButton

optional icon that will appear above the [title] or above the [text], in case a title was not provided.

title which should specify the purpose of the dialog. The title is not mandatory, because there may be sufficient information inside the [text].

text which presents the details regarding the dialog's purpose.

text

defines the shape of this dialog's container

shape

the color used for the background of this dialog. Use [Color.Transparent] to have no color.

containerColor

iconContentColor

titleContentColor

textContentColor

when [containerColor] is [ColorScheme.surface], a translucent primary color overlay is applied on top of the container. A higher tonal elevation value will result in a darker color in light theme and lighter color in dark theme. See also: [Surface].

tonalElevation

typically platform specific properties to further configure the dialog

properties

AlertDialog

the [Modifier] to be applied to this badge

the color used for the background of this badge

the preferred color for content inside this badge. Defaults to either the matching content color for [containerColor], or to the current [LocalContentColor] if [containerColor] is not a color from the theme.

optional content to be rendered inside this badg

Badge

the badge to be displayed - typically a [Badge]

badge

the [Modifier] to be applied to this BadgedBox

the anchor to which this badge will be positione

BadgedBox

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

value

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

onValueChange

[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.

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

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

the progress of this progress indicator, where 0.0 represents no progress and 1.0 represents full progress. Values outside of this range are coerced into the range.

progress

the [Modifier] to be applied to this progress indicator

strokeWidth

color of the track behind the indicator, visible when the progress has not reached the area of the overall indicator yet

trackColor

stroke cap to use for the ends of this progress indicato

strokeCap

Determinate Material Design circular progress indicator

CircularProgressIndicator

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

Event invoked when the dialog has been shown for [durationMillis].

onTimeout

An optional slot for displaying an icon or image.

The number of milliseconds for which the dialog is displayed, must be positive. Suggested values are [DialogDefaults.ShortDurationMillis], [DialogDefaults.LongDurationMillis] or [DialogDefaults.IndefiniteDurationMillis].

durationMillis

[Color] representing the background color for this dialog.

Icon [Color] that defaults to the [contentColor], unless specifically overridden.

A slot for the dialog title, expected to be one line of text

[Confirmation] lays out the content for an opinionated confirmation screen that displays a message to the user for [durationMillis].

Confirmation

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

the [Modifier] to be applied to this icon button

controls the enabled state of this icon button. When `false`, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.

defines the shape of this icon button's container

[IconButtonColors] that will be used to resolve the colors used for this icon button in different states. See [IconButtonDefaults.filledIconButtonColors].

colors

the [MutableInteractionSource] representing the stream of [Interaction]s for this icon button. You can create and pass in your own `remember`ed instance to observe [Interaction]s and customize the appearance / behavior of this icon button in different states.

the content of this icon button, typically an [Icon

FilledIconButton

whether this icon button is toggled on or off

checked

onCheckedChange

[IconToggleButtonColors] that will be used to resolve the colors used for this icon button in different states. See [IconButtonDefaults.filledIconToggleButtonColors].

Material Design filled icon toggle button

FilledIconToggleButton

the input text to be shown in the text field

the label to be displayed inside the text field container. The default text style for internal [Text] is [Typography.caption] when the text field is in focus and [Typography.subtitle1] when the text field is not in focus

label

FilledTextField

A list of all Jetpack Compose Communication components listed on our website, you can use in your Jetpack Compose projects.

Jetpack Compose Communication components

AlertDialog

Badge

BadgedBox

CircularProgressIndicator

FilledIconButton

FilledIconToggleButton

FilledTonalIconButton

FilledTonalIconToggleButton

IconButton

IconToggleButton

LinearProgressIndicator

OutlinedIconButton

OutlinedIconToggleButton

OutlinedTextField

Snackbar

TextButton

Bring your next idea to life with Compose UI