blob: 1d76db5087ff05701e04e6d6799db1e97aab43ec [file] [log] [blame]
<html devsite="true">
<head>
<title>LazyItemScope</title>
{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>LazyItemScope</h1>
<p>
<pre>@<a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyScopeMarker.html">LazyScopeMarker</a><br>interface <a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html">LazyItemScope</a></pre>
</p>
<hr>
<p>Receiver scope being used by the item content parameter of LazyColumn/Row.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public functions</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a>.<a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxHeight(kotlin.Float)">fillParentMaxHeight</a>(fraction:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>)</code></div>
<p>Have the content fill the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxHeight()">Constraints.maxHeight</a></code> of the incoming measurement constraints by setting the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#minHeight()">minimum height</a></code> to be equal to the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxHeight()">maximum height</a></code> multiplied by <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxHeight(kotlin.Float)">fraction</a></code>.</p>
</td>
</tr>
<tr>
<td width="40%"><code><a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a>.<a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fillParentMaxSize</a>(fraction:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>)</code></div>
<p>Have the content fill the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxWidth()">Constraints.maxWidth</a></code> and <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxHeight()">Constraints.maxHeight</a></code> of the parent measurement constraints by setting the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#minWidth()">minimum width</a></code> to be equal to the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxWidth()">maximum width</a></code> multiplied by <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fraction</a></code> and the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#minHeight()">minimum height</a></code> to be equal to the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxHeight()">maximum height</a></code> multiplied by <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fraction</a></code>.</p>
</td>
</tr>
<tr>
<td width="40%"><code><a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a>.<a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxWidth(kotlin.Float)">fillParentMaxWidth</a>(fraction:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>)</code></div>
<p>Have the content fill the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxWidth()">Constraints.maxWidth</a></code> of the parent measurement constraints by setting the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#minWidth()">minimum width</a></code> to be equal to the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxWidth()">maximum width</a></code> multiplied by <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxWidth(kotlin.Float)">fraction</a></code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public functions</h2>
<div><a name="-androidx.compose.ui.Modifier-.fillParentMaxHeight-kotlin.Float-"></a><a name="fillparentmaxheight"></a>
<h3 class="api-name" id="(androidx.compose.ui.Modifier).fillParentMaxHeight(kotlin.Float)">fillParentMaxHeight</h3>
<pre class="api-signature no-pretty-print">fun&nbsp;<a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a>.<a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxHeight(kotlin.Float)">fillParentMaxHeight</a>(fraction:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a> = 1.0f):&nbsp;<a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a></pre>
<p>Have the content fill the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxHeight()">Constraints.maxHeight</a></code> of the incoming measurement constraints by setting the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#minHeight()">minimum height</a></code> to be equal to the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxHeight()">maximum height</a></code> multiplied by <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxHeight(kotlin.Float)">fraction</a></code>. Note that, by default, the <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxHeight(kotlin.Float)">fraction</a></code> is 1, so the modifier will make the content fill the whole parent height. <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxHeight(kotlin.Float)">fraction</a></code> must be between <code>0</code> and <code>1</code>.</p>
<p>Regular Modifier.fillMaxHeight can't work inside the scrolling vertically layouts as the items are measured with <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.Companion.html#Infinity()">Constraints.Infinity</a></code> as the constraints for the main axis.</p>
</div>
<div><a name="-androidx.compose.ui.Modifier-.fillParentMaxSize-kotlin.Float-"></a><a name="fillparentmaxsize"></a>
<h3 class="api-name" id="(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fillParentMaxSize</h3>
<pre class="api-signature no-pretty-print">fun&nbsp;<a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a>.<a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fillParentMaxSize</a>(fraction:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a> = 1.0f):&nbsp;<a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a></pre>
<p>Have the content fill the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxWidth()">Constraints.maxWidth</a></code> and <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxHeight()">Constraints.maxHeight</a></code> of the parent measurement constraints by setting the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#minWidth()">minimum width</a></code> to be equal to the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxWidth()">maximum width</a></code> multiplied by <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fraction</a></code> and the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#minHeight()">minimum height</a></code> to be equal to the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxHeight()">maximum height</a></code> multiplied by <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fraction</a></code>. Note that, by default, the <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fraction</a></code> is 1, so the modifier will make the content fill the whole available space. <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxSize(kotlin.Float)">fraction</a></code> must be between <code>0</code> and <code>1</code>.</p>
<p>Regular Modifier.fillMaxSize can't work inside the scrolling layouts as the items are measured with <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.Companion.html#Infinity()">Constraints.Infinity</a></code> as the constraints for the main axis.</p>
</div>
<div><a name="-androidx.compose.ui.Modifier-.fillParentMaxWidth-kotlin.Float-"></a><a name="fillparentmaxwidth"></a>
<h3 class="api-name" id="(androidx.compose.ui.Modifier).fillParentMaxWidth(kotlin.Float)">fillParentMaxWidth</h3>
<pre class="api-signature no-pretty-print">fun&nbsp;<a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a>.<a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxWidth(kotlin.Float)">fillParentMaxWidth</a>(fraction:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a> = 1.0f):&nbsp;<a href="/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a></pre>
<p>Have the content fill the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxWidth()">Constraints.maxWidth</a></code> of the parent measurement constraints by setting the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#minWidth()">minimum width</a></code> to be equal to the <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.html#maxWidth()">maximum width</a></code> multiplied by <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxWidth(kotlin.Float)">fraction</a></code>. Note that, by default, the <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxWidth(kotlin.Float)">fraction</a></code> is 1, so the modifier will make the content fill the whole parent width. <code><a href="/reference/kotlin/androidx/compose/foundation/lazy/LazyItemScope.html#(androidx.compose.ui.Modifier).fillParentMaxWidth(kotlin.Float)">fraction</a></code> must be between <code>0</code> and <code>1</code>.</p>
<p>Regular Modifier.fillMaxWidth can't work inside the scrolling horizontally layouts as the items are measured with <code><a href="/reference/kotlin/androidx/compose/ui/unit/Constraints.Companion.html#Infinity()">Constraints.Infinity</a></code> as the constraints for the main axis.</p>
</div>
</body>
</html>