Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Calvin-LL committed May 7, 2024
1 parent 0291352 commit d5df408
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import kotlinx.coroutines.CoroutineScope
* @param scrollThresholdPadding The padding that will be added to the top and bottom, or start and end of the grid to determine the scrollThreshold. Useful for when the grid is displayed under the navigation bar or notification bar.
* @param scrollThreshold The distance in dp from the top and bottom, or start and end of the grid that will trigger scrolling
* @param scroller The [Scroller] that will be used to scroll the grid. Use [rememberScroller](sh.calvin.reorderable.ScrollerKt.rememberScroller) to create a [Scroller].
* @param onMove The function that is called when an item is moved
* @param onMove The function that is called when an item is moved. Make sure this function returns only after the items are swapped. This suspend function is invoked with the `rememberReorderableLazyGridState` scope, allowing for async processing, if desired. Note that the scope used here is the one provided by the composition where `rememberReorderableLazyGridState` is called, for long running work that needs to outlast `rememberReorderableLazyGridState` being in the composition you should use a scope that fits the lifecycle needed.
*/
@Composable
fun rememberReorderableLazyGridState(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ import kotlinx.coroutines.CoroutineScope
* @param scrollThresholdPadding The padding that will be added to the top and bottom of the list to determine the scrollThreshold. Useful for when the grid is displayed under the navigation bar or notification bar.
* @param scrollThreshold The distance in dp from the top or bottom of the list that will trigger scrolling
* @param scroller The [Scroller] that will be used to scroll the list. Use [rememberScroller](sh.calvin.reorderable.ScrollerKt.rememberScroller) to create a [Scroller].
* @param onMove The function that is called when an item is moved
* @param onMove The function that is called when an item is moved. Make sure this function returns only after the items are swapped. This suspend function is invoked with the `rememberReorderableLazyColumnState` scope, allowing for async processing, if desired. Note that the scope used here is the one provided by the composition where `rememberReorderableLazyColumnState` is called, for long running work that needs to outlast `rememberReorderableLazyColumnState` being in the composition you should use a scope that fits the lifecycle needed.
*/
@Deprecated(
message = "Use rememberReorderableLazyListState instead",
Expand Down Expand Up @@ -92,7 +92,7 @@ fun rememberReorderableLazyColumnState(
* @param scrollThresholdPadding The padding that will be added to the left and right of the list to determine the scrollThreshold. Useful for when the grid is displayed under the navigation bar or notification bar.
* @param scrollThreshold The distance in dp from the left or right of the list that will trigger scrolling
* @param scroller The [Scroller] that will be used to scroll the list. Use [rememberScroller](sh.calvin.reorderable.ScrollerKt.rememberScroller) to create a [Scroller].
* @param onMove The function that is called when an item is moved
* @param onMove The function that is called when an item is moved. Make sure this function returns only after the items are swapped. This suspend function is invoked with the `rememberReorderableLazyRowState` scope, allowing for async processing, if desired. Note that the scope used here is the one provided by the composition where `rememberReorderableLazyRowState` is called, for long running work that needs to outlast `rememberReorderableLazyRowState` being in the composition you should use a scope that fits the lifecycle needed.
*/
@Deprecated(
message = "Use rememberReorderableLazyListState instead",
Expand Down Expand Up @@ -128,7 +128,7 @@ fun rememberReorderableLazyRowState(
* @param scrollThresholdPadding The padding that will be added to the top and bottom, or start and end of the list to determine the scrollThreshold. Useful for when the grid is displayed under the navigation bar or notification bar.
* @param scrollThreshold The distance in dp from the top and bottom, or start and end of the list that will trigger scrolling
* @param scroller The [Scroller] that will be used to scroll the list. Use [rememberScroller](sh.calvin.reorderable.ScrollerKt.rememberScroller) to create a [Scroller].
* @param onMove The function that is called when an item is moved
* @param onMove The function that is called when an item is moved. Make sure this function returns only after the items are swapped. This suspend function is invoked with the `rememberReorderableLazyListState` scope, allowing for async processing, if desired. Note that the scope used here is the one provided by the composition where `rememberReorderableLazyListState` is called, for long running work that needs to outlast `rememberReorderableLazyListState` being in the composition you should use a scope that fits the lifecycle needed.
*/
@Composable
fun rememberReorderableLazyListState(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import kotlinx.coroutines.CoroutineScope
* @param scrollThresholdPadding The padding that will be added to the top and bottom, or start and end of the grid to determine the scrollThreshold. Useful for when the grid is displayed under the navigation bar or notification bar.
* @param scrollThreshold The distance in dp from the top and bottom, or start and end of the grid that will trigger scrolling
* @param scroller The [Scroller] that will be used to scroll the grid. Use [rememberScroller](sh.calvin.reorderable.ScrollerKt.rememberScroller) to create a [Scroller].
* @param onMove The function that is called when an item is moved
* @param onMove The function that is called when an item is moved. Make sure this function returns only after the items are swapped. This suspend function is invoked with the `rememberReorderableLazyStaggeredGridState` scope, allowing for async processing, if desired. Note that the scope used here is the one provided by the composition where `rememberReorderableLazyStaggeredGridState` is called, for long running work that needs to outlast `rememberReorderableLazyStaggeredGridState` being in the composition you should use a scope that fits the lifecycle needed.
*/
@Composable
fun rememberReorderableLazyStaggeredGridState(
Expand Down

0 comments on commit d5df408

Please sign in to comment.