Package 

Class ScrollAwayKt

    • Method Summary

      Modifier and Type Method Description
      final static Modifier scrollAway(Modifier $self, ScrollState scrollState, Dp offset) Scroll an item vertically in/out of view based on a ScrollState.
      final static Modifier scrollAway(Modifier $self, LazyListState scrollState, Integer itemIndex, Dp offset) Scroll an item vertically in/out of view based on a LazyListState.
      final static Modifier scrollAway(Modifier $self, ScalingLazyListState scrollState, Integer itemIndex, Dp offset) Scroll an item vertically in/out of view based on a ScalingLazyListState.
      final static Modifier scrollAway(Modifier $self, ScalingLazyColumnState scalingLazyColumnState) Scroll an item vertically in/out of view based on a ScalingLazyListState.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • scrollAway

        @Deprecated(message = Replaced by Wear Compose scrollAway, replaceWith = @ReplaceWith(imports = {androidx.wear.compose.material.scrollAway}, expression = this.scrollAway(scrollState, offset))) final static Modifier scrollAway(Modifier $self, ScrollState scrollState, Dp offset)

        Scroll an item vertically in/out of view based on a ScrollState. Typically used to scroll a TimeText item out of view as the user starts to scroll a vertically scrollable Column of items upwards and bring additional items into view.

        Parameters:
        scrollState - The ScrollState to used as the basis for the scroll-away.
        offset - Adjustment to the starting point for scrolling away.
      • scrollAway

        @Deprecated(message = Replaced by Wear Compose scrollAway, replaceWith = @ReplaceWith(imports = {androidx.wear.compose.material.scrollAway}, expression = this.scrollAway(scrollState, itemIndex, offset))) final static Modifier scrollAway(Modifier $self, LazyListState scrollState, Integer itemIndex, Dp offset)

        Scroll an item vertically in/out of view based on a LazyListState. Typically used to scroll a TimeText item out of view as the user starts to scroll a LazyColumn of items upwards and bring additional items into view.

        Parameters:
        scrollState - The LazyListState to used as the basis for the scroll-away.
        itemIndex - The item for which the scroll offset will trigger scrolling away.
        offset - Adjustment to the starting point for scrolling away.
      • scrollAway

        @Deprecated(message = Replaced by Wear Compose scrollAway, replaceWith = @ReplaceWith(imports = {androidx.wear.compose.material.scrollAway}, expression = this.scrollAway(scrollState, itemIndex, offset))) final static Modifier scrollAway(Modifier $self, ScalingLazyListState scrollState, Integer itemIndex, Dp offset)

        Scroll an item vertically in/out of view based on a ScalingLazyListState. Typically used to scroll a TimeText item out of view as the user starts to scroll a ScalingLazyColumn of items upwards and bring additional items into view.

        Parameters:
        scrollState - The ScalingLazyListState to used as the basis for the scroll-away.
        itemIndex - The item for which the scroll offset will trigger scrolling away.
        offset - Adjustment to the starting point for scrolling away.
      • scrollAway

         final static Modifier scrollAway(Modifier $self, ScalingLazyColumnState scalingLazyColumnState)

        Scroll an item vertically in/out of view based on a ScalingLazyListState. Typically used to scroll a TimeText item out of view as the user starts to scroll a ScalingLazyColumn of items upwards and bring additional items into view.

        Parameters:
        scalingLazyColumnState - The list config.