/* * Copyright 2024 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.wear.compose.foundation.samples import androidx.annotation.Sampled import androidx.compose.animation.AnimatedVisibility import androidx.compose.foundation.background import androidx.compose.foundation.clickable import androidx.compose.foundation.layout.Box import androidx.compose.foundation.layout.PaddingValues import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.padding import androidx.compose.runtime.Composable import androidx.compose.runtime.LaunchedEffect import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableIntStateOf import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.runtime.rememberCoroutineScope import androidx.compose.runtime.setValue import androidx.compose.runtime.snapshotFlow import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.draw.drawBehind import androidx.compose.ui.graphics.Color import androidx.compose.ui.layout.LocalPinnableContainer import androidx.compose.ui.layout.PinnableContainer import androidx.compose.ui.tooling.preview.Preview import androidx.compose.ui.unit.dp import androidx.compose.ui.util.fastFirstOrNull import androidx.wear.compose.foundation.lazy.TransformingLazyColumn import androidx.wear.compose.foundation.lazy.TransformingLazyColumnDefaults import androidx.wear.compose.foundation.lazy.TransformingLazyColumnFirstLayoutItemProvider import androidx.wear.compose.foundation.lazy.TransformingLazyColumnFirstLayoutItemProvider.ItemEdge import androidx.wear.compose.foundation.lazy.rememberTransformingLazyColumnState import androidx.wear.compose.foundation.rotary.RotaryScrollableDefaults import androidx.wear.compose.material.Text import androidx.wear.compose.material3.Button import androidx.wear.compose.material3.ButtonDefaults import androidx.wear.compose.material3.CardDefaults import androidx.wear.compose.material3.SurfaceTransformation import androidx.wear.compose.material3.TitleCard import androidx.wear.compose.material3.lazy.rememberTransformationSpec import androidx.wear.compose.material3.lazy.transformedHeight import kotlin.math.abs import kotlinx.coroutines.launch @Sampled @Preview @Composable fun SimpleTransformingLazyColumnSample() { val transformationSpec = rememberTransformationSpec() TransformingLazyColumn(contentPadding = PaddingValues(20.dp)) { items(count = 10) { index -> Button( modifier = Modifier.fillMaxWidth().transformedHeight(this, transformationSpec), transformation = SurfaceTransformation(transformationSpec), onClick = {}, ) { Text(text = "Item $index") } } } } @Sampled @Preview @Composable fun TransformingLazyColumnWithSnapSample() { val transformationSpec = rememberTransformationSpec() val state = rememberTransformingLazyColumnState() TransformingLazyColumn( rotaryScrollableBehavior = RotaryScrollableDefaults.snapBehavior(scrollableState = state), flingBehavior = TransformingLazyColumnDefaults.snapFlingBehavior(state = state), modifier = Modifier.fillMaxWidth(), state = state, contentPadding = PaddingValues(20.dp), ) { items(count = 20) { index -> Button( modifier = Modifier.fillMaxWidth().transformedHeight(this, transformationSpec), transformation = SurfaceTransformation(transformationSpec), onClick = {}, ) { Text(text = "Item $index") } } } } @Sampled @Preview @Composable fun TransformingLazyColumnAnimateItemSample() { val state = rememberTransformingLazyColumnState() var list by remember { mutableStateOf(listOf("1", "2", "3")) } var next by remember { mutableIntStateOf(4) } Box(Modifier.fillMaxSize()) { TransformingLazyColumn( state = state, contentPadding = PaddingValues(5.dp), modifier = Modifier.background(Color.Black).fillMaxSize(), ) { items(list.size, key = { list[it] }) { Text( "Item ${list[it]}", Modifier.animateItem().clickable { list = list.filter { elem -> elem != list[it] } }, ) } } Text( "+", Modifier.align(Alignment.CenterStart).padding(horizontal = 5.dp).clickable { if (list.size < 25) list = list + "${next++}" }, ) Text( "S", Modifier.align(Alignment.CenterEnd).padding(horizontal = 5.dp).clickable { list = list.shuffled() }, ) } } @Sampled @Preview @Composable fun TransformingLazyColumnScrollToItemSample() { val state = rememberTransformingLazyColumnState( // Customize initial scroll position of the TransformingLazyColumn. initialAnchorItemIndex = 10 ) val coroutineScope = rememberCoroutineScope() TransformingLazyColumn( modifier = Modifier.background(Color.Black), state = state, contentPadding = PaddingValues(vertical = 20.dp), ) { items(count = 20) { Text( "Item $it", modifier = Modifier.drawBehind { val isCentered = it == state.anchorItemIndex && abs(state.anchorItemScrollOffset) < size.height drawRect(if (isCentered) Color.Green else Color.DarkGray) } .padding(5.dp) .clickable { coroutineScope.launch { state.scrollToItem(it) } }, ) } item { Text( "Scroll to top", modifier = Modifier.clickable { coroutineScope.launch { state.animateScrollToItem(0) } }, ) } } LaunchedEffect(Unit) { snapshotFlow { state.anchorItemIndex }.collect { println("Anchor item index: $it") } } } @Sampled @Preview @Composable fun TransformingLazyColumnMinimumVerticalContentPaddingSample() { val transformationSpec = rememberTransformationSpec() TransformingLazyColumn(contentPadding = PaddingValues(horizontal = 20.dp)) { items(count = 20) { index -> Button( modifier = Modifier.fillMaxWidth() .transformedHeight(this, transformationSpec) .minimumVerticalContentPadding( ButtonDefaults.minimumVerticalListContentPadding ), transformation = SurfaceTransformation(transformationSpec), onClick = {}, ) { Text(text = "Item $index") } } } } @Sampled @Preview @Composable fun TransformingLazyColumnFirstLayoutItemProviderSample() { val state = rememberTransformingLazyColumnState() val transformationSpec = rememberTransformationSpec() var expandedItemIndex by remember { mutableIntStateOf(-1) } // This sample demonstrates how to use the provider API to control the direction of content // shifting. By default, TransformingLazyColumn uses the center item as the layout reference. // This means that if an item above the center expands, it pushes content upwards; // if below, it pushes downwards. // // Here, we fix the Bottom/End edge of the clicked item regardless of its position on screen, // so that when its animated content appears, the card predictably expands *upwards* every time. val upwardExpandingItemProvider = remember(state) { TransformingLazyColumnFirstLayoutItemProvider { centerItem -> val item = expandedItemIndex // Yield to the standard layout behavior during active scrolls. // This avoids custom layout overhead and ensures the [TransformingLazyColumn] // tracks the user's scroll gesture using its default center layout reference. if (item == -1 || state.isScrollInProgress) { return@TransformingLazyColumnFirstLayoutItemProvider centerItem } // Look up the item's offset from state.layoutInfo (which holds the details // from the previous measure pass) to maintain its visual position in the current // pass. state.layoutInfo.visibleItems .fastFirstOrNull { visibleItem -> visibleItem.index == item } ?.let { visibleItem -> TransformingLazyColumnFirstLayoutItemProvider.ItemInfo( key = visibleItem.key, index = visibleItem.index, // Pin the bottom edge of the item itemEdge = ItemEdge.End, // Calculate the exact bottom offset from the previous pass offset = visibleItem.offset + visibleItem.transformedHeight, ) } ?: centerItem } } TransformingLazyColumn( state = state, contentPadding = PaddingValues(horizontal = 20.dp), firstLayoutItemProvider = upwardExpandingItemProvider, ) { items(count = 10, key = { it }) { cardIndex -> val isExpanded = expandedItemIndex == cardIndex TitleCard( onClick = { expandedItemIndex = cardIndex }, modifier = Modifier.minimumVerticalContentPadding( CardDefaults.minimumVerticalListContentPadding ) .fillMaxWidth() .transformedHeight(this, transformationSpec), transformation = SurfaceTransformation(transformationSpec), title = { Text("Card $cardIndex") }, subtitle = { AnimatedVisibility(isExpanded) { Text("Expanded content is available here") } }, content = { Text("Tap to expand") }, ) } } } @Sampled @Preview @Composable fun TransformingLazyColumnPinnableContainerSample() { val state = rememberTransformingLazyColumnState() val transformationSpec = rememberTransformationSpec() TransformingLazyColumn(state = state, contentPadding = PaddingValues(horizontal = 20.dp)) { items(count = 20) { index -> var isPinned by remember { mutableStateOf(false) } var pinHandle by remember { mutableStateOf<PinnableContainer.PinnedHandle?>(null) } val pinnableContainer = LocalPinnableContainer.current // This state will be reset if the item is scrolled out and not pinned var counter by remember { mutableIntStateOf(0) } TitleCard( onClick = { counter++ }, modifier = Modifier.fillMaxWidth().transformedHeight(this, transformationSpec), transformation = SurfaceTransformation(transformationSpec), title = { Text("Item $index") }, subtitle = { Text("Count: $counter (Tap card to +)") }, content = { // This button toggles the pin state Button( onClick = { if (isPinned) { pinHandle?.release().also { pinHandle = null } isPinned = false } else { pinHandle = pinnableContainer?.pin() isPinned = true } }, colors = if (isPinned) { ButtonDefaults.buttonColors() } else { ButtonDefaults.filledTonalButtonColors() }, ) { Text(if (isPinned) "Unpin" else "Pin Off-screen") } }, ) } } }
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-07-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-07-30 UTC."],[],[]]