Package-level declarations
Types
Contains default values used for AlertDialog and BasicAlertDialog.
Contains the baseline values used by AssistChip.
Default values used for Badge implementations.
Contains default values used for the bottom app bar implementations.
A BottomAppBarScrollBehavior defines how a bottom app bar should behave when the content under it is scrolled.
A state object that can be hoisted to control and observe the bottom app bar state. The state is read and updated by a BottomAppBarScrollBehavior implementation.
Contains the default values used by ModalBottomSheet and BottomSheetScaffold.
State of the BottomSheetScaffold composable.
Represents the container and content colors used in a button in different states.
Contains the default values used by all 5 button types.
Represents the elevation for a button in different states.
Represents a Locale for the calendar. This locale will be used when formatting dates, determining the input format, and more.
Represents the container and content colors used in a card in different states.
Contains the default values used by all card types.
Represents the elevation for a card in different states.
Represents the colors used by the three different sections (checkmark, box, and border) of a Checkbox or TriStateCheckbox in different states.
Defaults used in Checkbox and TriStateCheckbox.
Represents the border stroke used in a chip in different states.
Represents the container and content colors used in a clickable chip in different states.
Represents the elevation used in a selectable chip in different states.
A color scheme holds all the named color parameters for a MaterialTheme.
Represents the colors used by the date picker.
Contains default values used by the DatePicker.
A date formatter interface used by DatePicker.
A state object that can be hoisted to observe the date picker state. See rememberDatePickerState.
Contains default values used by the DateRangePicker.
A state object that can be hoisted to observe the date range picker state. See rememberDateRangePickerState.
Represents the different modes that a date picker can be at.
Default values for Divider
Object to hold default values for ModalNavigationDrawer
State of the ModalNavigationDrawer and DismissibleNavigationDrawer composable.
Possible values of DrawerState.
Scope for ExposedDropdownMenuBox.
Contains default values used by Exposed Dropdown Menu.
The possible positions for a FloatingActionButton attached to a Scaffold.
Contains the baseline values used by FilterChip.
Contains the default values used by FloatingActionButton
Represents the tonal and shadow elevation for a floating action button in different states.
Represents the container and content colors used in an icon button in different states.
Contains the default values used by all icon button types.
Represents the container and content colors used in a toggleable icon button in different states.
Contains the baseline values used by an InputChip.
Represents the container and content colors used in a list item in different states.
Contains the default values used by list items.
Contains functions to access the current theme values provided at the call site's position in the hierarchy.
The type of element that can serve as a dropdown menu anchor.
Contains default values used for DropdownMenu and DropdownMenuItem.
Represents the text and icon colors used in a menu item at different states.
Default values for ModalBottomSheet
Properties used to customize the behavior of a ModalBottomSheet.
Scope for the children of a MultiChoiceSegmentedButtonRow
Defaults used in NavigationBar.
Represents the colors of the various elements of a navigation item.
Defaults used in NavigationBarItem.
Represents the colors of the various elements of a drawer item.
Defaults used in NavigationDrawerItem.
Defaults used in NavigationRail
Represents the colors of the various elements of a navigation item.
Defaults used in NavigationRailItem.
Contains the default values used by OutlinedTextField. For defaults used in TextField, see TextFieldDefaults.
Contains the default values used for LinearProgressIndicator and CircularProgressIndicator.
Represents the color used by a RadioButton in different states.
Defaults used in RadioButton.
Class that holds information about RangeSlider's active range.
Configuration for ripple appearance, provided using LocalRippleConfiguration. In most cases the default values should be used, for custom design system use cases you should instead build your own custom ripple using createRippleModifierNode. To disable the ripple, provide null
using LocalRippleConfiguration.
Default values used by ripple.
Object containing various default values for Scaffold component.
Represents the colors used by a search bar in different states.
Defaults used in SearchBar and DockedSearchBar.
The different colors used in parts of the SegmentedButton in different states
Represents the container and content colors used in a selectable chip in different states.
Represents the elevation used in a selectable chip in different states.
An interface that controls the selectable dates and years in the date pickers UI.
Contains the default values used by Shapes
Material surfaces can be displayed in different shapes. Shapes direct attention, identify components, communicate state, and express brand.
State of a sheet composable, such as ModalBottomSheet
Possible values of SheetState.
Scope for the children of a SingleChoiceSegmentedButtonRow
Represents the color used by a Slider in different states.
Object to hold defaults used by Slider
Class that holds information about Slider's and RangeSlider's active track and fractional positions where the discrete ticks should be drawn on the track.
Class that holds information about Slider's active range.
Interface to represent the data of one particular Snackbar as a piece of the SnackbarHostState.
Contains the default values used for Snackbar.
Possible durations of the Snackbar in SnackbarHost
State of the SnackbarHost, which controls the queue and the current Snackbar being shown inside the SnackbarHost.
Possible results of the SnackbarHostState.showSnackbar call
Interface to represent the visuals of one particular Snackbar as a piece of the SnackbarData.
Contains the baseline values used by SuggestionChip.
Contains default values for SwipeToDismissBox and SwipeToDismissBoxState.
State of the SwipeToDismissBox composable.
The directions in which a SwipeToDismissBox can be dismissed.
Represents the colors used by a Switch in different states
Contains the default values used by Switch
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
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.
Contains default implementations and values used for TabRow.
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.
Contains the default values used by TextField. For defaults used in OutlinedTextField, see OutlinedTextFieldDefaults.
Represents the colors used by a TimePicker in different states
Contains the default values used by TimePicker
Represents the different configurations for the layout of the Time Picker
The selection mode for the time picker
A state object that can be hoisted to observe the time picker state. It holds the current values and allows for directly setting those values.
Tooltip defaults that contain default values for both PlainTooltip and RichTooltip
Tooltip scope for TooltipBox to be used to obtain the LayoutCoordinates of the anchor content, and to draw a caret for the tooltip.
The state that is associated with a TooltipBox. Each instance of TooltipBox should have its own TooltipState.
Represents the colors used by a top app bar in different states. This implementation animates the container color according to the top app bar scroll state. It does not animate the leading, headline, or trailing colors.
Contains default values used for the top app bar implementations.
A TopAppBarScrollBehavior defines how an app bar should behave when the content under it is scrolled.
A state object that can be hoisted to control and observe the top app bar state. The state is read and updated by a TopAppBarScrollBehavior implementation.
The Material Design type scale includes a range of contrasting styles that support the needs of your product and its content.
Properties
CompositionLocal containing the preferred content color for a given position in the hierarchy. This typically represents the on
color for a color in ColorScheme. For example, if the background color is ColorScheme.surface, this color is typically set to ColorScheme.onSurface.
CompositionLocal that configures whether Material components that have a visual size that is lower than the minimum touch target size for accessibility (such as Button) will include extra space outside the component to ensure that they are accessible. If set to false there will be no extra space, and so it is possible that if the component is placed near the edge of a layout / near to another component without any padding, there will not be enough space for an accessible touch target.
CompositionLocal that configures the minimum touch target size for Material components (such as Button) to ensure they are accessible. If a component has a visual size that is lower than the minimum touch target size, extra space outside the component will be included. If set to Dp.Unspecified there will be no extra space, and so it is possible that if the component is placed near the edge of a layout / near to another component without any padding, there will not be enough space for an accessible touch target.
CompositionLocal used for providing RippleConfiguration down the tree. This acts as a tree-local 'override' for ripples used inside components that you cannot directly control, such as to change the color of a specific component's ripple, or disable it entirely by providing null
.
CompositionLocal containing the preferred TextStyle that will be used by Text components by default. To set the value for this CompositionLocal, see ProvideTextStyle which will merge any missing TextStyle properties with the existing TextStyle set in this CompositionLocal.
Composition Local used to check if ColorScheme.applyTonalElevation will be applied down the tree.
Temporary CompositionLocal to allow configuring whether the old ripple implementation that uses the deprecated androidx.compose.material.ripple.RippleTheme API should be used in Material components and LocalIndication, instead of the new ripple API. This flag defaults to false, and will be removed after one stable release: it should only be used to temporarily unblock upgrading.
Functions
A badge represents dynamic information such as a number of pending requests in a navigation bar.
Creates a BottomAppBarState.
The Material color system contains pairs of colors that are typically used for the background and content color inside a component. For example, a Button typically uses primary
for its background, and onPrimary
for the color of its content (usually text or iconography).
The Material color system contains pairs of colors that are typically used for the background and content color inside a component. For example, a Button typically uses primary
for its background, and onPrimary
for the color of its content (usually text or iconography).
Returns a dark Material color scheme.
Creates a DatePickerState.
Creates a DateRangePickerState.
Content inside of a dismissible navigation drawer.
A Material Design icon component that draws bitmap using tint, with a default value of LocalContentColor. If bitmap has no intrinsic size, this component will use the recommended default size. Icon is an opinionated component designed to be used with single-color icons so that they can be tinted correctly for the component they are placed in. For multicolored icons and icons that should not be tinted, use Color.Unspecified for tint. For generic images that should not be tinted, and do not follow the recommended icon size, use the generic androidx.compose.foundation.Image instead. For a clickable icon, see IconButton.
A Material Design icon component that draws painter using tint. If painter has no intrinsic size, this component will use the recommended default size. Icon is an opinionated component designed to be used with single-color icons so that they can be tinted correctly for the component they are placed in. For multicolored icons and icons that should not be tinted, use null for tint. For generic images that should not be tinted, and do not follow the recommended icon size, use the generic androidx.compose.foundation.Image instead. For a clickable icon, see IconButton.
A Material Design icon component that draws painter using tint, with a default value of LocalContentColor. If painter has no intrinsic size, this component will use the recommended default size. Icon is an opinionated component designed to be used with single-color icons so that they can be tinted correctly for the component they are placed in. For multicolored icons and icons that should not be tinted, use Color.Unspecified for tint. For generic images that should not be tinted, and do not follow the recommended icon size, use the generic androidx.compose.foundation.Image instead. For a clickable icon, see IconButton.
A Material Design icon component that draws imageVector using tint, with a default value of LocalContentColor. If imageVector has no intrinsic size, this component will use the recommended default size. Icon is an opinionated component designed to be used with single-color icons so that they can be tinted correctly for the component they are placed in. For multicolored icons and icons that should not be tinted, use Color.Unspecified for tint. For generic images that should not be tinted, and do not follow the recommended icon size, use the generic androidx.compose.foundation.Image instead. For a clickable icon, see IconButton.
Label component that will append a label to content. The positioning logic uses TooltipDefaults.rememberPlainTooltipPositionProvider.
Returns a light Material color scheme.
Material Theming refers to the customization of your Material Design app to better reflect your product’s brand.
Reserves at least 48.dp in size to disambiguate touch interactions if the element would measure smaller.
Content inside of a modal navigation drawer.
Material Design navigation bar item.
Material Design navigation drawer item.
Material Design navigation rail item.
Content inside of a permanent navigation drawer.
Plain tooltip that provides a descriptive message.
This function is used to set the current value of LocalTextStyle, merging the given style with the current style values for any missing attributes. Any Text components included in this component's content will be styled with this style unless styled explicitly.
Creates a BottomAppBarState that is remembered across compositions.
Create and remember a BottomSheetScaffoldState.
Creates a DatePickerState for a DatePicker that is remembered across compositions.
Creates a DateRangePickerState for a DateRangePicker that is remembered across compositions.
Create and remember a DrawerState.
Create and remember a SheetState for ModalBottomSheet.
Create and remember a SheetState for BottomSheetScaffold.
Create and remember a SwipeToDismissBoxState.
Creates a TimePickerState for a time picker that is remembered across compositions and configuration changes.
Create and remember the default TooltipState for TooltipBox.
Creates a TopAppBarState that is remembered across compositions.
Rich text tooltip that allows the user to pass in a title, text, and action. Tooltips are used to provide a descriptive message.
Creates a Ripple using the provided values and values inferred from the theme.
Material Segmented Button. Segmented buttons help people select options, switch views, or sort elements.
Material surface is the central metaphor in material design. Each surface exists at a given elevation, which influences how that piece of surface visually relates to other surfaces and how that surface is modified by tonal variance.
Computes the surface tonal color at different elevation levels e.g. surface1 through surface5.
A composable that can be dismissed by swiping left or right.
High level element that displays text and provides semantics / accessibility information.
Time pickers help users select and set a specific time.
Factory function for the default implementation of TimePickerState should be used in most cases.
Material TooltipBox that wraps a composable with a tooltip.
Constructor extension function for TooltipState
Material Design checkbox parent.