Google Git
Sign in
android / platform / tools / dokka-devsite-plugin / e6de108ba72d3236f5f0dcb57edb365f9b9d37a4 / . / testData / compose / docs / reference / androidx / compose / material / IconKt.html
blob: 85366c7bd03118b9f859f9e69e635c9b0ad3f836 [file] [log] [blame]
<html devsite="true">
<head>
<title>IconKt</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>IconKt</h1>
<p>
<pre>public final class <a href="/reference/androidx/compose/material/IconKt.html">IconKt</a></pre>
</p>
<hr>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>static&nbsp;final void</code></td>
<td>
<div><code>@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br><a href="/reference/androidx/compose/material/IconKt.html#Icon(androidx.compose.ui.graphics.ImageBitmap,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/ImageBitmap.html">ImageBitmap</a>&nbsp;bitmap,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint<br>)</code></div>
<p>Icon component that draws <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.ImageBitmap,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">bitmap</a></code> using <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.ImageBitmap,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">tint</a></code>, defaulting to <code><a href="/reference/androidx/compose/material/package-summary.html#LocalContentColor()">LocalContentColor</a></code>.</p>
</td>
</tr>
<tr>
<td><code>static&nbsp;final void</code></td>
<td>
<div><code>@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br><a href="/reference/androidx/compose/material/IconKt.html#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/vector/ImageVector.html">ImageVector</a>&nbsp;imageVector,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint<br>)</code></div>
<p>Icon component that draws <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">imageVector</a></code> using <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">tint</a></code>, defaulting to <code><a href="/reference/androidx/compose/material/package-summary.html#LocalContentColor()">LocalContentColor</a></code>.</p>
</td>
</tr>
<tr>
<td><code>static&nbsp;final void</code></td>
<td>
<div><code>@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br><a href="/reference/androidx/compose/material/IconKt.html#Icon(androidx.compose.ui.graphics.painter.Painter,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/painter/Painter.html">Painter</a>&nbsp;painter,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint<br>)</code></div>
<p>Icon component that draws a <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.painter.Painter,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">painter</a></code> using <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.painter.Painter,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">tint</a></code>, defaulting to <code><a href="/reference/androidx/compose/material/package-summary.html#LocalContentColor()">LocalContentColor</a></code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
<h2>Public methods</h2>
<div class="api-item"><a name="Icon(androidx.compose.ui.graphics.ImageBitmap, kotlin.String, androidx.compose.ui.Modifier, androidx.compose.ui.graphics.Color)"></a><a name="Icon-androidx.compose.ui.graphics.ImageBitmap-kotlin.String-androidx.compose.ui.Modifier-androidx.compose.ui.graphics.Color-"></a><a name="icon"></a>
<h3 class="api-name" id="Icon(androidx.compose.ui.graphics.ImageBitmap,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br>public&nbsp;static&nbsp;final&nbsp;void&nbsp;<a href="/reference/androidx/compose/material/IconKt.html#Icon(androidx.compose.ui.graphics.ImageBitmap,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/ImageBitmap.html">ImageBitmap</a>&nbsp;bitmap,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint<br>)</pre>
<p>Icon component that draws <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.ImageBitmap,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">bitmap</a></code> using <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.ImageBitmap,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">tint</a></code>, defaulting to <code><a href="/reference/androidx/compose/material/package-summary.html#LocalContentColor()">LocalContentColor</a></code>. For a clickable icon, see <code><a href="/reference/androidx/compose/material/package-summary.html#IconButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0)">IconButton</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/ImageBitmap.html">ImageBitmap</a>&nbsp;bitmap</code></td>
<td>
<p><code><a href="/reference/androidx/compose/ui/graphics/ImageBitmap.html">ImageBitmap</a></code> to draw inside this Icon</p>
</td>
</tr>
<tr>
<td><code><a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription</code></td>
<td>
<p>text used by accessibility services to describe what this icon represents. This should always be provided unless this icon is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using <code><a href="/reference/androidx/compose/ui/res/package-summary.html#stringResource(kotlin.Int)">androidx.compose.ui.res.stringResource</a></code> or similar</p>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier</code></td>
<td>
<p>optional <code><a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a></code> for this Icon</p>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint</code></td>
<td>
<p>tint to be applied to <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.ImageBitmap,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">bitmap</a></code>. If <code><a href="/reference/androidx/compose/ui/graphics/Color.Companion.html#Unspecified()">Color.Unspecified</a></code> is provided, then no tint is applied</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="api-item"><a name="Icon(androidx.compose.ui.graphics.vector.ImageVector, kotlin.String, androidx.compose.ui.Modifier, androidx.compose.ui.graphics.Color)"></a><a name="Icon-androidx.compose.ui.graphics.vector.ImageVector-kotlin.String-androidx.compose.ui.Modifier-androidx.compose.ui.graphics.Color-"></a><a name="icon"></a>
<h3 class="api-name" id="Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br>public&nbsp;static&nbsp;final&nbsp;void&nbsp;<a href="/reference/androidx/compose/material/IconKt.html#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/vector/ImageVector.html">ImageVector</a>&nbsp;imageVector,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint<br>)</pre>
<p>Icon component that draws <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">imageVector</a></code> using <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">tint</a></code>, defaulting to <code><a href="/reference/androidx/compose/material/package-summary.html#LocalContentColor()">LocalContentColor</a></code>. For a clickable icon, see <code><a href="/reference/androidx/compose/material/package-summary.html#IconButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0)">IconButton</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/vector/ImageVector.html">ImageVector</a>&nbsp;imageVector</code></td>
<td>
<p><code><a href="/reference/androidx/compose/ui/graphics/vector/ImageVector.html">ImageVector</a></code> to draw inside this Icon</p>
</td>
</tr>
<tr>
<td><code><a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription</code></td>
<td>
<p>text used by accessibility services to describe what this icon represents. This should always be provided unless this icon is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using <code><a href="/reference/androidx/compose/ui/res/package-summary.html#stringResource(kotlin.Int)">androidx.compose.ui.res.stringResource</a></code> or similar</p>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier</code></td>
<td>
<p>optional <code><a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a></code> for this Icon</p>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint</code></td>
<td>
<p>tint to be applied to <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.vector.ImageVector,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">imageVector</a></code>. If <code><a href="/reference/androidx/compose/ui/graphics/Color.Companion.html#Unspecified()">Color.Unspecified</a></code> is provided, then no tint is applied</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="api-item"><a name="Icon(androidx.compose.ui.graphics.painter.Painter, kotlin.String, androidx.compose.ui.Modifier, androidx.compose.ui.graphics.Color)"></a><a name="Icon-androidx.compose.ui.graphics.painter.Painter-kotlin.String-androidx.compose.ui.Modifier-androidx.compose.ui.graphics.Color-"></a><a name="icon"></a>
<h3 class="api-name" id="Icon(androidx.compose.ui.graphics.painter.Painter,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br>public&nbsp;static&nbsp;final&nbsp;void&nbsp;<a href="/reference/androidx/compose/material/IconKt.html#Icon(androidx.compose.ui.graphics.painter.Painter,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">Icon</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/painter/Painter.html">Painter</a>&nbsp;painter,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint<br>)</pre>
<p>Icon component that draws a <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.painter.Painter,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">painter</a></code> using <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.painter.Painter,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">tint</a></code>, defaulting to <code><a href="/reference/androidx/compose/material/package-summary.html#LocalContentColor()">LocalContentColor</a></code>. For a clickable icon, see <code><a href="/reference/androidx/compose/material/package-summary.html#IconButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0)">IconButton</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/painter/Painter.html">Painter</a>&nbsp;painter</code></td>
<td>
<p><code><a href="/reference/androidx/compose/ui/graphics/painter/Painter.html">Painter</a></code> to draw inside this Icon</p>
</td>
</tr>
<tr>
<td><code><a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;contentDescription</code></td>
<td>
<p>text used by accessibility services to describe what this icon represents. This should always be provided unless this icon is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using <code><a href="/reference/androidx/compose/ui/res/package-summary.html#stringResource(kotlin.Int)">androidx.compose.ui.res.stringResource</a></code> or similar</p>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a>&nbsp;modifier</code></td>
<td>
<p>optional <code><a href="/reference/androidx/compose/ui/Modifier.html">Modifier</a></code> for this Icon</p>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;tint</code></td>
<td>
<p>tint to be applied to <code><a href="/reference/androidx/compose/material/package-summary.html#Icon(androidx.compose.ui.graphics.painter.Painter,kotlin.String,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color)">painter</a></code>. If <code><a href="/reference/androidx/compose/ui/graphics/Color.Companion.html#Unspecified()">Color.Unspecified</a></code> is provided, then no tint is applied</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>