Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #844: Add documentation for component replacement #874

Merged
merged 1 commit into from
Mar 20, 2024

Conversation

rylin8
Copy link
Collaborator

@rylin8 rylin8 commented Mar 15, 2024

Explain what is in the updated ComponentReplacementContext class and how to use with non-DesignCompose replacement composables.

@rylin8
Copy link
Collaborator Author

rylin8 commented Mar 15, 2024

Here's what the updated section looks like
Screenshot 2024-03-15 at 9 56 31 AM

Copy link

github-actions bot commented Mar 15, 2024

Snapshot diff report vs base branch: main
Last updated: Wed Mar 20 14:10:31 PDT 2024, Sha: 3fe17de
No differences detected

Base automatically changed from wb/rylin/replacement-crash to main March 18, 2024 15:56
@rylin8 rylin8 force-pushed the wb/rylin/documentation branch from a10f7b3 to 73f8a09 Compare March 18, 2024 15:59
Copy link
Member

@timothyfroehlich timothyfroehlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Component replacement deserves more of a write-up with a more clear use case and images of the Figma File and what the rendered result would be, but we can get away with what we have here.

Generally, the documentation has gotten garbled in all of the transitions from when we originally wrote it. We need a bit more of a rewrite, and as I mentioned in the comments, it should start more simply, without mentioning the ComponentReplacementContext. Describe the CRC and why you'd need it after the simple example.

docs/_docs/modifiers/modifiers.md Show resolved Hide resolved
docs/_docs/modifiers/modifiers.md Outdated Show resolved Hide resolved
docs/_docs/modifiers/modifiers.md Outdated Show resolved Hide resolved
docs/_docs/modifiers/modifiers.md Outdated Show resolved Hide resolved
docs/_docs/modifiers/modifiers.md Outdated Show resolved Hide resolved
docs/_docs/modifiers/modifiers.md Outdated Show resolved Hide resolved
@timothyfroehlich
Copy link
Member

@Gurupreet Could you take a look at this as well?

@rylin8 rylin8 force-pushed the wb/rylin/documentation branch from 73f8a09 to d34aad8 Compare March 19, 2024 18:25
@rylin8 rylin8 requested a review from timothyfroehlich March 19, 2024 18:26
docs/_docs/modifiers/modifiers.md Outdated Show resolved Hide resolved
docs/_docs/modifiers/modifiers.md Show resolved Hide resolved
Explain what is in the updated ComponentReplacementContext class and how to use with non-DesignCompose replacement composables.
@rylin8 rylin8 force-pushed the wb/rylin/documentation branch from d34aad8 to 3fe17de Compare March 20, 2024 21:03
@rylin8 rylin8 added this pull request to the merge queue Mar 20, 2024
Merged via the queue into main with commit 8f43291 Mar 20, 2024
31 checks passed
@rylin8 rylin8 deleted the wb/rylin/documentation branch March 20, 2024 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants