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

[Turbo] Document <twig:Turbo:Stream:*> #2481

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from

Conversation

seb-jean
Copy link
Contributor

@seb-jean seb-jean commented Jan 3, 2025

Hi,

I added docs for #2227.

I will document <twig:Turbo:Stream> in a second phase.

What do you think? Do you have any suggestions?

@carsonbot carsonbot added Turbo Status: Needs Review Needs to be reviewed labels Jan 3, 2025
</twig:Turbo:Stream:Append>

{# renders as: #}
<turbo-stream action="append" targets="#dom_id">
Copy link
Member

Choose a reason for hiding this comment

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

target or targets?

Copy link
Member

Choose a reason for hiding this comment

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

(same comment applies for other examples)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

target becomes targets

Stream Messages and Actions
^^^^^^^^^^^^^^^^^^^^^^^^^^^

To render a ``<turbo-stream>`` element, we recommend using the ``<twig:Turbo:Stream:*>`` Twig Component to avoid typos.
Copy link
Member

Choose a reason for hiding this comment

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

Is this the only reason we added Turbo:Stream:* components?

@Kocal
Copy link
Member

Kocal commented Jan 5, 2025

Status: Needs work

@carsonbot carsonbot added Status: Needs Work Additional work is needed and removed Status: Needs Review Needs to be reviewed labels Jan 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Work Additional work is needed Turbo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants