[LiveComponent] Add doc about the placeholder macro #1549
Merged
Conversation
This file contains hidden or 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
weaverryan
reviewed
Feb 26, 2024
src/LiveComponent/doc/index.rst
Outdated
| To change the initial tag from a ``div`` to something else, use the ``loading-tag`` option: | ||
| Both ``loading-template`` and ``loadingContent`` can be used in the template | ||
| _calling_ the component. But if want to set this content only once, you can add a | ||
| ``placeholder`` macro directly in the component template. |
There was a problem hiding this comment.
macro called placeholder
that makes it more clear that placeholder with name vs placeholder is an adjective
src/LiveComponent/doc/index.rst
Outdated
|
|
||
| If you style the placeholder content (giving the rows a specific height), | ||
| you can then avoid layout shifts when the component is fully loaded (and | ||
| the loading content replaced by the real content). |
There was a problem hiding this comment.
I think it’s a bit too long - the first example is probably enough.
Also, I’m wondering if this should license the FIRST option of customizing loading content. I’d imagine that I would more often embed the loading content inside the template vs in the calling template.
so logic would be:
- to customize loading, you can add this macro
- Else, if you want to control loading when calling the component, use the block trick.
- And, btw, you can control the loading tag for edge cases, like when your element is a tr
There was a problem hiding this comment.
I've reordered all .. tell me if better
weaverryan
force-pushed
the
doc/live-placeholder-macro
branch
from
349505a to
a7c2cb3
Compare
|
Very nice - thank you Simon! |
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.
Add documentation about #1532 (placeholder macro)