Skip to content

Allow to add custom HTML attributes on buttons #298

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

Open
Florian-B wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow to add custom HTML attributes on buttons #298

Show file tree
Hide file tree
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,23 @@ Example:
} %}
```

Always in the same way, you can add custom HTML attributes:

- `craue_formflow_button_attr_last` for either the __next__ or __finish__ button
- `craue_formflow_button_attr_finish` for the __finish__ button
- `craue_formflow_button_attr_next` for the __next__ button
- `craue_formflow_button_attr_back` for the __back__ button
- `craue_formflow_button_attr_reset` for the __reset__ button

Example:

```twig
{% include '@CraueFormFlow/FormFlow/buttons.html.twig' with {
craue_formflow_button_attr_finish: {'data-foo': 'bar'},
craue_formflow_button_attr_reset: {'data-foo': 'bar', 'data-bar': 'foo'},
} %}
```

You can also remove the reset button by setting `craue_formflow_button_render_reset` to `false`.

## Create an action
Expand Down
11 changes: 10 additions & 1 deletion Resources/views/FormFlow/buttons.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,19 @@
? craue_formflow_button_class_finish | default(craue_formflow_button_class_last)
: craue_formflow_button_class_next | default(craue_formflow_button_class_last)
-%}
{%- set craue_formflow_button_attr_last = craue_formflow_button_attr_last | default([]) -%}
{%- set craue_formflow_button_attr_last = isLastStep
? craue_formflow_button_attr_finish | default(craue_formflow_button_attr_last)
: craue_formflow_button_attr_next | default(craue_formflow_button_attr_last)
-%}
{%- set craue_buttons = [
{
label: craue_formflow_button_label_last | default(isLastStep ? craue_formflow_button_label_finish | default('button.finish') : craue_formflow_button_label_next | default('button.next')),
render: true,
attr: {
class: craue_formflow_button_class_last,
},
custom_attr: craue_formflow_button_attr_last|default([]),
},
{
label: craue_formflow_button_label_back | default('button.back'),
Expand All @@ -31,6 +37,7 @@
value: 'back',
formnovalidate: 'formnovalidate',
},
custom_attr: craue_formflow_button_attr_back|default([]),
},
{
label: craue_formflow_button_label_reset | default('button.reset'),
Expand All @@ -41,11 +48,13 @@
value: 'reset',
formnovalidate: 'formnovalidate',
},
custom_attr: craue_formflow_button_attr_reset|default([]),
},
] -%}

{% for button in craue_buttons if button.render %}
<button type="submit"{% for key, value in button.attr %} {{ key }}="{{ value }}"{% endfor %}>
{% set button_attr = button.attr|merge(button.custom_attr) %}
<button type="submit"{% for key, value in button_attr %} {{ key }}="{{ value }}"{% endfor %}>
{{- button.label | trans({}, 'CraueFormFlowBundle') -}}
</button>
{% endfor %}
Expand Down
56 changes: 56 additions & 0 deletions Tests/Resources/TemplateRenderingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,21 @@ public function dataCustomizedButton() {
array('craue_formflow_button_class_next' => 'next'),
'<button type="submit" class="next">next</button>',
),
'next button custom attr without class' => array(
2, 1,
array('craue_formflow_button_attr_next' => array('data-foo' => 'bar')),
'<button type="submit" class="craue_formflow_button_last" data-foo="bar">next</button>',
),
'next button custom attr with class' => array(
2, 1,
array('craue_formflow_button_class_next' => 'next', 'craue_formflow_button_attr_next' => array('data-foo' => 'bar')),
'<button type="submit" class="next" data-foo="bar">next</button>',
),
'next button two custom attr with class' => array(
2, 1,
array('craue_formflow_button_class_next' => 'next', 'craue_formflow_button_attr_next' => array('data-foo' => 'bar', 'data-bar' => 'foo')),
'<button type="submit" class="next" data-foo="bar" data-bar="foo">next</button>',
),
'next button custom label' => array(
2, 1,
array('craue_formflow_button_label_next' => 'custom next'),
Expand All @@ -148,6 +163,16 @@ public function dataCustomizedButton() {
array('craue_formflow_button_class_finish' => 'finish'),
'<button type="submit" class="finish">finish</button>',
),
'finish button custom attr without class' => array(
1, 1,
array('craue_formflow_button_attr_finish' => array('data-foo' => 'bar')),
'<button type="submit" class="craue_formflow_button_last" data-foo="bar">finish</button>',
),
'finish button custom attr with class' => array(
1, 1,
array('craue_formflow_button_class_finish' => 'finish', 'craue_formflow_button_attr_finish' => array('data-foo' => 'bar')),
'<button type="submit" class="finish" data-foo="bar">finish</button>',
),
'finish button custom label' => array(
1, 1,
array('craue_formflow_button_label_finish' => 'custom finish'),
Expand All @@ -168,6 +193,16 @@ public function dataCustomizedButton() {
array('craue_formflow_button_class_last' => 'last'),
'<button type="submit" class="last">next</button>',
),
'last button custom attr without class (next)' => array(
2, 1,
array('craue_formflow_button_class_last' => 'last', 'craue_formflow_button_attr_last' => array('data-foo' => 'bar')),
'<button type="submit" class="last" data-foo="bar">next</button>',
),
'last button custom attr with class (next)' => array(
2, 1,
array('craue_formflow_button_attr_last' => array('data-foo' => 'bar')),
'<button type="submit" class="craue_formflow_button_last" data-foo="bar">next</button>',
),
'last button custom label (next)' => array(
2, 1,
array('craue_formflow_button_label_last' => 'custom last'),
Expand All @@ -178,6 +213,16 @@ public function dataCustomizedButton() {
array('craue_formflow_button_class_back' => 'back'),
'<button type="submit" class="back" name="flow_renderingTest_transition" value="back" formnovalidate="formnovalidate">back</button>',
),
'back button custom attr without class' => array(
2, 2,
array('craue_formflow_button_attr_back' => array('data-foo' => 'bar')),
'<button type="submit" class="" name="flow_renderingTest_transition" value="back" formnovalidate="formnovalidate" data-foo="bar">back</button>',
),
'back button custom attr with class' => array(
2, 2,
array('craue_formflow_button_class_back' => 'back', 'craue_formflow_button_attr_back' => array('data-foo' => 'bar')),
'<button type="submit" class="back" name="flow_renderingTest_transition" value="back" formnovalidate="formnovalidate" data-foo="bar">back</button>',
),
'back button custom label' => array(
2, 2,
array('craue_formflow_button_label_back' => 'custom back'),
Expand All @@ -188,6 +233,17 @@ public function dataCustomizedButton() {
array('craue_formflow_button_class_reset' => 'reset'),
'<button type="submit" class="reset" name="flow_renderingTest_transition" value="reset" formnovalidate="formnovalidate">start over</button>',
),
'reset button custom attr without class' => array(
1, 1,
array('craue_formflow_button_attr_reset' => array('data-foo' => 'bar')),
'<button type="submit" class="craue_formflow_button_first" name="flow_renderingTest_transition" value="reset" formnovalidate="formnovalidate" data-foo="bar">start over</button>',
),
'reset button custom attr with class' => array(
1, 1,
array('craue_formflow_button_class_reset' => 'reset', 'craue_formflow_button_attr_reset' => array('data-foo' => 'bar')),
'<button type="submit" class="reset" name="flow_renderingTest_transition" value="reset" formnovalidate="formnovalidate" data-foo="bar">start over</button>',

),
'reset button custom label' => array(
1, 1,
array('craue_formflow_button_label_reset' => 'custom reset'),
Expand Down