Minor clarifications to TwigComponent doc examples #242
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
|
Hi there! Ah, this is tricky. The reason the documentation doesn't work is that you CAN now access local variables, but that feature has not been released yet :/. I think what we SHOULD do is clarify the version this stuff is available in. So what we're missing is: .. versionadded:: 2.1
The ability to reference local variables in the template (e.g. ``message``) was added in TwigComponents 2.1.
Previously, all data needed to be referenced through ``this`` (e.g. ``this.message``).That would hopefully give a hint of a feature doesn't work. |
|
Ah that would explain things! Thanks for the clarification! I'll close this PR in favor of #244 then 👍 |
weaverryan
added a commit
that referenced
this pull request
Jan 25, 2022
…public props (kbond) This PR was merged into the 2.x branch. Discussion ---------- [TwigComponent][LiveComponent] clarify excluding this for public props | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Tickets | Fix #242 | License | MIT Commits ------- 69207a0 [TwigComponent][LiveComponent] clarify excluding this for public props
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.
The examples I've touched sounded a bit misleading to me at first comparing to the Live Component package. Having something available as
{{ message }}isn't possible since an error is thrown since it's not a property nor does it exist in themount()method. I feel like examples should just make thethisvariable very clear.