Google Git
Sign in
android / platform / tools / dokka-devsite-plugin / 7a3026dbefb89909203619ff3ba4c3b8a2062ea9 / . / testData / compose / docs / reference / androidx / compose / material / ripple / RippleTheme.html
blob: 0c04d09ede8249ca5ed438e56eadd6e2e2f8a1eb [file] [log] [blame]
<html devsite="true">
<head>
<title>RippleTheme</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>RippleTheme</h1>
<p>
<pre>public interface <a href="/reference/androidx/compose/material/ripple/RippleTheme.html">RippleTheme</a></pre>
</p>
<hr>
<p>Defines the appearance for Ripples. You can define a new theme and apply it using <code><a href="/reference/androidx/compose/material/ripple/package-summary.html#LocalRippleTheme()">LocalRippleTheme</a></code>. See <code><a href="/reference/androidx/compose/material/ripple/RippleTheme.Companion.html#defaultRippleColor(androidx.compose.ui.graphics.Color,kotlin.Boolean)">defaultRippleColor</a></code> and <code><a href="/reference/androidx/compose/material/ripple/RippleTheme.Companion.html#defaultRippleAlpha(androidx.compose.ui.graphics.Color,kotlin.Boolean)">defaultRippleAlpha</a></code> for default values that can be used when creating your own <code><a href="/reference/androidx/compose/material/ripple/RippleTheme.html">RippleTheme</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">See also</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/androidx/compose/material/ripple/package-summary.html#rememberRipple(kotlin.Boolean,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color)">rememberRipple</a></code></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Nested types</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code>public static class <a href="/reference/androidx/compose/material/ripple/RippleTheme.Companion.html">RippleTheme.Companion</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<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 width="40%"><code>abstract @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a></code></td>
<td>
<div><code>@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br><a href="/reference/androidx/compose/material/ripple/RippleTheme.html#defaultColor()">defaultColor</a>()</code></div>
</td>
</tr>
<tr>
<td width="40%"><code>abstract @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/material/ripple/RippleAlpha.html">RippleAlpha</a></code></td>
<td>
<div><code>@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br><a href="/reference/androidx/compose/material/ripple/RippleTheme.html#rippleAlpha()">rippleAlpha</a>()</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
<h2>Public methods</h2>
<div class="api-item"><a name="defaultColor--"></a><a name="defaultcolor"></a>
<h3 class="api-name" id="defaultColor()">defaultColor</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br>abstract&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a>&nbsp;<a href="/reference/androidx/compose/material/ripple/RippleTheme.html#defaultColor()">defaultColor</a>()</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Returns</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/graphics/Color.html">Color</a></code></td>
<td>
<p>the default ripple color at the call site's position in the hierarchy. This color will be used when a color is not explicitly set in the ripple itself.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">See also</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/androidx/compose/material/ripple/RippleTheme.Companion.html#defaultRippleColor(androidx.compose.ui.graphics.Color,kotlin.Boolean)">defaultRippleColor</a></code></td>
<td></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="api-item"><a name="rippleAlpha--"></a><a name="ripplealpha"></a>
<h3 class="api-name" id="rippleAlpha()">rippleAlpha</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/androidx/compose/runtime/Composable.html">Composable</a><br>abstract&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/material/ripple/RippleAlpha.html">RippleAlpha</a>&nbsp;<a href="/reference/androidx/compose/material/ripple/RippleTheme.html#rippleAlpha()">rippleAlpha</a>()</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Returns</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/material/ripple/RippleAlpha.html">RippleAlpha</a></code></td>
<td>
<p>the <code><a href="/reference/androidx/compose/material/ripple/RippleAlpha.html">RippleAlpha</a></code> used to calculate the alpha for the ripple depending on the <code><a href="/reference/androidx/compose/foundation/interaction/Interaction.html">Interaction</a></code> for a given component. This will be set as the alpha channel for <code><a href="/reference/androidx/compose/material/ripple/RippleTheme.html#defaultColor()">defaultColor</a></code> or the color explicitly provided to the ripple.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">See also</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/androidx/compose/material/ripple/RippleTheme.Companion.html#defaultRippleAlpha(androidx.compose.ui.graphics.Color,kotlin.Boolean)">defaultRippleAlpha</a></code></td>
<td></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>