androidx.compose.material.icons
This library is no longer recommended for displaying Material Icons in Compose. Material Symbols are the new way forward, and we have stopped publishing updates to this library. It has been removed from the latest Material 3 library release, but you can still manually reference it if you cannot migrate yet. Instead, we recommend downloading Vector Drawable XML files from the "Android" tab on Google Fonts to get the latest Material Symbols.
For more information: https://developer.android.com/develop/ui/compose/graphics/images/material
In this page, you'll find documentation for types, properties, and functions available in the androidx.compose.material.icons package.
The most commonly used set of Material icons are provided by androidx.compose.material:material-icons-core.
A separate library, androidx.compose.material:material-icons-extended, contains the full set of Material icons. Due to the very large size of this library, make sure to use R8/Proguard to strip unused icons if you are including this library as a direct dependency. Alternatively you can make a local copy (by copy and pasting) the icon(s) you wish to keep, or using Android Studio's 'Import vector asset' feature.
Overview
System icons
System icons symbolize common actions, files, devices, and directories.
| APIs | Description | Preview | |
| Icons | Icons |
Icons | |
| Default | Icons.Default |
Default icons |  |
| Filled | Icons.Filled |
Filled icons | |
| Outlined | Icons.Outlined |
Outlined icons |  |
| Rounded | Icons.Rounded |
Rounded icons |  |
| Two tone | Icons.TwoTone |
Two tone icons |  |
| Sharp | Icons.Sharp |
Sharp icons |  |
Note: Icons.Default is an alias for Icons.Filled.
Related components
| APIs | Description | |
| Icon | androidx.compose.material.Icon |
Icon |
androidx.compose.material3.Icon |
M3 icon | |
| Icon button | androidx.compose.material.IconButton |
Icon button |
androidx.compose.material3.IconButton |
M3 icon button | |
| Icon toggle button | androidx.compose.material.IconToggleButton |
Icon toggle button |
androidx.compose.material3.IconToggleButton |
M3 icon toggle button |
Objects
Icons |
Material Design system icons as seen on Google Fonts. |
Cmn
|
Icons.AutoMirrored |
Material Design system icons as seen on Google Fonts. |
Cmn
|
Icons.AutoMirrored.Filled |
Filled iconsare the default icon theme. |
Cmn
|
Icons.AutoMirrored.Outlined |
Outlined icons make use of a thin stroke and empty space inside for a lighter appearance. |
Cmn
|
Icons.AutoMirrored.Rounded |
Rounded icons use a corner radius that pairs well with brands that use heavier typography, curved logos, or circular elements to express their style. |
Cmn
|
Icons.AutoMirrored.Sharp |
Sharp icons display corners with straight edges, for a crisp style that remains legible even at smaller scales. |
Cmn
|
Icons.AutoMirrored.TwoTone |
Two-Tone icons display corners with straight edges, for a crisp style that remains legible even at smaller scales. |
Cmn
|
Icons.Filled |
Filled icons (previously the only available theme, also known as the baseline theme) are the default icon theme. |
Cmn
|
Icons.Outlined |
Outlined icons make use of a thin stroke and empty space inside for a lighter appearance. |
Cmn
|
Icons.Rounded |
Rounded icons use a corner radius that pairs well with brands that use heavier typography, curved logos, or circular elements to express their style. |
Cmn
|
Icons.Sharp |
Sharp icons display corners with straight edges, for a crisp style that remains legible even at smaller scales. |
Cmn
|
Icons.TwoTone |
Two-Tone icons display corners with straight edges, for a crisp style that remains legible even at smaller scales. |
Cmn
|
Top-level functions summary
inline ImageVector |
materialIcon(Utility delegate to construct a Material icon with default size information. |
Cmn
|
Extension functions summary
inline ImageVector.Builder |
ImageVector.Builder.materialPath(Adds a vector path to this icon with Material defaults. |
Cmn
|
Top-level functions
materialIcon
inline fun materialIcon(
name: String,
autoMirror: Boolean = false,
block: ImageVector.Builder.() -> ImageVector.Builder
): ImageVector
Utility delegate to construct a Material icon with default size information. This is used by generated icons, and should not be used manually.
| Parameters | |
|---|---|
name: String |
the full name of the generated icon |
autoMirror: Boolean = false |
determines if the vector asset should automatically be mirrored for right to left locales |
block: ImageVector.Builder.() -> ImageVector.Builder |
builder lambda to add paths to this vector asset |
Extension functions
ImageVector.Builder.materialPath
inline fun ImageVector.Builder.materialPath(
fillAlpha: Float = 1.0f,
strokeAlpha: Float = 1.0f,
pathFillType: PathFillType = DefaultFillType,
pathBuilder: PathBuilder.() -> Unit
): ImageVector.Builder
Adds a vector path to this icon with Material defaults.
| Parameters | |
|---|---|
fillAlpha: Float = 1.0f |
fill alpha for this path |
strokeAlpha: Float = 1.0f |
stroke alpha for this path |
pathFillType: PathFillType = DefaultFillType |
|
pathBuilder: PathBuilder.() -> Unit |
builder lambda to add commands to this path |