# androidx.compose.material.icons

Common/All

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](https://fonts.google.com/icons) to get the latest Material Symbols.

For more information: https://developer.android.com/develop/ui/compose/graphics/images/material

![Icons image](https://developer.android.com/images/reference/androidx/compose/material/icons/iconography.png)

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](https://material.io/design/iconography/system-icons.html) symbolize common actions, files, devices, and directories.

|---|---|---|---|
|   | **APIs** | **Description** | **Preview** |
| **Icons** | `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons` | Icons |   |
| **Default** | `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons#Default()` | Default icons | ![Default icon image](https://developer.android.com/images/reference/androidx/compose/material/icons/icon-filled.svg) |
| **Filled** | `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Filled` | Filled icons | ![Filled icon image](https://developer.android.com/images/reference/androidx/compose/material/icons/icon-filled.svg) |
| **Outlined** | `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Outlined` | Outlined icons | ![Outlined icon image](https://developer.android.com/images/reference/androidx/compose/material/icons/icon-outlined.svg) |
| **Rounded** | `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Rounded` | Rounded icons | ![Rounded icon image](https://developer.android.com/images/reference/androidx/compose/material/icons/icon-rounded.svg) |
| **Two tone** | `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.TwoTone` | Two tone icons | ![Two tone icon image](https://developer.android.com/images/reference/androidx/compose/material/icons/icon-two-tone.svg) |
| **Sharp** | `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Sharp` | Sharp icons | ![Sharp icon image](https://developer.android.com/images/reference/androidx/compose/material/icons/icon-sharp.svg) |

**Note:** `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons#Default()` is an alias for `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Filled`.

### Related components

|---|---|---|
|   | **APIs** | **Description** |
| **Icon** | `https://developer.android.com/reference/kotlin/androidx/compose/material/Icon.composable#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)` | Icon |
|   | `https://developer.android.com/reference/kotlin/androidx/compose/material3/Icon.composable#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)` | M3 icon |
| **Icon button** | `https://developer.android.com/reference/kotlin/androidx/compose/material/IconButton.composable#IconButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0)` | Icon button |
|   | `https://developer.android.com/reference/kotlin/androidx/compose/material3/IconButton.composable#IconButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.IconButtonColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.ui.graphics.Shape,kotlin.Function0)` | M3 icon button |
| **Icon toggle button** | `https://developer.android.com/reference/kotlin/androidx/compose/material/IconToggleButton.composable#IconToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0)` | Icon toggle button |
|   | `https://developer.android.com/reference/kotlin/androidx/compose/material3/IconToggleButton.composable#IconToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.IconToggleButtonColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.ui.graphics.Shape,kotlin.Function0)` | M3 icon toggle button |

## Objects

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons` | [Material Design system icons](https://material.io/design/iconography/system-icons.html) as seen on [Google Fonts](https://fonts.google.com/icons). | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.AutoMirrored` | [Material Design system icons](https://material.io/design/iconography/system-icons.html) as seen on [Google Fonts](https://fonts.google.com/icons). | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.AutoMirrored.Filled` | [Filled icons](https://material.io/resources/icons/?style=baseline)are the default icon theme. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.AutoMirrored.Outlined` | [Outlined icons](https://material.io/resources/icons/?style=outline) make use of a thin stroke and empty space inside for a lighter appearance. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.AutoMirrored.Rounded` | [Rounded icons](https://material.io/resources/icons/?style=round) use a corner radius that pairs well with brands that use heavier typography, curved logos, or circular elements to express their style. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.AutoMirrored.Sharp` | [Sharp icons](https://material.io/resources/icons/?style=sharp) display corners with straight edges, for a crisp style that remains legible even at smaller scales. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.AutoMirrored.TwoTone` | [Two-Tone icons](https://material.io/resources/icons/?style=twotone) display corners with straight edges, for a crisp style that remains legible even at smaller scales. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Filled` | [Filled icons](https://material.io/resources/icons/?style=baseline) (previously the only available theme, also known as the baseline theme) are the default icon theme. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Outlined` | [Outlined icons](https://material.io/resources/icons/?style=outline) make use of a thin stroke and empty space inside for a lighter appearance. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Rounded` | [Rounded icons](https://material.io/resources/icons/?style=round) use a corner radius that pairs well with brands that use heavier typography, curved logos, or circular elements to express their style. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.Sharp` | [Sharp icons](https://material.io/resources/icons/?style=sharp) display corners with straight edges, for a crisp style that remains legible even at smaller scales. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/Icons.TwoTone` | [Two-Tone icons](https://material.io/resources/icons/?style=twotone) display corners with straight edges, for a crisp style that remains legible even at smaller scales. | Cmn |

## Top-level functions summary

|---|---|---|
| `inline https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector` | `https://developer.android.com/reference/kotlin/androidx/compose/material/icons/package-summary#materialIcon(kotlin.String,kotlin.Boolean,kotlin.Function1)( name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, autoMirror: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, block: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Builder.() -> https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Builder )` Utility delegate to construct a Material icon with default size information. | Cmn |

## Extension functions summary

|---|---|---|
| `inline https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Builder` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Builder.https://developer.android.com/reference/kotlin/androidx/compose/material/icons/package-summary#(androidx.compose.ui.graphics.vector.ImageVector.Builder).materialPath(kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.PathFillType,kotlin.Function1)( fillAlpha: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, strokeAlpha: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, pathFillType: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathFillType, pathBuilder: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/PathBuilder.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` Adds a vector path to this icon with Material defaults. | Cmn |

## Top-level functions

### materialIcon

Cmn Artifact: [androidx.compose.material:material-icons-core](https://developer.android.com/jetpack/androidx/releases/compose-material) [View Source](https://cs.android.com/search?q=file:androidx/compose/material/icons/Icons.kt+function:materialIcon) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/compose-material#1.6.0)

```
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: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the full name of the generated icon |
| `autoMirror: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | determines if the vector asset should automatically be mirrored for right to left locales |
| `block: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Builder.() -> https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/ImageVector.Builder` | builder lambda to add paths to this vector asset |

## Extension functions

### ImageVector.Builder.materialPath

Cmn Artifact: [androidx.compose.material:material-icons-core](https://developer.android.com/jetpack/androidx/releases/compose-material) [View Source](https://cs.android.com/search?q=file:androidx/compose/material/icons/Icons.kt+function: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: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = 1.0f` | fill alpha for this path |
| `strokeAlpha: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = 1.0f` | stroke alpha for this path |
| `pathFillType: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathFillType = DefaultFillType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathFillType` for this path |
| `pathBuilder: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/PathBuilder.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | builder lambda to add commands to this path |