[TwigComponent] make public component properties available directly #232
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
kbond
force-pushed
the
feature/public-component-props
branch
from
2a67668 to
c3569da
Compare
weaverryan
reviewed
Jan 21, 2022
Member
weaverryan
left a comment
weaverryan
left a comment
There was a problem hiding this comment.
This seems very practical. There are a few more examples in the TwigComponent docs and many examples in LiveComponents. I think we should lean in and prefer the short version 90%+ of the time.
kbond
force-pushed
the
feature/public-component-props
branch
from
c3569da to
964b9bd
Compare
Member
Author
|
Rebased to pickup the new doc format and I think I updated all the applicable |
Member
|
Thanks Kevin! |
This was referenced Jan 21, 2022
1 task
weaverryan
added a commit
that referenced
this pull request
Feb 14, 2022
This PR was squashed before being merged into the 2.x branch. Discussion ---------- [Twig] add `ExposeInTemplate` attribute | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | Tickets | n/a | License | MIT #232 made all of a component's public properties available directly (without the `this.`) in it's template. This adds an `ExposeInTemplate` attribute to make non-public properties available in this way. Example: ```php use Symfony\UX\TwigComponent\Attribute\ExposeInTemplate; #[AsTwigComponent('with_exposed_variables')] final class WithExposedVariables { #[ExposeInTemplate] private string $prop1; // available as `{{ prop1 }}` #[ExposeInTemplate('customProp')] private string $prop2; // available as `{{ customProp }}` #[ExposeInTemplate(name: 'ico', getter: 'fetchIcon')] private string $icon = 'ico-warning'; // available as `{{ ico }}` in the template using `fetchIcon()` as the getter /** * Required to access $prop1 */ public function getProp1(): string { return $this->prop1; } /** * Required to access $prop1 */ public function getProp2(): string { return $this->prop2; } /** * Required to access $this->icon */ public function fetchIcon(): string { return $this->icon; } } ``` **TODO:** - [x] use to expose `form` in `ComponentWithFormTrait` (requires #254) Commits ------- e6c53fd [Twig] add `ExposeInTemplate` attribute
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This makes all public properties available directly in your component template. Assuming your component has a public property
foo: