Skip to content

Document how to define mandatory/default props #3132

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.

Sign up for GitHub

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 1 commit into from
Oct 17, 2025
+17 −2
Merged

Document how to define mandatory/default props #3132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions src/TwigComponent/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,12 +700,14 @@ You can also pass a variable (prop) into your template:
</div>

To tell the system that ``icon`` and ``type`` are props and not attributes, use the
``{% props %}`` tag at the top of your template.
``{% props %}`` tag at the top of your template. Props are required by default, but
it is possible to set a default value with ``=``:

.. code-block:: html+twig

{# templates/components/Button.html.twig #}
{% props icon = null, type = 'primary' %}
{# prop "icon" is required, but prop "type" has a default value to "primary" #}
{% props icon, type = 'primary' %}

<button {{ attributes.defaults({class: 'btn btn-'~type}) }}>
{% block content %}{% endblock %}
Expand All @@ -714,6 +716,19 @@ To tell the system that ``icon`` and ``type`` are props and not attributes, use
{% endif %}
</button>

Examples of usage:

.. code-block:: html+twig

{# property "icon" is missing, an exception is thrown #}
<twig:Button>Share</twig:Button>

{# property "icon" is passed, property "type" use its default value "primary" #}
<twig:Button icon="share">Share</twig:Button>

{# both properties "icon" and "type" are passed #}
<twig:Button icon="share" type="secondary>Share</twig:Button>

.. _embedded-components:

Passing HTML to Components Via Blocks
Expand Down