{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

androidx.compose.material3

Annotations

ExperimentalMaterial3Api

Interfaces

BasicTooltipState

The state that is associated with an instance of a tooltip.

BottomAppBarScrollBehavior

A BottomAppBarScrollBehavior defines how a bottom app bar should behave when the content under it is scrolled.

BottomAppBarState

A state object that can be hoisted to control and observe the bottom app bar state.

CaretScope

Caret scope for TooltipBox to be used to obtain the LayoutCoordinates of the anchor content, and to draw a caret for the tooltip.

DatePickerFormatter

A date formatter interface used by DatePicker.

DatePickerState

A state object that can be hoisted to observe the date picker state.

DateRangePickerState

A state object that can be hoisted to observe the date range picker state.

MultiChoiceSegmentedButtonRowScope

Scope for the children of a MultiChoiceSegmentedButtonRow

NavigationDrawerItemColors

Represents the colors of the various elements of a drawer item.

SelectableDates

An interface that controls the selectable dates and years in the date pickers UI.

SingleChoiceSegmentedButtonRowScope

Scope for the children of a SingleChoiceSegmentedButtonRow

SnackbarData

Interface to represent the data of one particular Snackbar as a piece of the SnackbarHostState.

SnackbarVisuals

Interface to represent the visuals of one particular Snackbar as a piece of the SnackbarData.

TabIndicatorScope

Scope for the composable used to render a Tab indicator, this can be used for more complex indicators requiring layout information about the tabs like TabRowDefaults.PrimaryIndicator and TabRowDefaults.SecondaryIndicator

TooltipState

The state that is associated with a TooltipBox.

TopAppBarScrollBehavior

A TopAppBarScrollBehavior defines how an app bar should behave when the content under it is scrolled.

Classes

AndroidAlertDialogKt
AndroidMenuKt
AppBarKt
BadgeKt
BottomSheetScaffoldKt
BottomSheetScaffoldState

State of the BottomSheetScaffold composable.

ButtonColors

Represents the container and content colors used in a button in different states.

ButtonElevation

Represents the elevation for a button in different states.

ButtonKt
CalendarLocale

Represents a Locale for the calendar.

CalendarModelKt
CardColors

Represents the container and content colors used in a card in different states.

CardElevation

Represents the elevation for a card in different states.

CardKt
CaretProperties

Properties for the caret of the tooltip if enabled.

CheckboxColors

Represents the colors used by the three different sections (checkmark, box, and border) of a Checkbox or TriStateCheckbox in different states.

CheckboxKt
ChipBorder

This class is deprecated. Maintained for binary compatibility.

ChipColors

Represents the container and content colors used in a clickable chip in different states.

ChipElevation

Represents the elevation used in a selectable chip in different states.

ChipKt
ColorScheme

A color scheme holds all the named color parameters for a MaterialTheme.

ColorSchemeKt
ContentColorKt
DatePickerColors

Represents the colors used by the date picker.

DatePickerDialogKt
DatePickerKt
DateRangePickerKt
DisplayMode

Represents the different modes that a date picker can be at.

DividerKt
DrawerState

State of the ModalNavigationDrawer and DismissibleNavigationDrawer composable.

DynamicTonalPaletteKt
ExposedDropdownMenuBoxScope

Scope for ExposedDropdownMenuBox.

ExposedDropdownMenuKt
FabPosition

The possible positions for a FloatingActionButton attached to a Scaffold.

FloatingActionButtonElevation

Represents the tonal and shadow elevation for a floating action button in different states.

FloatingActionButtonKt
IconButtonColors

Represents the container and content colors used in an icon button in different states.

IconButtonKt
IconKt
IconToggleButtonColors

Represents the container and content colors used in a toggleable icon button in different states.

InteractiveComponentSizeKt
LabelKt
ListItemColors

Represents the container and content colors used in a list item in different states.

ListItemKt
MaterialThemeKt
MenuItemColors

Represents the text and icon colors used in a menu item at different states.

ModalBottomSheetKt
ModalBottomSheetProperties

Properties used to customize the behavior of a ModalBottomSheet.

NavigationBarItemColors

Represents the colors of the various elements of a navigation item.

NavigationBarKt
NavigationDrawerKt
NavigationRailItemColors

Represents the colors of the various elements of a navigation item.

NavigationRailKt
OutlinedTextFieldKt
ProgressIndicatorKt
RadioButtonColors

Represents the color used by a RadioButton in different states.

RadioButtonKt
RangeSliderState

Class that holds information about RangeSlider's active range.

RichTooltipColors
ScaffoldKt
SearchBarColors

Represents the colors used by a search bar in different states.

SearchBarKt
SegmentedButtonColors

The different colors used in parts of the SegmentedButton in different states

SegmentedButtonKt
SelectableChipColors

Represents the container and content colors used in a selectable chip in different states.

SelectableChipElevation

Represents the elevation used in a selectable chip in different states.

Shapes

Material surfaces can be displayed in different shapes.

SheetState

State of a sheet composable, such as ModalBottomSheet

SliderColors

Represents the color used by a Slider in different states.

SliderKt
SliderPositions

This class is deprecated. Not necessary with the introduction of Slider state

SliderState

Class that holds information about Slider's active range.

SnackbarHostKt
SnackbarHostState

State of the SnackbarHost, which controls the queue and the current Snackbar being shown inside the SnackbarHost.

SnackbarKt
SurfaceKt
SwipeToDismissBoxKt
SwipeToDismissBoxState

State of the SwipeToDismissBox composable.

SwitchColors

Represents the colors used by a Switch in different states

SwitchKt
TabKt
TabPosition

Data class that contains information about a tab's position on screen, used for calculating where to place the indicator that shows which tab is selected.

TabRowKt
TextFieldColors

Represents the colors of the input text, container, and content (including label, placeholder, leading and trailing icons) used in a text field in different states.

TextFieldKt
TextKt
TimePickerColors

Represents the colors used by a TimePicker in different states

TimePickerKt
TimePickerLayoutType

Represents the different configurations for the layout of the Time Picker

TimePickerState

A class to handle state changes in a TimePicker

TooltipKt
TopAppBarColors

Represents the colors used by a top app bar in different states.

TopAppBarState

A state object that can be hoisted to control and observe the top app bar state.

Typography

The Material Design type scale includes a range of contrasting styles that support the needs of your product and its content.

AlertDialogDefaults

Contains default values used for AlertDialog and BasicAlertDialog.

AssistChipDefaults

Contains the baseline values used by AssistChip.

BadgeDefaults

Default values used for Badge implementations.

BottomAppBarDefaults

Contains default values used for the bottom app bar implementations.

BottomAppBarState.Companion
BottomSheetDefaults

Contains the default values used by ModalBottomSheet and BottomSheetScaffold.

ButtonDefaults

Contains the default values used by all 5 button types.

CardDefaults

Contains the default values used by all card types.

CheckboxDefaults

Defaults used in Checkbox and TriStateCheckbox.

DatePickerDefaults

Contains default values used by the DatePicker.

DateRangePickerDefaults

Contains default values used by the DateRangePicker.

DisplayMode.Companion
DividerDefaults

Default values for Divider

DrawerDefaults

Object to hold default values for ModalNavigationDrawer

DrawerState.Companion
ExposedDropdownMenuDefaults

Contains default values used by Exposed Dropdown Menu.

FabPosition.Companion
FilterChipDefaults

Contains the baseline values used by FilterChip.

FloatingActionButtonDefaults

Contains the default values used by FloatingActionButton

IconButtonDefaults

Contains the default values used by all icon button types.

InputChipDefaults

Contains the baseline values used by an InputChip.

ListItemDefaults

Contains the default values used by list items.

MaterialTheme

Contains functions to access the current theme values provided at the call site's position in the hierarchy.

MenuDefaults

Contains default values used for DropdownMenuItem.

ModalBottomSheetDefaults

Default values for ModalBottomSheet

NavigationBarDefaults

Defaults used in NavigationBar.

NavigationBarItemDefaults

Defaults used in NavigationBarItem.

NavigationDrawerItemDefaults

Defaults used in NavigationDrawerItem.

NavigationRailDefaults

Defaults used in NavigationRail

NavigationRailItemDefaults

Defaults used in NavigationRailItem.

OutlinedTextFieldDefaults

Contains the default values used by OutlinedTextField.

ProgressIndicatorDefaults

Contains the default values used for LinearProgressIndicator and CircularProgressIndicator.

RadioButtonDefaults

Defaults used in RadioButton.

ScaffoldDefaults

Object containing various default values for Scaffold component.

SearchBarDefaults

Defaults used in SearchBar and DockedSearchBar.

SegmentedButtonDefaults
ShapeDefaults

Contains the default values used by Shapes

SheetState.Companion
SliderDefaults

Object to hold defaults used by Slider

SnackbarDefaults

Contains the default values used for Snackbar.

SuggestionChipDefaults

Contains the baseline values used by SuggestionChip.

SwipeToDismissBoxDefaults

Contains default values for SwipeToDismissBox and SwipeToDismissBoxState.

SwipeToDismissBoxState.Companion
SwitchDefaults

Contains the default values used by Switch

TabRowDefaults

Contains default implementations and values used for TabRow.

TextFieldDefaults

Contains the default values used by TextField.

TimePickerDefaults

Contains the default values used by TimePicker

TimePickerLayoutType.Companion
TimePickerState.Companion
TooltipDefaults

Tooltip defaults that contain default values for both PlainTooltip and RichTooltip

TopAppBarDefaults

Contains default values used for the top app bar implementations.

TopAppBarState.Companion

Enums

DismissDirection

This enum is deprecated. Dismiss direction is no longer used by SwipeToDismissBoxState.

DismissValue

This enum is deprecated. DismissValue is no longer used by SwipeToDismissBoxState.

DrawerValue

Possible values of DrawerState.

SheetValue

Possible values of SheetState.

SnackbarDuration

Possible durations of the Snackbar in SnackbarHost

SnackbarResult

Possible results of the SnackbarHostState.showSnackbar call

SwipeToDismissBoxValue

The directions in which a SwipeToDismissBox can be dismissed.