Document the lazy layout widget definitions #1773
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dellisd
approved these changes
Jan 16, 2024
redwood-lazylayout-schema/src/main/kotlin/app/cash/redwood/lazylayout/widgets.kt
Outdated
Show resolved
Hide resolved
redwood-lazylayout-schema/src/main/kotlin/app/cash/redwood/lazylayout/widgets.kt
Outdated
Show resolved
Hide resolved
swankjesse
reviewed
Jan 16, 2024
redwood-lazylayout-schema/src/main/kotlin/app/cash/redwood/lazylayout/widgets.kt
Outdated
Show resolved
Hide resolved
swankjesse
approved these changes
Jan 16, 2024
redwood-lazylayout-schema/src/main/kotlin/app/cash/redwood/lazylayout/widgets.kt
Outdated
Show resolved
Hide resolved
redwood-lazylayout-schema/src/main/kotlin/app/cash/redwood/lazylayout/widgets.kt
Show resolved
Hide resolved
… instead of duplicating the docs
…zyList` instead of duplicating the docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Unlike #1771, which documents the public API of
LazyColumn/LazyRow, this documents the internal widget API, so that the guest-host bridge for lazy list can be better understood. Some properties are identical to the already-documented public facing API, so I've been deliberately light on the documentation here. However, some properties are unique (namelyitemsBefore,itemsAfter, anditems) so I wanted to document them a bit better.If anything seems unclear or worthy of expansion, please lmk!