Composable Index

ActiveFocusListener
Alert

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

AlertDialog

Material Design alert dialog

AlertDialog

Basic alert dialog dialog

AlertDialog

Dialogs provide important prompts in a user flow.

AlertDialogContent

This AlertDialogContent overload provides the content for an AlertDialog without any dedicated slots for buttons.

AmbientTickEffect

A convenience extension that performs recurrent, battery-efficient UI updates when the device is in AmbientMode.Ambient.

AndroidEmbeddedExternalSurface

Provides a dedicated drawing Surface embedded directly in the UI hierarchy.

AndroidExternalSurface

Provides a dedicated drawing Surface as a separate layer positioned by default behind the window holding the AndroidExternalSurface composable.

AndroidFragment

Allows for adding a Fragment directly into Compose.

AndroidLayoutElement

Add LayoutElementBuilders.LayoutElement into the glance composition.

AndroidRemoteViews

Add RemoteViews into a glance composition.

AndroidView

Composes an Android View obtained from factory.

AndroidViewBinding

Composes an Android layout resource in the presence of ViewBinding.

AnimatedContent

AnimatedContent is a container that automatically animates its content when targetState changes.

AnimatedPage

Animates a page within a androidx.compose.foundation.pager.Pager with a scaling and scrim effect based on its position.

AnimatedPane

The root composable of pane contents in a ThreePaneScaffold that supports default motions during pane switching.

AnimatedSpatialVisibility

AnimatedSpatialVisibility composable animates the appearance and disappearance of its subspace content, as visible value changes.

AnimatedText

A composable that displays an animated text.

AnimatedVisibility

AnimatedVisibility composable animates the appearance and disappearance of its content, as visible value changes.

AppBarColumn

An AppBarColumn arranges its children in a vertical sequence, and if any children overflow the constraints, an overflow indicator is displayed.

AppBarOverflowIndicator

Default overflow indicator for an AppBarRow and AppBarColumn.

AppBarRow

An AppBarRow arranges its children in a horizontal sequence, and if any children overflow the constraints, an overflow indicator is displayed.

AppBarWithSearch

Material Design search

AppCard

Opinionated Wear Material Card that offers a specific 5 slot layout to show information about an application, e.g. a notification.

AppCard

Opinionated Wear Material 3 Card that offers a specific 5 slot layout to show information about an application, e.g. a notification.

AppScaffold

AppScaffold is one of the Wear Material3 scaffold components.

ArcProgressIndicator

Indeterminate Material Design arc progress indicator.

AssistChip

Material Design assist chip

AssistChip

Material Design assist chip

BackHandler

An effect for handling presses of the system back button.

BackdropScaffold

Material Design backdrop

Badge

Badge is a component that can contain dynamic information, such as the presence of a new notification or a number of pending requests.

Badge

A badge represents dynamic information such as a number of pending requests in a navigation bar.

BadgedBox

A BadgeBox is used to decorate content with a badge that can contain dynamic information, such as the presence of a new notification or a number of pending requests.

BadgedBox

Material Design badge box.

BasicAlertDialog

Basic alert dialog dialog

BasicAlertDialog

Basic alert dialog dialog.

BasicSecureTextField

BasicSecureTextField is specifically designed for password entry fields and is a preconfigured alternative to BasicTextField.

BasicSwipeToDismissBox

BasicSwipeToDismissBox that handles the swipe-to-dismiss gesture.

BasicText

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

BasicTextField

Basic text composable that provides an interactive box that accepts text input through software or hardware keyboard, but provides no decorations like hint or placeholder.

BasicTooltipBox

BasicTooltipBox that wraps a composable with a tooltip.

BottomAppBar

Material Design bottom app bar

BottomAppBar

Material Design bottom app bar

BottomDrawer

Material Design bottom navigation drawer

BottomNavigation

Material Design bottom navigation

BottomNavigationItem

Material Design bottom navigation

BottomSheet

Material Design bottom sheet

BottomSheetScaffold

Material Design standard bottom sheet

BottomSheetScaffold

Material Design standard bottom sheet scaffold

Box

A box with no content that can participate in layout, drawing, pointer input due to the modifier applied to it.

Box

A layout composable with content.

BoxWithConstraints

A composable that defines its own content according to the available space, based on the incoming constraints or the current LayoutDirection.

Button

Material Design contained button

Button

Material Design button

Button

Adds a button view to the glance view.

Button

Material Design filled button for TV.

Button

Wear Material Button that offers a single slot to take any content (text, icon or image).

Button

Base level Wear Material3 Button that offers a single slot to take any content.

Button

Button is a component used for exposing actions to a user.

ButtonGroup

A layout composable that places its children in a horizontal sequence.

ButtonGroup

Layout component to implement an expressive group of buttons in a row, that react to touch by growing the touched button, (while the neighbor(s) shrink to accommodate and keep the group width constant).

CameraXViewfinder

An adapter composable that displays frames from CameraX by completing provided SurfaceRequests.

Canvas

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

Card

Material Design card

Card

Material Design filled card

Card

Cards contain content and actions that relate information about a subject.

Card

Base level Wear Material Card that offers a single slot to take any content.

Card

Base level Wear Material 3 Card that offers a single slot to take any content.

Card

Card is a component used to group related information into a single digestible unit.

Carousel

Composes a hero card rotator to highlight a piece of content.

CenterAlignedTopAppBar

Material Design center-aligned small top app bar

CheckBox

Adds a check box view to the glance view.

Checkbox

Material Design checkbox

Checkbox

Material Design checkbox

Checkbox

Material Design checkbox.

Checkbox

Checkbox provides an animated checkbox for use as a toggle control in ToggleChip or SplitToggleChip.

CheckboxButton

The Wear Material CheckboxButton offers three slots and a specific layout for an icon, a label, and a secondaryLabel.

ChildButton

Base level Wear Material3 ChildButton that offers a single slot to take any content.

Chip

Material Design action chip.

Chip

Base level Wear Material Chip that offers a single slot to take any content.

CircleIconButton

Intended to fill the role of secondary icon button.

CircularProgressIndicator

Indeterminate Material Design circular progress indicator.

CircularProgressIndicator

Material Design determinate circular progress indicator

CircularProgressIndicator

Adds a circular progress indicator view to the glance view.

CircularProgressIndicator

Indeterminate Material Design circular progress indicator.

CircularProgressIndicator

Indeterminate Material Design circular progress indicator.

CircularWavyProgressIndicator

Material Design indeterminate circular progress indicator

ClassicCard

ClassicCard is an opinionated TV Material card that offers a 4 slot layout to show information about a subject.

ClickableText

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

Column

A layout composable that places its children in a vertical sequence.

Column

A layout composable with content, which lays its children out in a Column.

CompactButton

Wear Material CompactButton that offers a single slot to take any content (text, icon or image).

CompactButton

A Wear Material3 CompactButton that offers two slots and a specific layout for an icon and label.

CompactCard

CompactCard is an opinionated TV Material card that offers a 4 slot layout to show information about a subject.

CompactChip

A compact Wear Material Chip that offers two slots and a specific layout for an icon and label.

ComposeNode

Emits a node into the composition of type T.

CompositionLocalProvider

CompositionLocalProvider binds values to CompositionLocal's, provided by context.

Confirmation

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

ConfirmationDialog

Shows a transient ConfirmationDialog with an icon and optional very short curvedText.

ConfirmationDialogContent

This overload of ConfirmationDialogContent provides the content for a ConfirmationDialog with an icon and optional very short curvedText.

ConstraintLayout

Layout that positions its children according to the constraints between them.

ConstraintSet

Parses content into a ConstraintSet and sets the variables defined in the Variables block with the values of overrideVariables.

ContainedLoadingIndicator

A Material Design contained loading indicator.

ContentFrame

A container for displaying media content from a Player.

ContextualFlowColumn

ContextualFlowColumn is a specialized version of the FlowColumn layout.

ContextualFlowRow

ContextualFlowRow is a specialized version of the FlowRow layout.

Crossfade

Crossfade allows to switch between two layouts with a crossfade animation.

CurvedLayout

A layout composable that places its children in an arc, rotating them as needed.

CurvedRow

A curved layout container.

CustomizedLookaheadAnimationVisualDebugging

Allows customizing a particular shared element or animated bounds animation for debugging.

DatePicker

Material Design date picker

DatePicker

Full screen DatePicker with day, month, year.

DatePickerDialog

Material Design date picker dialog

DateRangePicker

Material Design date range picker

DenseListItem

Lists are continuous, vertical indexes of text or images.

DeviceConfigurationOverride

Applies DeviceConfigurationOverride to the content under test to apply some configuration override.

Dialog

Opens a dialog with the given content.

Dialog

Dialog displays a full-screen dialog, layered over any other content.

Dialog

A base dialog component used by AlertDialog and ConfirmationDialog variations.

DialogHost

Show each Destination on the DialogNavigator's back stack as a Dialog.

DisableSelection

Disables text selection for its direct or indirect children.

DismissibleDrawerSheet

Content inside of a dismissible navigation drawer.

DismissibleNavigationDrawer

Material Design navigation drawer

DisposableEffect

A side effect of composition that must be reversed or cleaned up if the DisposableEffect leaves the composition.

Divider

Material Design divider

Divider
DockedSearchBar

Material Design search

DropdownMenu

Material Design dropdown menu

DropdownMenu

Material Design dropdown menu

DropdownMenuGroup

Material Design dropdown menu

DropdownMenuItem

Material Design dropdown menu

DropdownMenuItem

Material Design dropdown menu

DropdownMenuPopup

Material Design dropdown menu

DurationText

A composable that displays the duration of the media.

EdgeButton

Wear Material3 EdgeButton that offers a single slot to take any content.

ElevatedAssistChip

Material Design elevated assist chip

ElevatedButton

Material Design elevated button

ElevatedCard

Material Design elevated card

ElevatedFilterChip

Material Design elevated filter chip

ElevatedSuggestionChip

Material Design elevated suggestion chip

ElevatedToggleButton

TODO link to mio page when available.

EmbeddedPhotoPicker

Compose entry-point into the EmbeddedPhotoPicker.

EnableXrComponentOverrides

Clients can wrap their Compose hierarchy in this function to dynamically enable XR components when in the proper environment.

ExpandedDockedSearchBar

ExpandedDockedSearchBar represents a search bar that is currently expanding or in the expanded state, showing search results.

ExpandedDockedSearchBarWithGap

ExpandedDockedSearchBarWithGap represents a search bar that is currently expanding or in the expanded state, showing search results.

ExpandedFullScreenContainedSearchBar

ExpandedFullScreenContainedSearchBar represents a search bar that is currently expanding or in the expanded state, showing search results, preserving the collapsed shape of the inputField without divider.

ExpandedFullScreenSearchBar

ExpandedFullScreenSearchBar represents a search bar that is currently expanding or in the expanded state, showing search results.

ExposedDropdownMenuBox

Material Design Exposed Dropdown Menu.

ExposedDropdownMenuBox

Material Design exposed dropdown menu

ExtendedFloatingActionButton

Material Design extended floating action button

ExtendedFloatingActionButton

Material Design extended floating action button

FadingExpandingLabel

Animates label text for which the number of lines can vary, changing the size of the container component.

FailureConfirmationDialog

Shows a FailureConfirmationDialog with a failure icon and an optional short curved text.

FailureConfirmationDialogContent

FailureConfirmationDialogContent provides the content for a failure confirmation dialog with icon and an optional short curved text.

FilledButton

A button styled per Material3.

FilledIconButton

Material Design filled icon button

FilledIconButton

Wear Material FilledIconButton is a circular, icon-only button with a colored background and a contrasting content color.

FilledIconToggleButton

Material Design filled icon button

FilledTonalButton

Material Design filled tonal button

FilledTonalButton

Base level Wear Material3 FilledTonalButton that offers a single slot to take any content.

FilledTonalIconButton

Material Design filled tonal icon button

FilledTonalIconButton

Wear Material FilledTonalIconButton is a circular, icon-only button with a muted, colored background and a contrasting icon color.

FilledTonalIconToggleButton

Material Design filled tonal icon toggle button

FilterChip

Material Design filter chip

FilterChip

Material Design filter chip

FilterChip

Material Design filter chip

FlexBox

A layout that aligns its children in a single direction (the main axis) and allows them to wrap onto multiple lines.

FlexibleBottomAppBar

Material Design flexible bottom app bar

FloatingActionButton

Material Design floating action button

FloatingActionButton

Material Design floating action button

FloatingActionButtonMenu

FAB Menus should be used in conjunction with a ToggleFloatingActionButton to provide additional choices to the user after clicking a FAB.

FloatingActionButtonMenuItem

FAB Menu Items should be used within a FloatingActionButtonMenu to provide additional choices to the user after clicking a FAB.

FlowColumn

FlowColumn is a layout that fills items from top to bottom, and when it runs out of space on the bottom, moves to the next "column" or "line" on the right or left based on ltr or rtl layouts, and then continues filling items from top to bottom.

FlowRow

FlowRow is a layout that fills items from left to right (ltr) in LTR layouts or right to left (rtl) in RTL layouts and when it runs out of space, moves to the next "row" or "line" positioned on the bottom, and then continues filling items until the items run out.

FollowingSubspace

Create a user-centric 3D space that is ideal for spatial UI content that follows a target.

GlanceTheme

A top level theme for Glance code.

GlimmerTheme

Jetpack Compose Glimmer contains different theme subsystems to allow visual customization across an application.

Grid

A 2D layout composable that arranges children into a grid of rows and columns.

Group

Defines a group of Paths and other Groups inside a VectorPainter.

HierarchicalFocusCoordinator
HorizontalCenteredHeroCarousel

Material Design Carousel

HorizontalDivider

Material Design divider

HorizontalFloatingToolbar

A horizontal floating toolbar displays navigation and key actions in a Row.

HorizontalFloatingToolbar

A horizontal floating toolbar displays navigation and key actions in a Row.

HorizontalMultiBrowseCarousel

Material Design Carousel

HorizontalPageIndicator

A horizontal indicator for a Pager, representing the currently active page and total pages drawn using a Shape.

HorizontalPageIndicator

Horizontal page indicator for use with HorizontalPager, representing the currently active page and the approximate number of pages.

HorizontalPager

A Pager that scrolls horizontally.

HorizontalPager

A horizontally scrolling Pager optimized for Wear OS devices.

HorizontalPagerScaffold

HorizontalPagerScaffold is one of the Wear Material3 scaffold components.

HorizontalUncontainedCarousel

Material Design Carousel

Icon

A Material Design icon component that draws bitmap using tint, with a default value of LocalContentColor.

Icon

A Material Design icon component that draws bitmap using tint, with a default value of LocalContentColor.

Icon

A Material Design icon component that draws bitmap using tint, with a default value of LocalContentColor.

Icon

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

Icon

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

Icon

An icon component that draws bitmap, with a default size of LocalIconSize, and applies a content color tint.

IconButton

IconButton is a clickable icon, used to represent actions.

IconButton

Material Design standard icon button

IconButton

Material Design standard icon button for TV.

IconButton

Wear Material IconButton is a circular, icon-only button with transparent background and no border.

IconToggleButton

An IconButton with two states, for icons that can be toggled 'on' and 'off', such as a bookmark icon, or a navigation icon that opens a drawer.

IconToggleButton

Material Design standard icon toggle button

IconToggleButton

Wear Material IconToggleButton is a filled icon toggle button which switches between primary colors and tonal colors depending on checked value, and offers a single slot for icon or image.

Image

A composable that lays out and draws a given ImageVector.

Image

A composable which lays out and draws the image specified in provider.

InInspectionModeOnly

A wrapper for inspection-mode-only behavior.

InProgressShapes

A Composable that displays in-progress ink shapes as it receives user pointer input.

InProgressStrokes

A Composable that displays in-progress ink strokes as it receives user pointer input.

InlineSlider

InlineSlider allows users to make a selection from a range of values.

InputChip

Material Design input chip

InputChip

Chips help people enter information, make selections, filter content, or trigger actions.

InterceptPlatformTextInput

Intercept all calls to PlatformTextInputSession.startInputMethod from below where this composition local is provided with the given PlatformTextInputInterceptor.

ItemHolder
Label

Label component that will append a label to content.

LargeExtendedFloatingActionButton

Material Design large extended floating action button

LargeFlexibleTopAppBar

Material Design large flexible top app bar

LargeFloatingActionButton

Material Design large floating action button

LargeTopAppBar

Material Design large top app bar

LaunchedEffect

When LaunchedEffect enters the composition it will launch block into the composition's CoroutineContext.

Layout

Layout is the main core component for layout for "leaf" nodes.

LazyColumn

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

LazyColumn

A vertical scrolling list that only lays out the currently visible items.

LazyHorizontalGrid

A lazy horizontal grid layout.

LazyHorizontalStaggeredGrid

Horizontal staggered grid layout that composes and lays out only items currently visible on screen.

LazyLayout

A layout that only composes and lays out currently needed items.

LazyLayoutPinnableItem

Wrapper supporting PinnableContainer in lazy layout items.

LazyRow

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

LazyVerticalGrid

A lazy vertical grid layout.

LazyVerticalGrid

The DSL implementation of a lazy grid layout.

LazyVerticalStaggeredGrid

Vertical staggered grid layout that composes and lays out only items currently visible on screen.

LeadingIconTab

Material Design tab

LeadingIconTab

Material Design tab

LevelIndicator

Creates a LevelIndicator for screens that that control a setting such as volume with either rotating side button, rotating bezel.

LevitatedPaneScrim

The default scrim implementation shown with a levitated pane to block the user interaction from the underlying layout.

LifecycleEventEffect

Schedule an effect to run when the Lifecycle receives a specific Lifecycle.Event.

LifecycleResumeEffect

It is an error to call LifecycleStartEffect without at least one key parameter.

LifecycleStartEffect

It is an error to call LifecycleStartEffect without at least one key parameter.

LinearProgressIndicator

Indeterminate Material Design linear progress indicator.

LinearProgressIndicator

Material Design indeterminate linear progress indicator

LinearProgressIndicator

Adds an indeterminate linear progress indicator view to the glance view.

LinearProgressIndicator

Material Design linear progress indicator.

LinearWavyProgressIndicator

Material Design indeterminate linear wavy progress indicator

ListDetailPaneScaffold

A three pane layout that follows the Material guidelines, displaying the provided panes in a canonical list-detail layout.

ListHeader

A slot based composable for creating a list header item.

ListHeader

A slot based composable for creating a list header item.

ListItem

Material Design list

ListItem

Material Design list item

ListItem

Lists are continuous, vertical indexes of text or images.

ListItem

ListItem is a component used to represent a single item in a androidx.xr.glimmer.list.VerticalList.

ListSubHeader

A two slot based composable for creating a list sub-header item.

LoadingIndicator

A Material Design loading indicator.

LocalOwnersProvider

Provides this as LocalViewModelStoreOwner, LocalLifecycleOwner and LocalSavedStateRegistryOwner to the content and saves the content's saveable states with the given saveableStateHolder.

LocalRetainedValuesStoreProvider

Installs the given RetainedValuesStore over the provided content such that all values retained in the content lambda are owned by store.

LookaheadAnimationVisualDebugging

Allows enabling and customizing shared element and animated bounds animation debugging.

LookaheadScope

LookaheadScope creates a scope in which all layouts will first determine their destination layout through a lookahead pass, followed by an approach pass to run the measurement and placement approach defined in approachLayout or ApproachLayoutModifierNode, in order to gradually reach the destination.

MaterialExpressiveTheme

Material Expressive Theming refers to the customization of your Material Design app to better reflect your product’s brand.

MaterialTheme

Material Theming

MaterialTheme

Material Theming refers to the customization of your Material Design app to better reflect your product’s brand.

MaterialTheme

Material Theming refers to the customization of your Material Design app to better reflect your product’s brand.

MaterialTheme

MaterialTheme defines the styling principles from the WearOS Material design specification which extends the Material design specification.

MaterialTheme

MaterialTheme defines the styling principles from the Wear Material3 design specification which extends the Material design specification.

MediaRouteButton

A Material3 IconButton that displays a media route button.

MediumExtendedFloatingActionButton

Material Design medium extended floating action button

MediumFlexibleTopAppBar

Material Design medium flexible top app bar

MediumFloatingActionButton

Material Design medium floating action button

MediumTopAppBar

Material Design medium top app bar

ModalBottomSheet

Material Design modal bottom sheet

ModalBottomSheetLayout

Material Design modal bottom sheet

ModalBottomSheetLayout

Create a ModalBottomSheetLayout displaying content from a BottomSheetNavigator.

ModalDrawer

Material Design modal navigation drawer

ModalDrawerSheet

Content inside of a modal navigation drawer.

ModalNavigationDrawer

Material Design navigation drawer

ModalNavigationDrawer

Navigation drawers provide ergonomic access to destinations in an app.

ModalWideNavigationRail

Material design modal wide navigation rail.

MotionCarousel

Implements an horizontal Carousel of n elements, driven by drag gestures and customizable through a provided MotionScene.

MotionLayout

Layout that can animate between multiple ConstraintSets as defined by Transitions in the given MotionScene.

MotionScene

Parses the given JSON5 into a MotionScene.

MultiAspectCarouselScope

Creates a multi-apsect carousel scope that includes all related methods for creating a multi-aspect carousel.

MultiChoiceSegmentedButtonRow

Material Design segmented button

MultiMeasureLayout
MuteButton

A state container for a button that mutes and unmutes to the media.

MuteButton

A Material3 IconButton that mutes or unmutes the player.

NavDisplay

A nav display that renders and animates between different Scenes, each of which can render one or more NavEntrys.

NavHost

Provides a place in the Compose hierarchy for self contained navigation to occur.

NavigableListDetailPaneScaffold

A version of ListDetailPaneScaffold that supports navigation and predictive back handling out of the box, controlled by ThreePaneScaffoldNavigator.

NavigableSupportingPaneScaffold

A version of SupportingPaneScaffold that supports navigation and predictive back handling out of the box, controlled by ThreePaneScaffoldNavigator.

NavigationBackHandler

A composable that handles only back navigation gestures, driven by a manually hoisted NavigationEventState.

NavigationBar

Material Design bottom navigation bar

NavigationBar

Material Design bottom navigation bar.

NavigationBarItem

Material Design navigation bar item.

NavigationDrawer

Navigation drawers provide ergonomic access to destinations in an app.

NavigationDrawerItem

Material Design navigation drawer item.

NavigationDrawerItem

TV Material Design navigation drawer item.

NavigationEventHandler

A composable that handles navigation events using simple lambda handlers, driven by a manually hoisted NavigationEventState.

NavigationForwardHandler

A composable that handles only forward navigation gestures, driven by a manually hoisted NavigationEventState.

NavigationRail

Material Design navigation rail

NavigationRail

Material Design bottom navigation rail

NavigationRail

Material Design bottom navigation rail.

NavigationRailItem

Material Design navigation rail

NavigationRailItem

Material Design navigation rail item.

NavigationSuite

The default Material navigation component according to the current NavigationSuiteType to be used with the NavigationSuiteScaffold.

NavigationSuiteItem

The default Material navigation item component according to the current NavigationSuiteType to be used with the NavigationSuite that accepts this function.

NavigationSuiteScaffold

The Navigation Suite Scaffold wraps the provided content and places the adequate provided navigation component on the screen according to the current NavigationSuiteType.

NavigationSuiteScaffold

XR-specific Navigation Suite Scaffold that wraps its content in a SpatialPanel.

NavigationSuiteScaffoldLayout

Layout for a NavigationSuiteScaffold's content.

NextButton

A state container for a button that seeks to the next media item.

NextButton

A Material3 IconButton that seeks to the next media item.

OpenOnPhoneDialog

A full-screen dialog that displays an animated icon with a curved text at the bottom.

OpenOnPhoneDialogContent

This composable provides the content for an OpenOnPhoneDialog that displays an animated icon with curved text at the bottom.

Orbiter

A composable that creates an orbiter along the top or bottom edges of a view.

OutlineButton

An outline button styled per Material3.

OutlinedButton

Material Design outlined button

OutlinedButton

Material Design outlined button

OutlinedButton

Material Design outlined button for TV.

OutlinedButton

Wear Material OutlinedButton that offers a single slot to take any content (text, icon or image).

OutlinedButton

Base level Wear Material3 OutlinedButton that offers a single slot to take any content.

OutlinedCard

Material Design outlined card

OutlinedCard

Outlined Wear Material 3 Card that offers a single slot to take any content.

OutlinedChip

Wear Material OutlinedChip that offers three slots and a specific layout for an icon, label and secondaryLabel.

OutlinedCompactButton

Wear Material OutlinedCompactButton that offers a single slot to take any content (text, icon or image).

OutlinedCompactChip

A compact Outlined Wear Material Chip that offers two slots and a specific layout for an icon and label.

OutlinedIconButton

Material Design outlined icon button

OutlinedIconButton

Material Design standard icon button for TV.

OutlinedIconButton

Wear Material OutlinedIconButton is a circular, icon-only button with a transparent background, contrasting icon color and border.

OutlinedIconToggleButton

Material Design outlined icon toggle button

OutlinedSecureTextField

Material Design outlined text field for secure content

OutlinedSecureTextField

Material Design outlined text field for secure content

OutlinedTextField

Material Design outlined text field.

OutlinedTextField

Material Design outlined text field

OutlinedToggleButton

TODO link to mio page when available.

Path

Defines a path inside a VectorPainter.

PdfViewer

A Composable that presents PDF content, provided as PdfDocument

PermanentDrawerSheet

Content inside of a permanent navigation drawer.

PermanentNavigationDrawer

Material Design navigation permanent drawer

Picker

A scrollable list of items to pick from.

Picker

A scrollable list of items to pick from.

PickerGroup

A group of Pickers to build components where multiple pickers are required to be combined together.

PickerGroup

A group of Pickers to build components where multiple pickers are required to be combined together.

PlainTooltip

Plain tooltip that provides a descriptive message.

PlanarEmbeddedSubspace

Creates a 3D space for spatial content that is embedded within and positioned by a 2D container.

PlatformTextInputMethodTestOverride

Installs a custom PlatformTextInputSession implementation to run when PlatformTextInputSession.startInputMethod is called by text editors inside content.

PlayPauseButton

A state container for a button that plays or pauses the media item.

PlayPauseButton

A Material3 IconButton that plays or pauses the current media item.

PlaybackSpeedControl

A state container for building custom UI for playback speed control.

PlaybackSpeedToggleButton

A Material3 TextButton that toggles the playback speed of the player.

Player

A composable that provides a basic player UI layout, combining a ContentFrame for displaying player content with customizable controls and a shutter.

PlayerSurface

Provides a dedicated drawing android.view.Surface for media playbacks using a Player.

Popup

Opens a popup with the given content.

PositionAndDurationText

A composable that displays the duration of the media.

PositionIndicator

Creates an PositionIndicator based on the values in a ScalingLazyListState object that a ScalingLazyColumn uses.

PositionText

A composable that displays the current position of the player.

PredictiveBackHandler

An effect for handling predictive system back gestures.

PreviousButton

A state container for a button that seeks to the previous media item.

PreviousButton

A Material3 IconButton that seeks to the previous media item.

PrimaryScrollableTabRow

Material Design scrollable primary tabs

PrimaryTabRow

Material Design fixed primary tabs

ProgressIndicator

A state container for a progress indicator that provides progress updates from a Player.

ProgressSlider

A Material3 Slider that displays the current position of the player.

ProvideTextStyle

This function is used to set the current value of LocalTextStyle, merging the given style with the current style values for any missing attributes.

ProvideTextStyle

This function is used to set the current value of LocalTextStyle, merging the given style with the current style values for any missing attributes.

ProvideTextStyle

This function is used to set the current value of LocalTextStyle, merging the given style with the current style values for any missing attributes.

ProvideTextStyle

This function is used to set the current value of LocalTextStyle, merging the given style with the current style values for any missing attributes.

ProvideTextStyle

This function is used to set the current value of LocalTextStyle, merging the given style with the current style values for any missing attributes.

PullRefreshIndicator

The default indicator for Compose pull-to-refresh, based on Android's SwipeRefreshLayout.

PullToRefreshBox

PullToRefreshBox is a container that expects a scrollable layout as content and adds gesture support for manually refreshing when the user swipes downward at the beginning of the content.

RadioButton

Material Design radio button

RadioButton

Material Design radio button

RadioButton

Adds a radio button to the glance view.

RadioButton

Material Design radio button.

RadioButton

RadioButton provides an animated radio button for use as a toggle control in ToggleChip or SplitToggleChip.

RadioButton

The Wear Material RadioButton offers slots and a specific layout for an icon, a label and a secondaryLabel.

RangeSlider

Material Design slider

RangeSlider

Material Design range slider

RemainingDurationText

A composable that displays the duration of the media.

RemoteBox

A version of RemoteBox with no content, often used as a spacer or a background placeholder.

RemoteButton

Base level Wear Material3 RemoteButton that offers a single slot to take any content.

RemoteButtonGroup

Layout component to implement an expressive group of buttons in a row.

RemoteCanvas

A Composable that provides a RemoteDrawScope for drawing operations in RemoteCompose.

RemoteColumn

A layout composable that positions its children in a vertical sequence.

RemoteCompactButton

A Wear Material3 RemoteCompactButton that offers two slots and a specific layout for an icon and label.

RemoteIcon

Composable function that displays an icon using an RemoteImageVector.

RemoteIconButton

Wear Material RemoteIconButton is a circular, icon-only button with transparent background and no border.

RemoteImage

A composable that lays out and draws a given RemoteBitmap.

RemoteRow

A layout composable that positions its children in a horizontal sequence.

RemoteSpacer

A spacer that takes up space as defined by the provided modifier.

RemoteText

Remote composable that displays text.

RemoteText

High level element that displays text and provides semantics / accessibility information.

RemoteTextButton

Wear Material RemoteTextButton is a circular, text-only button with transparent background and no border.

RenderVectorGroup

Recursively creates the vector graphic composition by traversing the tree structure.

RepeatButton

A state container for a button that cycles through repeat modes.

RepeatButton

A Material3 IconButton that toggles the repeat mode of the player.

ReportDrawn

Calls Activity.reportFullyDrawn after this composition is completed.

ReportDrawnAfter

Adds block to the methods that must complete prior to Activity.reportFullyDrawn being called.

ReportDrawnWhen

Adds predicate to the conditions that must be met prior to Activity.reportFullyDrawn being called.

RetainedEffect
ReusableComposeNode

Emits a recyclable node into the composition of type T.

ReusableContent

A utility function to mark a composition as supporting recycling.

ReusableContentHost

An optional utility function used when hosting ReusableContent.

RichTooltip

Rich text tooltip that allows the user to pass in a title, text, and action.

Row

A layout composable that places its children in a horizontal sequence.

Row

A layout composable with content, which lays its children out in a Row.

SandboxedSdkUi

Composable that can be used to remotely render UI from a SandboxedSdk to host app window.

SandboxedSdkUiBelowHostWindow

Composable that can be used to remotely render UI from a SandboxedSdk to host app window.

Scaffold

Material Design layout

Scaffold

Material Design layout

Scaffold

A simple slot api component for displaying widget UI with a TitleBar.

Scaffold

Scaffold implements the basic Wear Material Design visual layout structure.

ScalingLazyColumn

A scrolling scaling/fisheye list component that forms a key part of the Wear Material Design language.

ScalingLazyColumn

A scrolling scaling/fisheye list component that forms a key part of the Wear Material Design language.

SceneCoreEntity

A composable that attaches to a SceneCore entity and allow compose to size, position, reparent, add children, and apply modifiers to the entity.

ScreenScaffold

ScreenScaffold is one of the Wear Material3 scaffold components.

Scrim

A Scrim that obscures content behind a modal surface.

ScrollIndicator

A composable that displays a visual indicator of scrolling progress within a scrollable container.

ScrollableTabRow

Material Design scrollable tabs

ScrollableTabRow

Material Design tabs

SearchBar

Material Design search

SecondaryScrollableTabRow

Material Design scrollable secondary tabs

SecondaryTabRow

Material Design fixed secondary tabs

SecureTextField

Material Design filled text field for secure content

SecureTextField

Material Design filled text field for secure content

SeekBackButton

A state container for a button that seeks back in the current media item by Player.getSeekBackIncrement.

SeekBackButton

A Material3 IconButton that seeks back in the current media item.

SeekForwardButton

A state container for a button that seeks back in the current media item by Player.getSeekForwardIncrement.

SeekForwardButton

A Material3 IconButton that seeks forward in the current media item.

SegmentedButton

Material Design segmented Button

SegmentedCircularProgressIndicator

Material Design segmented circular progress indicator.

SegmentedListItem

Material Design segmented list item

SelectableChip

A SelectableChip is a specialized type of Chip that includes a slot for a bi-state selection control such as a radio button.

SelectionContainer

Enables text selection for its direct or indirect children.

SharedTransitionLayout

SharedTransitionLayout creates a layout and a SharedTransitionScope for the child layouts in content.

SharedTransitionScope

SharedTransitionScope creates a SharedTransitionScope for the child layouts in content.

ShortNavigationBar

Material Design short navigation bar.

ShortNavigationBar

XR-specific Material Design short navigation bar.

ShortNavigationBarItem

Material Design short navigation bar item.

ShuffleButton

A state container for a button that toggles shuffle mode on and off.

ShuffleButton

A Material3 IconButton that toggles the shuffle mode of the player.

SideEffect

Schedule effect to run when the current composition completes successfully and applies changes.

SingleChoiceSegmentedButtonRow

Material Design segmented button

Slider

Material Design slider

Slider

Material Design slider

Slider

Slider allows users to make a selection from a range of values.

SmallExtendedFloatingActionButton

Material Design small extended floating action button

SmallFloatingActionButton

Material Design small floating action button

Snackbar

Material Design snackbar

Snackbar

Material Design snackbar

SnackbarHost

Host for Snackbars to be used in Scaffold to properly show, hide and dismiss items based on material specification and the hostState.

SnackbarHost

Host for Snackbars to be used in Scaffold to properly show, hide and dismiss items based on Material specification and the hostState.

SpaceToggleButton

A composable button that toggles between "Full Space" and "Home Space" in an Android XR application.

Spacer

Component that represents an empty space layout, whose size can be defined using Modifier.width, Modifier.height and Modifier.size modifiers.

Spacer

Component that represents an empty space layout, whose size can be defined using GlanceModifier.width, GlanceModifier.height, GlanceModifier.size modifiers.

SpatialActivityPanel

Creates a SpatialActivityPanel and launches an Activity within it.

SpatialAndroidViewPanel

Creates a SpatialAndroidViewPanel representing a 2D plane in 3D space where an Android View will be hosted.

SpatialBox

A layout composable that sizes itself to fit its content, subject to incoming constraints.

SpatialColumn

A layout composable that arranges its children in a vertical sequence.

SpatialCurvedRow

A layout composable that arranges its children in a curved horizontal sequence.

SpatialDialog

SpatialDialog is a dialog that is elevated above the activity.

SpatialElevation

Composable that creates a panel in 3D space when spatialization is enabled.

SpatialExternalSurface

A Composable that creates and owns an Android Surface into which the application can render stereo image content.

SpatialExternalSurface180Hemisphere

A Composable that creates and owns an Android Surface into which the application can render stereo image content inside a 180 degree hemisphere dome.

SpatialExternalSurface360Sphere

A Composable that creates and owns an Android Surface into which the application can render stereo image content inside a 360 degree sphere dome.

SpatialLayoutSpacer

A composable that represents an empty space layout.

SpatialMainPanel

A composable that renders the Activity's main window's 2D UI content, defined in androidx.activity.compose.setContent, as a panel in a Subspace.

SpatialPanel

Creates a SpatialPanel representing a 2D plane in 3D space in which an application can fill content.

SpatialPopup

A composable that creates a panel in 3D space to hoist Popup based composables.

SpatialRow

A layout composable that arranges its children in a horizontal sequence.

SpatialSpacer

A composable that represents an empty space layout.

SplitButtonLayout

A SplitButtonLayout let user define a button group consisting of 2 buttons.

SplitCheckboxButton

The Wear Material SplitCheckboxButton offers slots and a specific layout for a label and secondaryLabel.

SplitRadioButton

The Wear Material SplitRadioButton offers two slots and a specific layout for a label and secondaryLabel.

SplitSelectableChip

A SplitSelectableChip is a specialized type of Chip that includes a slot for a selection control, such as a radio button.

SplitSwitchButton

The Wear Material SplitSwitchButton offers slots and a specific layout for a label and secondary label.

SplitToggleChip

A SplitToggleChip is a specialized type of Chip that includes a slot for a toggle control, such as a toggle or checkbox.

SquareIconButton

Intended to fill the role of primary icon button or fab.

StandardCardContainer

StandardCardContainer is an opinionated TV Material Card layout with an image and text content to show information about a subject.

Stepper

Stepper allows users to make a selection from a range of values.

Stepper

Stepper allows users to make a selection from a range of values.

StepperLevelIndicator

Creates a StepperLevelIndicator for screens that that control a setting, such as volume, with a Stepper.

SubcomposeLayout

Analogue of Layout which allows to subcompose the actual content during the measuring stage for example to use the values calculated during the measurement as params for the composition of the children.

Subspace

Create a 3D area that the app can render spatial content into.

SubspaceLayout

SubspaceLayout is the main component for laying out leaf nodes with zero children.

SuccessConfirmationDialog

Shows a SuccessConfirmationDialog dialog with a success icon and optional short curved text.

SuccessConfirmationDialogContent

SuccessConfirmationDialogContent provides the content for a success confirmation dialog with a success icon and optional short curved text.

SuggestionChip

Material Design suggestion chip

SuggestionChip

Material Design suggestion chip

SupportingPaneScaffold

A three pane layout that follows the Material guidelines, displaying the provided panes in a canonical supporting pane layout.

Surface

Material Design surface

Surface

Material surface is the central metaphor in material design.

Surface

The Surface is a building block component that will be used for any element on TV such as buttons, cards, navigation, or a simple background etc.

SwipeDismissableNavHost

Provides a place in the Compose hierarchy for self-contained navigation to occur, with backwards navigation provided by a swipe gesture.

SwipeToDismiss

A composable that can be dismissed by swiping left or right.

SwipeToDismissBox

A composable that can be dismissed by swiping left or right.

SwipeToDismissBox

Wear Material SwipeToDismissBox that handles the swipe-to-dismiss gesture.

SwipeToDismissBox

Wear Material 3 SwipeToDismissBox that handles the swipe-to-dismiss gesture.

SwipeToReveal

A composable that can be used to add extra actions to a composable (up to two) which will be revealed when the original composable is swiped to the left.

SwipeToReveal

SwipeToReveal Material composable.

SwipeToRevealCard

SwipeToReveal Material composable for Cards.

SwipeToRevealChip

SwipeToReveal Material composable for Chips.

SwipeToRevealPrimaryAction

A composable which can be used for setting the primary action of material SwipeToRevealCard and SwipeToRevealChip.

SwipeToRevealSecondaryAction

A composable which can be used for setting the secondary action of material SwipeToRevealCard and SwipeToRevealChip.

SwipeToRevealUndoAction

A composable which can be used for setting the undo action of material SwipeToRevealCard and SwipeToRevealChip.

Switch

Material Design switch

Switch

Material Design switch

Switch

Adds a switch view to the glance view.

Switch

Material Design Switch.

Switch

Switch provides an animated switch for use as a toggle control in ToggleChip or SplitToggleChip.

SwitchButton

The Wear Material SwitchButton offers three slots and a specific layout for an icon, a label, and a secondaryLabel.

Tab

Material Design tab

Tab

Material Design tab

Tab

Material Design tab.

TabRow

Material Design fixed tabs

TabRow

Material Design tabs

TabRow

TV-Material Design Horizontal TabRow

Text

High level element that displays text and provides semantics / accessibility information.

Text

High level element that displays text and provides semantics / accessibility information.

Text

Adds a text view to the glance view.

Text

High level element that displays text and provides semantics / accessibility information.

Text

High level element that displays text and provides semantics / accessibility information.

Text

High level element that displays text and provides semantics / accessibility information.

Text

High level element that displays text and provides semantics / accessibility information.

TextButton

Material Design text button

TextButton

Material Design text button

TextButton

Wear Material TextButton is a circular, text-only button with transparent background and no border.

TextField

Material Design filled text field.

TextField

Material Design filled text field

TextToggleButton

Wear Material TextToggleButton is a filled text toggle button which switches between primary colors and tonal colors depending on checked value, and offers a single slot for text.

ThreePaneScaffold

A pane scaffold composable that can display up to three panes in the order that ThreePaneScaffoldHorizontalOrder specifies, and allocate margins and spacers according to PaneScaffoldDirective.

ThreePaneScaffoldPredictiveBackHandler

An effect to add predictive back handling to a three pane scaffold.

TimeInput

Time pickers help users select and set a specific time.

TimePicker

Material Design time picker

TimePicker

A full screen TimePicker with configurable columns that allows users to select a time.

TimePickerDialog

Material Design time picker dialog

TimeText

A Composable that provides player progress information to a content lambda, allowing for the creation of custom progress indicators.

TimeText

Progress indicator that represents the Player's progress state in textual form.

TimeText

Layout to show the current time and a label at the top of the screen.

TimeText

Layout to show the current time and a label, they will be drawn in a curve, following the top edge of the screen.

TitleBar

A Title Bar.

TitleCard

Opinionated Wear Material Card that offers a specific 3 slot layout to show interactive information about an application, e.g. a message.

TitleCard

Opinionated Wear Material 3 Card that offers a specific layout to show interactive information about an application, e.g. a message.

TitleChip

Title Chip is a component used to provide context for associated content, such as a Card.

ToggleButton

TODO link to mio page when available.

ToggleButton

Wear Material ToggleButton that offers a single slot to take any content (text, icon or image).

ToggleChip

A ToggleChip is a specialized type of Chip that includes a slot for a bi-state toggle control such as a toggle or checkbox.

ToggleFloatingActionButton

Toggleable FAB supports animating its container size, corner radius, and color when it is toggled, and should be used in conjunction with a FloatingActionButtonMenu to provide additional choices to the user after clicking the FAB.

TonalToggleButton

TODO link to mio page when available.

TooltipBox

Material TooltipBox that wraps a composable with a tooltip.

TopAppBar

Material Design top app bar

TopAppBar

Material Design small top app bar

TopSearchBar

Material Design search

TransformingLazyColumn

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

TriStateCheckbox

Material Design checkbox

TriStateCheckbox

Material Design checkbox

TriStateCheckbox

Material Design checkbox parent.

TwoRowsTopAppBar

A basic two-rows Material Design top app bar.

VerticalDivider

Material Design divider

VerticalDragHandle

Material Design drag handle

VerticalFloatingToolbar

A vertical floating toolbar displays navigation and key actions in a Column.

VerticalFloatingToolbar

XR-specific Vertical Floating Toolbar that displays content in a Column in an end-aligned VerticalOrbiter.

VerticalList

This is a scrolling list component that only composes and lays out the currently visible items.

VerticalPageIndicator

Vertical page indicator for use with VerticalPager, representing the currently active page and the approximate number of pages.

VerticalPager

A Pager that scrolls vertically.

VerticalPager

A vertically scrolling Pager optimized for Wear OS devices.

VerticalPagerScaffold

VerticalPagerScaffold is one of the Wear Material3 scaffold components.

VerticalSlider

Material Design slider

VerticalStack

VerticalStack is a lazy, vertically scrollable layout that arranges its items in a visually overlapping, three-dimensional sequence, which resembles a deck of cards.

Viewfinder

Displays a media stream with the given transformations for crop and rotation while maintaining proper scaling.

Vignette

Vignette is whole screen decoration used to blur the top and bottom of the edges of a wearable screen when scrolling content is displayed.

WideButton

Material Design wide button for TV.

WideCardContainer

WideCardContainer is an opinionated TV Material Card layout with an image and text content to show information about a subject.

WideClassicCard

WideClassicCard is an opinionated TV Material card that offers a 4 slot layout to show information about a subject.

WideNavigationRail

Material design wide navigation rail.

WideNavigationRail

XR-specific Material design wide navigation rail.

WideNavigationRailItem

Material Design wide navigation rail item.

action

Create an Action that runs block when triggered.

animateColor

Creates a Color animation that runs infinitely as a part of the given InfiniteTransition.

animateColorAsState

Fire-and-forget animation function for Color.

animateDp

Creates a Dp animation as a part of the given Transition.

animateDpAsState

Fire-and-forget animation function for Dp.

animateFloat

Creates an animation of Float type that runs infinitely as a part of the given InfiniteTransition.

animateFloatAsState

Fire-and-forget animation function for Float.

animateInt

Creates a Int animation as a part of the given Transition.

animateIntAsState

Fire-and-forget animation function for Int.

animateIntOffset

Creates a IntOffset animation as a part of the given Transition.

animateIntOffsetAsState

Fire-and-forget animation function for IntOffset.

animateIntSize

Creates a IntSize animation as a part of the given Transition.

animateIntSizeAsState

Fire-and-forget animation function for IntSize.

animateOffset

Creates an Offset animation as a part of the given Transition.

animateOffsetAsState

Fire-and-forget animation function for Offset.

animateRect

Creates a Rect animation as a part of the given Transition.

animateRectAsState

Fire-and-forget animation function for Rect.

animateSize

Creates a Size animation as a part of the given Transition.

animateSizeAsState

Fire-and-forget animation function for Size.

animateValue

Creates an animation of type T that runs infinitely as a part of the given InfiniteTransition.

animateValueAsState

Fire-and-forget animation function for any value.

animatedVectorResource

Load an AnimatedImageVector from an Android resource id.

asPaddingValues

Convert a WindowInsets to a PaddingValues and uses LocalDensity for DP to pixel conversion.

booleanResource

Load a boolean resource.

calculateWindowSizeClass

Calculates the window's WindowSizeClass for the provided activity.

clickable

Run block in response to a user click.

clip
collectAsLazyPagingItems

Collects values from this Flow of PagingData and represents them inside a LazyPagingItems instance.

collectAsState

Collects values from this Flow and represents its latest value via State.

collectAsStateWithLifecycle

Collects values from this Flow and represents its latest value via State in a lifecycle-aware manner.

collectFoldingFeaturesAsState

Collects the current window folding features from WindowInfoTracker in to a State.

collectIsDraggedAsState

Subscribes to this MutableInteractionSource and returns a State representing whether this component is dragged or not.

collectIsFocusedAsState

Subscribes to this MutableInteractionSource and returns a State representing whether this component is focused or not.

collectIsHoveredAsState

Subscribes to this MutableInteractionSource and returns a State representing whether this component is hovered or not.

collectIsPressedAsState

Subscribes to this MutableInteractionSource and returns a State representing whether this component is pressed or not.

colorResource

Load a color resource.

contentColorFor

The Material color system contains pairs of colors that are typically used for the background and content color inside a component.

contentColorFor

The Material color system contains pairs of colors that are typically used for the background and content color inside a component.

contentColorFor

The Material color system contains pairs of colors that are typically used for the background and content color inside a component.

contentColorFor

The Material color system contains pairs of colors that are typically used for the background and content color inside a component.

contentColorFor

The Material color system contains pairs of colors that are typically used for the background and content color inside a component.

createChildTransition

createChildTransition creates a child Transition based on the mapping between parent state to child state provided in transformToChildState.

currentBackStackEntryAsState

Gets the current navigation back stack entry as a MutableState.

currentBackStackEntryAsState

Gets the current navigation back stack entry as a State.

currentState

Retrieves the current customizable store for view specific state data as defined by GlanceStateDefinition in the surface implementation.

currentStateAsState

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State.

currentWindowAdaptiveInfo

Calculates and returns WindowAdaptiveInfo of the provided context.

currentWindowAdaptiveInfoV2

Calculates and returns WindowAdaptiveInfo of the provided context.

currentWindowDpSize

Returns and automatically update the current window size in DpSize.

currentWindowSize

Returns and automatically update the current window size.

defaultDecayAnimationSpec

Create default DecayAnimationSpec representing a default fling curve for a platform.

defaultDragHandleSemantics

This function sets up the default semantics of pane expansion drag handles with the given PaneExpansionState.

derivedMediaQuery

Evaluates a boolean query against the current UiMediaScope, wrapped in a derivedStateOf.

dimensionResource

Load a dimension resource.

dropUnlessResumed

Returns a new decorated function that will invoke the given block if the lifecycleOwner's lifecycle state is at least State.RESUMED.

dropUnlessStarted

Returns a new decorated function that will invoke the given block if the lifecycleOwner's lifecycle state is at least State.STARTED.

fontResource

Synchronously load an font from FontFamily.

hiltViewModel

Returns an existing HiltViewModel -annotated ViewModel or creates a new one scoped to the current ViewModelStoreOwner.

hiltViewModel

Returns an existing HiltViewModel -annotated ViewModel or creates a new one scoped to the current navigation graph present on the {@link NavController} back stack.

imageResource

Load an ImageBitmap from an image resource.

integerArrayResource

Load an array of integer resource.

integerResource

Load an integer resource.

isSystemInDarkTheme

Returns whether the operating system is in dark theme.

key

key is a utility composable that is used to "group" or "key" a block of execution inside of a composition.

mediaQuery

Evaluates a boolean query against the current UiMediaScope.

observeAsState

Starts observing this LiveData and represents its values via State.

painterResource

Create a Painter from an Android resource id.

pendingIntentAction

Create a PendingIntentAction to send the PendingIntent when invoked.

placeholder

Draws a placeholder shape over the top of a composable and animates a wipe off effect to remove the placeholder.

placeholder

Modifier.placeholder draws a skeleton shape over a component, for situations when no provisional content (such as cached data) is available.

placeholderShimmer

Modifier to draw a placeholder shimmer over a component.

placeholderShimmer

Modifier.placeholderShimmer draws a periodic shimmer over content, indicating to the user that contents are loading or potentially out of date.

pluralStringResource

Load a plurals resource.

produceState

Return an observable snapshot State that produces values over time without a defined data source.

remember

Remember the value produced by calculation.

rememberActiveFocusRequester
rememberAmbientModeManager

Creates, remembers, and manages the lifecycle of the default AmbientModeManager implementation.

rememberAnimatedTextFontRegistry

Generates an AnimatedTextFontRegistry to use within composition.

rememberAnimatedVectorPainter

Creates and remembers a Painter to render an AnimatedImageVector.

rememberAuthenticationLauncher

Returns an AuthenticationResultLauncher that can be used to initiate authentication.

rememberBackdropScaffoldState

Create and remember a BackdropScaffoldState.

rememberBasicTooltipState

Create and remember the default BasicTooltipState.

rememberBottomAppBarState

Creates a BottomAppBarState that is remembered across compositions.

rememberBottomDrawerState

Create and remember a BottomDrawerState.

rememberBottomSheetNavigator

Create and remember a BottomSheetNavigator.

rememberBottomSheetScaffoldState

Create and remember a BottomSheetScaffoldState.

rememberBottomSheetScaffoldState

Create and remember a BottomSheetScaffoldState.

rememberBottomSheetState

Create a BottomSheetState and remember it.

rememberCarouselState

Creates a CarouselState that is remembered across compositions.

rememberCarouselState

Creates a CarouselState that is remembered across compositions.

rememberComposableLambda
rememberComposableLambdaN
rememberCompositionContext

An Effect to construct a CompositionContext at the current point of composition.

rememberContainedSearchBarState

Create and remember a SearchBarState to use in conjunction with ExpandedFullScreenContainedSearchBar.

rememberCoroutineScope

Return a CoroutineScope bound to this point in the composition using the optional CoroutineContext provided by getContext.

rememberDatePickerState
rememberDateRangePickerState
rememberDecoratedNavEntries

Decorates the entries with the entryDecorators and returns the list of decorated NavEntries.

rememberDismissState

Create and remember a DismissState.

rememberDragToResizeState

Creates and remembers a DragToResizeState instance.

rememberDraggable2DState

Create and remember default implementation of Draggable2DState interface that allows to pass a simple action that will be invoked when the drag occurs.

rememberDraggableState

Create and remember default implementation of DraggableState interface that allows to pass a simple action that will be invoked when the drag occurs.

rememberDrawerState

Create and remember a DrawerState.

rememberDrawerState

Create and remember a DrawerState.

rememberDrawerState

Create and remember a DrawerState.

rememberEmbeddedPhotoPickerState

Generates a EmbeddedPhotoPickerState object and remembers it.

rememberExpandableState

Create and remember an ExpandableState

rememberExpandableStateMapping

Create and remember a mapping from keys to ExpandableStates ExpandableStates can be requested by key, and we will created with the parameters given here when a mapping didn't exist before.

rememberFloatingToolbarState

Creates a FloatingToolbarState that is remembered across compositions.

rememberFragmentState

Creates a FragmentState used to store the state of a Fragment that is created via AndroidFragment.

rememberGraphicsLayer

Create a new GraphicsLayer instance that will automatically be released when the Composable is disposed.

rememberInfiniteTransition

Creates a InfiniteTransition that runs infinite child animations.

rememberLauncherForActivityResult

Register a request to start an activity for result, designated by the given ActivityResultContract.

rememberLazyGridState

Creates a LazyGridState that is remembered across compositions.

rememberLazyListState

Creates a LazyListState that is remembered across compositions.

rememberLazyStaggeredGridState

Creates a LazyStaggeredGridState that is remembered across composition.

rememberLifecycleOwner

Remembers a new LifecycleOwner with a lifecycle that is a child of the parent composition's lifecycle.

rememberListDetailPaneScaffoldNavigator

Returns a remembered default implementation of ThreePaneScaffoldNavigator for ListDetailPaneScaffold, which will be updated automatically when the input values change.

rememberListDetailSceneStrategy

Creates and remembers a ListDetailSceneStrategy.

rememberListState

Creates a ListState that is remembered across compositions.

rememberModalBottomSheetState

Create a ModalBottomSheetState and remember it.

rememberModalBottomSheetState

Create and remember a SheetState for ModalBottomSheet.

rememberMutableRemoteBoolean

Factory composable for mutable remote boolean state.

rememberMutableRemoteFloat

Remembers a remote float expression based on RemoteFloatContext.

rememberMutableRemoteInt

Factory composable for mutable remote integer state.

rememberMutableRemoteString

Factory composable for mutable remote string state.

rememberMuteButtonState

Remembers the value of MuteButtonState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberNamedRemoteBitmap

Remembers a named remote bitmap expression.

rememberNamedRemoteBoolean

Remembers a named remote boolean expression.

rememberNamedRemoteColor

Remembers a named remote color expression.

rememberNamedRemoteDp

Remembers a named remote Dp expression.

rememberNamedRemoteFloat

Remembers a named remote float expression.

rememberNamedRemoteInt

Remembers a named remote integer expression.

rememberNamedRemoteLong

Remembers a named remote long expression.

rememberNamedRemoteString

Remembers a named remote string expression.

rememberNavBackStack
rememberNavController

Creates a NavHostController that handles the adding of the ComposeNavigator and DialogNavigator.

rememberNavigationEventDispatcherOwner

Remembers a new NavigationEventDispatcherOwner which creates a dispatcher linked to a parent dispatcher found in the composition.

rememberNavigationEventState

Remembers and returns a NavigationEventState instance.

rememberNavigationSuiteScaffoldState

Create and remember a NavigationSuiteScaffoldState

rememberNestedScrollInteropConnection

Create and remember the NestedScrollConnection that enables Nested Scroll Interop between a View parent that implements androidx.core.view.NestedScrollingParent3 and a Compose child.

rememberNextButtonState

Remembers the value of NextButtonState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberOverscrollEffect

Returns a remembered OverscrollEffect created from the current value of LocalOverscrollFactory.

rememberPagerState

Creates and remember a PagerState to be used with a Pager

rememberPagerState

Creates and remember a PagerState to be used with a Wear Pager

rememberPaneExpansionState

Remembers and returns a PaneExpansionState associated to a given PaneExpansionStateKey.

rememberPickerGroupState

Creates a PickerGroupState that is remembered across compositions.

rememberPickerState

Creates a PickerState that is remembered across compositions.

rememberPickerState

Creates a PickerState that is remembered across compositions.

rememberPlaceholderState

Creates a PlaceholderState that is remembered across compositions.

rememberPlaceholderState

Creates a PlaceholderState that is remembered across compositions.

rememberPlatformOverscrollFactory

Creates and remembers an instance of the platform OverscrollFactory, with the provided glowColor and glowDrawPadding values - these values will be used on platform versions where glow overscroll is used.

rememberPlayPauseButtonState

Remembers the value of PlayPauseButtonState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberPlaybackSpeedState

Remember the value of PlaybackSpeedState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberPresentationState

Remembers the value of PresentationState created based on the passed Player and launches a coroutine to listen to Player's changes.

rememberPreviousButtonState

Remembers the value of PreviousButtonState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberProgressStateWithTickCount

Remember the value of ProgressStateWithTickCount created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberProgressStateWithTickInterval

Remember the value of ProgressStateWithTickInterval created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberPullRefreshState

Creates a PullRefreshState that is remembered across compositions.

rememberPullToRefreshState

Create and remember the default PullToRefreshState.

rememberRangeSliderState

Creates a SliderState that is remembered across compositions.

rememberRepeatButtonState

Remember the value of RepeatButtonState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberRevealState

Create and remember a RevealState.

rememberRevealState

Create and remember a RevealState.

rememberRevealState

Create and remember a RevealState.

rememberRipple

Creates and remembers a Ripple using values provided by RippleTheme.

rememberSaveable

Remember the value produced by init.

rememberSaveableStateHolder

Creates and remembers the instance of SaveableStateHolder.

rememberSaveableStateHolderNavEntryDecorator

Returns a SaveableStateHolderNavEntryDecorator that is remembered across recompositions.

rememberScaffoldState

Creates a ScaffoldState with the default animation clock and memoizes it.

rememberScalingLazyListState

Creates a ScalingLazyListState that is remembered across compositions.

rememberScalingLazyListState

Creates a ScalingLazyListState that is remembered across compositions.

rememberSceneState

Returns a SceneState that is remembered across compositions based on the parameters.

rememberScrollState

Create and remember the ScrollState based on the currently appropriate scroll configuration to allow changing scroll position or observing scroll behavior.

rememberScrollable2DState

Create and remember the default implementation of Scrollable2DState interface that contains necessary information about the ongoing fling and provides smooth scrolling capabilities.

rememberScrollableState

Create and remember the default implementation of ScrollableState interface that contains necessary information about the ongoing fling and provides smooth scrolling capabilities.

rememberSearchBarState

Create and remember a SearchBarState.

rememberSeekBackButtonState

Remembers the value of SeekBackButtonState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberSeekForwardButtonState

Remembers the value of SeekForwardButtonState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberSerializable

Remember the value produced by init, and persist it across activity or process recreation using a KSerializer for saving and restoring via the saved instance state mechanism.

rememberShuffleButtonState

Remember the value of ShuffleButtonState created based on the passed Player and launch a coroutine to listen to Player's changes.

rememberSliderState

Creates a SliderState that is remembered across compositions.

rememberSnapFlingBehavior

Creates and remember a FlingBehavior that performs snapping.

rememberSplineBasedDecay
rememberStackState

Creates and remembers a StackState for a VerticalStack.

rememberStandardBottomSheetState

Create and remember a SheetState for BottomSheetScaffold.

rememberSupportingPaneScaffoldNavigator

Returns a remembered default implementation of ThreePaneScaffoldNavigator for SupportingPaneScaffold, which will be updated automatically when the input values change.

rememberSupportingPaneSceneStrategy

Creates and remembers a SupportingPaneSceneStrategy.

rememberSwipeDismissableNavController

Creates a NavHostController that handles the adding of the WearNavigator from androidx.wear.compose.navigation.

rememberSwipeDismissableNavHostState

Create a SwipeToDismissBoxState and remember it.

rememberSwipeDismissableSceneStrategy

Creates and remembers a SwipeDismissableSceneStrategy.

rememberSwipeToDismissBoxState

Create and remember a SwipeToDismissBoxState.

rememberSwipeToDismissBoxState

Create a SwipeToDismissBoxState and remember it.

rememberSwipeToDismissBoxState

Create a SwipeToDismissBoxState and remember it.

rememberSwipeableState

Create and remember a SwipeableState with the default animation clock.

rememberSwipeableState

Create and remember a SwipeableState with the default animation clock.

rememberTextFieldState

Create and remember a TextFieldState.

rememberTextMeasurer

Creates and remembers a TextMeasurer.

rememberTimePickerState

Creates a TimePickerState for a time picker that is remembered across compositions and configuration changes.

rememberTooltipState

Create and remember the default TooltipState for TooltipBox.

rememberTopAppBarState

Creates a TopAppBarState that is remembered across compositions.

rememberTransformableState

Create and remember default implementation of TransformableState interface that contains necessary information about the ongoing transformations and provides smooth transformation capabilities.

rememberTransformationSpec

Computes and remembers the appropriate TransformationSpec for the current screen size.

rememberTransformingLazyColumnState

Creates a TransformingLazyColumnState that is remembered across compositions.

rememberTransition

Creates a Transition and puts it in the currentState of the provided transitionState.

rememberUpdatedState

remember a mutableStateOf and update its value to newValue on each recomposition of the rememberUpdatedState call.

rememberUpdatedStyleState

Create, remember and update a StyleState for use as a parameter of a androidx.compose.ui.Modifier.styleable modifier.

rememberVectorPainter

Create a VectorPainter with the given ImageVector.

rememberViewModelStoreNavEntryDecorator

Returns a ViewModelStoreNavEntryDecorator that is remembered across recompositions.

rememberViewModelStoreOwner

Remembers a ViewModelStoreOwner scoped to the current composable using an existing provider.

rememberViewModelStoreProvider

Remembers a new ViewModelStoreProvider which creates a ViewModel scope linked to a parent found in the composition.

rememberWideNavigationRailState

Create and remember a WideNavigationRailState.

rememberWithGapSearchBarState

Create and remember a SearchBarState to use in conjunction with ExpandedDockedSearchBarWithGap.

resizeWithContentScale

Attempts to size the original content rectangle to be inscribed into a destination by applying a specified ContentScale type.

retain

Remember the value produced by calculation and retain it in the LocalRetainedValuesStore.

retainManagedRetainedValuesStore

Retains a ManagedRetainedValuesStore.

retainRetainedValuesStoreRegistry

Returns a retained instance of a new RetainedValuesStoreRegistry.

stringArrayResource

Load a string resource.

stringResource

Load a string resource.

subscribeAsState

Subscribes to this Completable and represents its completed state via State.

subscribeAsState

Subscribes to this Completable and represents its completed state via State.

surface

A surface is a fundamental building block in Glimmer.

toPath

Returns a Path that is remembered across compositions for this RoundedPolygon.

toShape

Returns a Shape that is remembered across compositions for this RoundedPolygon.

updateTransition

This sets up a Transition, and updates it with the target provided by targetState.

vectorResource

Load an ImageVector from a vector resource.

viewModel

Returns an existing ViewModel or creates a new one in the scope (usually, a fragment or an activity)

withCompositionLocal

withCompositionLocal binds value to ProvidableCompositionLocal key and returns the result produced by the content lambda.

withCompositionLocals

withCompositionLocals binds values to ProvidableCompositionLocal key and returns the result produced by the content lambda.