-
-
Notifications
You must be signed in to change notification settings - Fork 364
Add a note about using raw data attributes as a prefered way #1336
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -57,14 +57,27 @@ directory. In fact, you should have an example controller there already: ``hello | |
} | ||
} | ||
|
||
Use the Twig functions from this bundle to activate your controllers: | ||
Then, activate the controller in your HTML: | ||
|
||
.. code-block:: html+twig | ||
|
||
<div data-controller="hello"> | ||
... | ||
</div> | ||
|
||
Optionally, this bundle has a Twig function to render the attribute: | ||
|
||
.. code-block:: html+twig | ||
|
||
<div {{ stimulus_controller('hello') }}> | ||
... | ||
</div> | ||
|
||
<!-- would render --> | ||
<div data-controller="hello"> | ||
... | ||
</div> | ||
|
||
That's it! Whenever this element appears on the page, the ``hello`` controller | ||
will activate. | ||
|
||
|
@@ -159,6 +172,17 @@ Stimulus Twig Helpers | |
This bundle adds 3 Twig functions/filters to help add Stimulus controllers, | ||
actions & targets in your templates. | ||
|
||
.. note:: | ||
|
||
Though this bundle provides these helpful Twig functions/filters, it's | ||
recommended to use raw data attributes instead, as they're straightforward. | ||
|
||
.. tip:: | ||
|
||
If you use PhpStorm IDE - you may want to install | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would add this phrase as a tip bloc :) |
||
[Stimulus plugin](https://plugins.jetbrains.com/plugin/18940-stimulus) | ||
to get nice auto-completion for the attributes. | ||
|
||
stimulus_controller | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
|
@@ -243,6 +267,11 @@ there's also a ``stimulus_controller`` filter: | |
Hello | ||
</div> | ||
|
||
<!-- would render --> | ||
<div data-controller="chart other-controller" data-chart-name-value="Likes"> | ||
Hello | ||
</div> | ||
|
||
You can also retrieve the generated attributes as an array, which can be helpful e.g. for forms: | ||
|
||
.. code-block:: twig | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should update a bit more, starting with the "Use the Twig functions..." line. Something like:
(show the raw
data-controller
example).Then after, something like:
Optionally, this bundle has a Twig function to render the attribute:
(show the
stimulus_controller()
)