commonMain.androidx.compose.foundation.lazy.grid.LazyGrid.kt Maven / Gradle / Ivy
/*
* Copyright 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.compose.foundation.lazy.grid
import androidx.compose.foundation.ExperimentalFoundationApi
import androidx.compose.foundation.checkScrollableContainerConstraints
import androidx.compose.foundation.gestures.FlingBehavior
import androidx.compose.foundation.gestures.Orientation
import androidx.compose.foundation.gestures.ScrollableDefaults
import androidx.compose.foundation.internal.requirePreconditionNotNull
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.calculateEndPadding
import androidx.compose.foundation.layout.calculateStartPadding
import androidx.compose.foundation.lazy.layout.LazyLayout
import androidx.compose.foundation.lazy.layout.LazyLayoutMeasureScope
import androidx.compose.foundation.lazy.layout.StickyItemsPlacement
import androidx.compose.foundation.lazy.layout.calculateLazyLayoutPinnedIndices
import androidx.compose.foundation.lazy.layout.lazyLayoutBeyondBoundsModifier
import androidx.compose.foundation.lazy.layout.lazyLayoutSemantics
import androidx.compose.foundation.scrollingContainer
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.runtime.snapshots.Snapshot
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.GraphicsContext
import androidx.compose.ui.layout.MeasureResult
import androidx.compose.ui.layout.Placeable
import androidx.compose.ui.platform.LocalGraphicsContext
import androidx.compose.ui.platform.LocalLayoutDirection
import androidx.compose.ui.platform.LocalScrollCaptureInProgress
import androidx.compose.ui.unit.Constraints
import androidx.compose.ui.unit.IntOffset
import androidx.compose.ui.unit.constrainHeight
import androidx.compose.ui.unit.constrainWidth
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.offset
import androidx.compose.ui.util.fastForEach
import kotlinx.coroutines.CoroutineScope
@OptIn(ExperimentalFoundationApi::class)
@Composable
internal fun LazyGrid(
/** Modifier to be applied for the inner layout */
modifier: Modifier = Modifier,
/** State controlling the scroll position */
state: LazyGridState,
/** Prefix sums of cross axis sizes of slots per line, e.g. the columns for vertical grid. */
slots: LazyGridSlotsProvider,
/** The inner padding to be added for the whole content (not for each individual item) */
contentPadding: PaddingValues = PaddingValues(0.dp),
/** reverse the direction of scrolling and layout */
reverseLayout: Boolean = false,
/** The layout orientation of the grid */
isVertical: Boolean,
/** fling behavior to be used for flinging */
flingBehavior: FlingBehavior = ScrollableDefaults.flingBehavior(),
/** Whether scrolling via the user gestures is allowed. */
userScrollEnabled: Boolean,
/** The vertical arrangement for items/lines. */
verticalArrangement: Arrangement.Vertical,
/** The horizontal arrangement for items/lines. */
horizontalArrangement: Arrangement.Horizontal,
/** The content of the grid */
content: LazyGridScope.() -> Unit
) {
val itemProviderLambda = rememberLazyGridItemProviderLambda(state, content)
val semanticState = rememberLazyGridSemanticState(state, reverseLayout)
val coroutineScope = rememberCoroutineScope()
val graphicsContext = LocalGraphicsContext.current
val stickyHeadersEnabled = !LocalScrollCaptureInProgress.current
val measurePolicy =
rememberLazyGridMeasurePolicy(
itemProviderLambda,
state,
slots,
contentPadding,
reverseLayout,
isVertical,
horizontalArrangement,
verticalArrangement,
coroutineScope,
graphicsContext,
if (stickyHeadersEnabled) StickyItemsPlacement.StickToTopPlacement else null
)
val orientation = if (isVertical) Orientation.Vertical else Orientation.Horizontal
val reverseDirection =
ScrollableDefaults.reverseDirection(
LocalLayoutDirection.current,
orientation,
reverseLayout
)
LazyLayout(
modifier =
modifier
.then(state.remeasurementModifier)
.then(state.awaitLayoutModifier)
.lazyLayoutSemantics(
itemProviderLambda = itemProviderLambda,
state = semanticState,
orientation = orientation,
userScrollEnabled = userScrollEnabled,
reverseScrolling = reverseLayout,
)
.lazyLayoutBeyondBoundsModifier(
state = rememberLazyGridBeyondBoundsState(state = state),
beyondBoundsInfo = state.beyondBoundsInfo,
reverseLayout = reverseLayout,
layoutDirection = LocalLayoutDirection.current,
orientation = orientation,
enabled = userScrollEnabled
)
.then(state.itemAnimator.modifier)
.scrollingContainer(
state = state,
orientation = orientation,
enabled = userScrollEnabled,
reverseDirection = reverseDirection,
flingBehavior = flingBehavior,
interactionSource = state.internalInteractionSource,
overscrollEffect = ScrollableDefaults.overscrollEffect()
),
prefetchState = state.prefetchState,
measurePolicy = measurePolicy,
itemProvider = itemProviderLambda
)
}
/** lazy grid slots configuration */
internal class LazyGridSlots(val sizes: IntArray, val positions: IntArray)
@OptIn(ExperimentalFoundationApi::class)
@Composable
private fun rememberLazyGridMeasurePolicy(
/** Items provider of the list. */
itemProviderLambda: () -> LazyGridItemProvider,
/** The state of the list. */
state: LazyGridState,
/** Prefix sums of cross axis sizes of slots of the grid. */
slots: LazyGridSlotsProvider,
/** The inner padding to be added for the whole content(nor for each individual item) */
contentPadding: PaddingValues,
/** reverse the direction of scrolling and layout */
reverseLayout: Boolean,
/** The layout orientation of the list */
isVertical: Boolean,
/** The horizontal arrangement for items */
horizontalArrangement: Arrangement.Horizontal?,
/** The vertical arrangement for items */
verticalArrangement: Arrangement.Vertical?,
/** Coroutine scope for item animations */
coroutineScope: CoroutineScope,
/** Used for creating graphics layers */
graphicsContext: GraphicsContext,
/** Configures the placement of sticky items */
stickyItemsScrollBehavior: StickyItemsPlacement?
) =
remember MeasureResult>(
state,
slots,
contentPadding,
reverseLayout,
isVertical,
horizontalArrangement,
verticalArrangement,
graphicsContext
) {
{ containerConstraints ->
state.measurementScopeInvalidator.attachToScope()
checkScrollableContainerConstraints(
containerConstraints,
if (isVertical) Orientation.Vertical else Orientation.Horizontal
)
// resolve content paddings
val startPadding =
if (isVertical) {
contentPadding.calculateLeftPadding(layoutDirection).roundToPx()
} else {
// in horizontal configuration, padding is reversed by placeRelative
contentPadding.calculateStartPadding(layoutDirection).roundToPx()
}
val endPadding =
if (isVertical) {
contentPadding.calculateRightPadding(layoutDirection).roundToPx()
} else {
// in horizontal configuration, padding is reversed by placeRelative
contentPadding.calculateEndPadding(layoutDirection).roundToPx()
}
val topPadding = contentPadding.calculateTopPadding().roundToPx()
val bottomPadding = contentPadding.calculateBottomPadding().roundToPx()
val totalVerticalPadding = topPadding + bottomPadding
val totalHorizontalPadding = startPadding + endPadding
val totalMainAxisPadding =
if (isVertical) totalVerticalPadding else totalHorizontalPadding
val beforeContentPadding =
when {
isVertical && !reverseLayout -> topPadding
isVertical && reverseLayout -> bottomPadding
!isVertical && !reverseLayout -> startPadding
else -> endPadding // !isVertical && reverseLayout
}
val afterContentPadding = totalMainAxisPadding - beforeContentPadding
val contentConstraints =
containerConstraints.offset(-totalHorizontalPadding, -totalVerticalPadding)
val itemProvider = itemProviderLambda()
val spanLayoutProvider = itemProvider.spanLayoutProvider
val resolvedSlots = slots.invoke(density = this, constraints = containerConstraints)
val slotsPerLine = resolvedSlots.sizes.size
spanLayoutProvider.slotsPerLine = slotsPerLine
val spaceBetweenLinesDp =
if (isVertical) {
requirePreconditionNotNull(verticalArrangement) {
"null verticalArrangement when isVertical == true"
}
.spacing
} else {
requirePreconditionNotNull(horizontalArrangement) {
"null horizontalArrangement when isVertical == false"
}
.spacing
}
val spaceBetweenLines = spaceBetweenLinesDp.roundToPx()
val itemsCount = itemProvider.itemCount
// can be negative if the content padding is larger than the max size from constraints
val mainAxisAvailableSize =
if (isVertical) {
containerConstraints.maxHeight - totalVerticalPadding
} else {
containerConstraints.maxWidth - totalHorizontalPadding
}
val visualItemOffset =
if (!reverseLayout || mainAxisAvailableSize > 0) {
IntOffset(startPadding, topPadding)
} else {
// When layout is reversed and paddings together take >100% of the available
// space,
// layout size is coerced to 0 when positioning. To take that space into
// account,
// we offset start padding by negative space between paddings.
IntOffset(
if (isVertical) startPadding else startPadding + mainAxisAvailableSize,
if (isVertical) topPadding + mainAxisAvailableSize else topPadding
)
}
val measuredItemProvider =
object : LazyGridMeasuredItemProvider(itemProvider, this, spaceBetweenLines) {
override fun createItem(
index: Int,
key: Any,
contentType: Any?,
crossAxisSize: Int,
mainAxisSpacing: Int,
placeables: List,
constraints: Constraints,
lane: Int,
span: Int
) =
LazyGridMeasuredItem(
index = index,
key = key,
isVertical = isVertical,
crossAxisSize = crossAxisSize,
mainAxisSpacing = mainAxisSpacing,
reverseLayout = reverseLayout,
layoutDirection = layoutDirection,
beforeContentPadding = beforeContentPadding,
afterContentPadding = afterContentPadding,
visualOffset = visualItemOffset,
placeables = placeables,
contentType = contentType,
animator = state.itemAnimator,
constraints = constraints,
lane = lane,
span = span
)
}
val measuredLineProvider =
object :
LazyGridMeasuredLineProvider(
isVertical = isVertical,
slots = resolvedSlots,
gridItemsCount = itemsCount,
spaceBetweenLines = spaceBetweenLines,
measuredItemProvider = measuredItemProvider,
spanLayoutProvider = spanLayoutProvider
) {
override fun createLine(
index: Int,
items: Array,
spans: List,
mainAxisSpacing: Int
) =
LazyGridMeasuredLine(
index = index,
items = items,
spans = spans,
slots = resolvedSlots,
isVertical = isVertical,
mainAxisSpacing = mainAxisSpacing,
)
}
val prefetchInfoRetriever: (line: Int) -> List> = { line ->
val lineConfiguration = spanLayoutProvider.getLineConfiguration(line)
var index = lineConfiguration.firstItemIndex
var slot = 0
val result = ArrayList>(lineConfiguration.spans.size)
lineConfiguration.spans.fastForEach {
val span = it.currentLineSpan
result.add(index to measuredLineProvider.childConstraints(slot, span))
++index
slot += span
}
result
}
val firstVisibleLineIndex: Int
val firstVisibleLineScrollOffset: Int
Snapshot.withoutReadObservation {
val index =
state.updateScrollPositionIfTheFirstItemWasMoved(
itemProvider,
state.firstVisibleItemIndex
)
if (index < itemsCount || itemsCount <= 0) {
firstVisibleLineIndex = spanLayoutProvider.getLineIndexOfItem(index)
firstVisibleLineScrollOffset = state.firstVisibleItemScrollOffset
} else {
// the data set has been updated and now we have less items that we were
// scrolled to before
firstVisibleLineIndex = spanLayoutProvider.getLineIndexOfItem(itemsCount - 1)
firstVisibleLineScrollOffset = 0
}
}
val pinnedItems =
itemProvider.calculateLazyLayoutPinnedIndices(
state.pinnedItems,
state.beyondBoundsInfo
)
// todo: wrap with snapshot when b/341782245 is resolved
val measureResult =
measureLazyGrid(
itemsCount = itemsCount,
measuredLineProvider = measuredLineProvider,
measuredItemProvider = measuredItemProvider,
mainAxisAvailableSize = mainAxisAvailableSize,
beforeContentPadding = beforeContentPadding,
afterContentPadding = afterContentPadding,
spaceBetweenLines = spaceBetweenLines,
firstVisibleLineIndex = firstVisibleLineIndex,
firstVisibleLineScrollOffset = firstVisibleLineScrollOffset,
scrollToBeConsumed = state.scrollToBeConsumed,
constraints = contentConstraints,
isVertical = isVertical,
verticalArrangement = verticalArrangement,
horizontalArrangement = horizontalArrangement,
reverseLayout = reverseLayout,
density = this,
itemAnimator = state.itemAnimator,
slotsPerLine = slotsPerLine,
pinnedItems = pinnedItems,
coroutineScope = coroutineScope,
placementScopeInvalidator = state.placementScopeInvalidator,
prefetchInfoRetriever = prefetchInfoRetriever,
graphicsContext = graphicsContext,
stickyItemsScrollBehavior = stickyItemsScrollBehavior,
layout = { width, height, placement ->
layout(
containerConstraints.constrainWidth(width + totalHorizontalPadding),
containerConstraints.constrainHeight(height + totalVerticalPadding),
emptyMap(),
placement
)
}
)
state.applyMeasureResult(measureResult)
measureResult
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy