From 47d0dcd0d70fff7fa1951d7bbaea752b535ff9a4 Mon Sep 17 00:00:00 2001 From: veyndan Date: Tue, 16 Jan 2024 17:13:08 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20site=20from=20=20@=20b71fa4418?= =?UTF-8?q?b252c003a0362067578bd580e1c7028=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../-lazy-list/index.html | 2 +- .../cross-axis-alignment.html | 2 +- .../-refreshable-lazy-list/height.html | 2 +- .../-refreshable-lazy-list/index.html | 28 +++++++++---------- .../-refreshable-lazy-list/is-vertical.html | 2 +- .../-refreshable-lazy-list/items-after.html | 2 +- .../-refreshable-lazy-list/items-before.html | 2 +- .../-refreshable-lazy-list/items.html | 2 +- .../-refreshable-lazy-list/margin.html | 2 +- .../-refreshable-lazy-list/on-refresh.html | 2 +- .../on-viewport-changed.html | 2 +- .../-refreshable-lazy-list/placeholder.html | 2 +- .../pull-refresh-content-color.html | 2 +- .../-refreshable-lazy-list/refreshing.html | 2 +- .../scroll-item-index.html | 2 +- .../-refreshable-lazy-list/width.html | 2 +- .../app.cash.redwood.lazylayout/index.html | 2 +- 17 files changed, 30 insertions(+), 30 deletions(-) diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-lazy-list/index.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-lazy-list/index.html index f282b71d29..b802763c9c 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-lazy-list/index.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-lazy-list/index.html @@ -62,7 +62,7 @@
redwood-lazylayout-schema/app.cash.redwood.lazylayout/LazyList

LazyList

-
data class LazyList(val isVertical: Boolean, val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit, val itemsBefore: Int, val itemsAfter: Int, val width: Constraint, val height: Constraint, val margin: Margin, val crossAxisAlignment: CrossAxisAlignment, val scrollItemIndex: ScrollItemIndex, val placeholder: () -> Unit, val items: () -> Unit)
+
data class LazyList(val isVertical: Boolean, val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit, val itemsBefore: Int, val itemsAfter: Int, val width: Constraint, val height: Constraint, val margin: Margin, val crossAxisAlignment: CrossAxisAlignment, val scrollItemIndex: ScrollItemIndex, val placeholder: () -> Unit, val items: () -> Unit)

The documentation for LazyList is a subset of the documentation for RefreshableLazyList. In order to avoid documentation duplication, see LazyList. The documentation should be unified once https://github.com/cashapp/redwood/issues/1084 is implemented and RefreshableLazyList has been deprecated and removed.

See also

diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/cross-axis-alignment.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/cross-axis-alignment.html index d5d8ef990c..b343b6a3df 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/cross-axis-alignment.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/cross-axis-alignment.html @@ -63,7 +63,7 @@

crossAxisAlignment

-
val crossAxisAlignment: CrossAxisAlignment
+
val crossAxisAlignment: CrossAxisAlignment

If isVertical, sets the default horizontal alignment for items in this list. Else, sets the default vertical alignment for items in this list.

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/height.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/height.html index 9daed63125..1ecc9961e9 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/height.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/height.html @@ -63,7 +63,7 @@

height

-
val height: Constraint
+
val height: Constraint

Sets whether the list's height will wrap its contents (Constraint.Wrap) or match the height of its parent (Constraint.Fill).

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/index.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/index.html index 3069148765..7bf6f34b75 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/index.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/index.html @@ -98,7 +98,7 @@

Properties

-
val crossAxisAlignment: CrossAxisAlignment
+
val crossAxisAlignment: CrossAxisAlignment

If isVertical, sets the default horizontal alignment for items in this list. Else, sets the default vertical alignment for items in this list.

@@ -113,7 +113,7 @@

Properties

-
val height: Constraint
+
val height: Constraint

Sets whether the list's height will wrap its contents (Constraint.Wrap) or match the height of its parent (Constraint.Fill).

@@ -128,7 +128,7 @@

Properties

-
val isVertical: Boolean
+
val isVertical: Boolean

Whether the list should be vertically oriented.

@@ -143,7 +143,7 @@

Properties

-
val items: () -> Unit
+
val items: () -> Unit

The window of items to be inflated by the native lazy list widget implementation. The window is defined as a sequential subset of the composables emitted in items. These composables are created by incrementally passing a range of indices to the user-defined item factories, as specified in the LazyListScope functions.

@@ -158,7 +158,7 @@

Properties

-
val itemsAfter: Int
+
val itemsAfter: Int

The number of un-emitted items after the items window.

@@ -173,7 +173,7 @@

Properties

-
val itemsBefore: Int
+
val itemsBefore: Int

The number of un-emitted items before the items window.

@@ -188,7 +188,7 @@

Properties

-
val margin: Margin
+
val margin: Margin

Applies margin (space) around the list.

@@ -203,7 +203,7 @@

Properties

-
val onRefresh: () -> Unit?
+
val onRefresh: () -> Unit?

Called when a swipe gesture triggers a pull-to-refresh.

@@ -218,7 +218,7 @@

Properties

-
val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit
+
val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit

Invoked when the user has scrolled the list, such that the firstVisibleItemIndex or the lastVisibleItemIndex has changed. When the user performs a fling, onViewportChanged will be invoked multiple times.

@@ -233,7 +233,7 @@

Properties

-
val placeholder: () -> Unit
+
val placeholder: () -> Unit

A block which describes the content of each placeholder item.

@@ -248,7 +248,7 @@

Properties

-
val pullRefreshContentColor: UInt
+
val pullRefreshContentColor: UInt

The color of the pull-to-refresh indicator as an ARGB color int.

@@ -263,7 +263,7 @@

Properties

-
val refreshing: Boolean
+
val refreshing: Boolean

Whether or not the list should show the pull-to-refresh indicator.

@@ -278,7 +278,7 @@

Properties

-
val scrollItemIndex: ScrollItemIndex
+
val scrollItemIndex: ScrollItemIndex

The last ScrollItemIndex programmatically requested by the user. The native lazy list widget implementation will scroll itself such that the item index will be at the start of the viewport.

@@ -293,7 +293,7 @@

Properties

-
val width: Constraint
+
val width: Constraint

Sets whether the list's width will wrap its contents (Constraint.Wrap) or match the width of its parent (Constraint.Fill).

diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/is-vertical.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/is-vertical.html index 00391d2050..54c8a91852 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/is-vertical.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/is-vertical.html @@ -63,7 +63,7 @@

isVertical

-
val isVertical: Boolean
+
val isVertical: Boolean

Whether the list should be vertically oriented.

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items-after.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items-after.html index ec643f0538..253bef1de9 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items-after.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items-after.html @@ -63,7 +63,7 @@

itemsAfter

-
val itemsAfter: Int
+
val itemsAfter: Int

The number of un-emitted items after the items window.

See also

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items-before.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items-before.html index cfe14fe71a..0af7b4f73b 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items-before.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items-before.html @@ -63,7 +63,7 @@

itemsBefore

-
val itemsBefore: Int
+
val itemsBefore: Int

The number of un-emitted items before the items window.

See also

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items.html index 240d755464..63c96b98f7 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/items.html @@ -63,7 +63,7 @@

items

-
val items: () -> Unit
+
val items: () -> Unit

The window of items to be inflated by the native lazy list widget implementation. The window is defined as a sequential subset of the composables emitted in items. These composables are created by incrementally passing a range of indices to the user-defined item factories, as specified in the LazyListScope functions.

The window should be offset by itemsAfter, and should have a size of count - [itemsBefore] - [itemsAfter], where count is the total number of items that theoretically exists in the list.

This field should not be confused with LazyListScope.items (et al.) The functions in LazyListScope specify what the list theoretically consists of. This property specifies what the list practically consists of, as a function of the current view port. This difference is what distinguishes the LazyRow and LazyColumn widgets from their non-lazy counterparts (Row and Column).

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/margin.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/margin.html index 71279abc71..e44cf9dd12 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/margin.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/margin.html @@ -63,7 +63,7 @@

margin

-
val margin: Margin
+
val margin: Margin

Applies margin (space) around the list.

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/on-refresh.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/on-refresh.html index 1d24e55f41..9d4d4a39fe 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/on-refresh.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/on-refresh.html @@ -63,7 +63,7 @@

onRefresh

-
val onRefresh: () -> Unit?
+
val onRefresh: () -> Unit?

Called when a swipe gesture triggers a pull-to-refresh.

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/on-viewport-changed.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/on-viewport-changed.html index 770e858167..8c90ae76d6 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/on-viewport-changed.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/on-viewport-changed.html @@ -63,7 +63,7 @@

onViewportChanged

-
val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit
+
val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit

Invoked when the user has scrolled the list, such that the firstVisibleItemIndex or the lastVisibleItemIndex has changed. When the user performs a fling, onViewportChanged will be invoked multiple times.

The firstVisibleItemIndex is the index of the first partially visible item within the viewport. The lastVisibleItemIndex is the index of the last partially visible item within the viewport.

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/placeholder.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/placeholder.html index cbaa4390a1..41f3b592a5 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/placeholder.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/placeholder.html @@ -63,7 +63,7 @@

placeholder

-
val placeholder: () -> Unit
+
val placeholder: () -> Unit

A block which describes the content of each placeholder item.

See also

app.cash.redwood.lazylayout.compose.LazyRow
© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/pull-refresh-content-color.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/pull-refresh-content-color.html index 892be06ad8..63d108776b 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/pull-refresh-content-color.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/pull-refresh-content-color.html @@ -63,7 +63,7 @@

pullRefreshContentColor

-
val pullRefreshContentColor: UInt
+
val pullRefreshContentColor: UInt

The color of the pull-to-refresh indicator as an ARGB color int.

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/refreshing.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/refreshing.html index 1f91930679..2fce5bfb36 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/refreshing.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/refreshing.html @@ -63,7 +63,7 @@

refreshing

-
val refreshing: Boolean
+
val refreshing: Boolean

Whether or not the list should show the pull-to-refresh indicator.

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/scroll-item-index.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/scroll-item-index.html index 8250deb236..a77bf9ee35 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/scroll-item-index.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/scroll-item-index.html @@ -63,7 +63,7 @@

scrollItemIndex

-
val scrollItemIndex: ScrollItemIndex
+
val scrollItemIndex: ScrollItemIndex

The last ScrollItemIndex programmatically requested by the user. The native lazy list widget implementation will scroll itself such that the item index will be at the start of the viewport.

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/width.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/width.html index 9f7a554cdd..841f6b2f8b 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/width.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/-refreshable-lazy-list/width.html @@ -63,7 +63,7 @@

width

-
val width: Constraint
+
val width: Constraint

Sets whether the list's width will wrap its contents (Constraint.Wrap) or match the width of its parent (Constraint.Fill).

© 2024 CopyrightGenerated by dokka diff --git a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/index.html b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/index.html index 6cf6e448bd..45a5b5d6f9 100644 --- a/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/index.html +++ b/latest/docs/redwood-lazylayout-schema/app.cash.redwood.lazylayout/index.html @@ -78,7 +78,7 @@

Types

-
data class LazyList(val isVertical: Boolean, val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit, val itemsBefore: Int, val itemsAfter: Int, val width: Constraint, val height: Constraint, val margin: Margin, val crossAxisAlignment: CrossAxisAlignment, val scrollItemIndex: ScrollItemIndex, val placeholder: () -> Unit, val items: () -> Unit)
+
data class LazyList(val isVertical: Boolean, val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit, val itemsBefore: Int, val itemsAfter: Int, val width: Constraint, val height: Constraint, val margin: Margin, val crossAxisAlignment: CrossAxisAlignment, val scrollItemIndex: ScrollItemIndex, val placeholder: () -> Unit, val items: () -> Unit)

The documentation for LazyList is a subset of the documentation for RefreshableLazyList. In order to avoid documentation duplication, see LazyList. The documentation should be unified once https://github.com/cashapp/redwood/issues/1084 is implemented and RefreshableLazyList has been deprecated and removed.