Skip to content

Commit 9068288

Browse files
author
Dorian Sarnowski
committed
[#2362] Documentation for label_attr option in Form Compontent
1 parent 7c038bf commit 9068288

26 files changed

+98
-0
lines changed

‎reference/forms/types/button.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ A simple, non-responsive button.
1515
| Options | - `attr`_ |
1616
| | - `disabled`_ |
1717
| | - `label`_ |
18+
| | - `label_attr`_ |
1819
| | - `translation_domain`_ |
1920
+----------------------+----------------------------------------------------------------------+
2021
| Parent type | none |
@@ -31,4 +32,6 @@ Options
3132

3233
.. include:: /reference/forms/types/options/button_label.rst.inc
3334

35+
.. include:: /reference/forms/types/options/label_attr.rst.inc
36+
3437
.. include:: /reference/forms/types/options/button_translation_domain.rst.inc

‎reference/forms/types/checkbox.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ if the box is unchecked, the value will be set to false.
1616
| Inherited | - `data`_ |
1717
| options | - `required`_ |
1818
| | - `label`_ |
19+
| | - `label_attr`_ |
1920
| | - `read_only`_ |
2021
| | - `disabled`_ |
2122
| | - `error_bubbling`_ |
@@ -63,6 +64,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
6364

6465
.. include:: /reference/forms/types/options/label.rst.inc
6566

67+
.. include:: /reference/forms/types/options/label_attr.rst.inc
68+
6669
.. include:: /reference/forms/types/options/read_only.rst.inc
6770

6871
.. include:: /reference/forms/types/options/disabled.rst.inc

‎reference/forms/types/choice.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ option.
2222
+-------------+------------------------------------------------------------------------------+
2323
| Inherited | - `required`_ |
2424
| options | - `label`_ |
25+
| | - `label_attr`_ |
2526
| | - `read_only`_ |
2627
| | - `disabled`_ |
2728
| | - `error_bubbling`_ |
@@ -116,6 +117,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
116117

117118
.. include:: /reference/forms/types/options/label.rst.inc
118119

120+
.. include:: /reference/forms/types/options/label_attr.rst.inc
121+
119122
.. include:: /reference/forms/types/options/read_only.rst.inc
120123

121124
.. include:: /reference/forms/types/options/disabled.rst.inc

‎reference/forms/types/collection.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ forms, which is useful when creating forms that expose one-to-many relationships
2121
| | - `prototype_name`_ |
2222
+-------------+-----------------------------------------------------------------------------+
2323
| Inherited | - `label`_ |
24+
| | - `label_attr`_ |
2425
| options | - `error_bubbling`_ |
2526
| | - `error_mapping`_ |
2627
| | - `by_reference`_ |
@@ -341,6 +342,8 @@ Not all options are listed here - only the most applicable to this type:
341342

342343
.. include:: /reference/forms/types/options/label.rst.inc
343344

345+
.. include:: /reference/forms/types/options/label_attr.rst.inc
346+
344347
.. include:: /reference/forms/types/options/mapped.rst.inc
345348

346349
.. include:: /reference/forms/types/options/error_mapping.rst.inc

‎reference/forms/types/country.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ you should just use the ``choice`` type directly.
3333
| | - `error_mapping`_ |
3434
| | - `required`_ |
3535
| | - `label`_ |
36+
| | - `label_attr`_ |
3637
| | - `read_only`_ |
3738
| | - `disabled`_ |
3839
| | - `mapped`_ |
@@ -76,6 +77,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
7677

7778
.. include:: /reference/forms/types/options/label.rst.inc
7879

80+
.. include:: /reference/forms/types/options/label_attr.rst.inc
81+
7982
.. include:: /reference/forms/types/options/read_only.rst.inc
8083

8184
.. include:: /reference/forms/types/options/disabled.rst.inc

‎reference/forms/types/currency.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ should just use the ``choice`` type directly.
2626
| | - `error_bubbling`_ |
2727
| | - `required`_ |
2828
| | - `label`_ |
29+
| | - `label_attr`_ |
2930
| | - `read_only`_ |
3031
| | - `disabled`_ |
3132
| | - `mapped`_ |
@@ -66,6 +67,8 @@ These options inherit from the :doc:`date</reference/forms/types/form>` type:
6667

6768
.. include:: /reference/forms/types/options/label.rst.inc
6869

70+
.. include:: /reference/forms/types/options/label_attr.rst.inc
71+
6972
.. include:: /reference/forms/types/options/read_only.rst.inc
7073

7174
.. include:: /reference/forms/types/options/disabled.rst.inc

‎reference/forms/types/email.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The ``email`` field is a text field that is rendered using the HTML5
1313
| Inherited | - `max_length`_ |
1414
| options | - `required`_ |
1515
| | - `label`_ |
16+
| | - `label_attr`_ |
1617
| | - `trim`_ |
1718
| | - `read_only`_ |
1819
| | - `disabled`_ |
@@ -36,6 +37,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
3637

3738
.. include:: /reference/forms/types/options/label.rst.inc
3839

40+
.. include:: /reference/forms/types/options/label_attr.rst.inc
41+
3942
.. include:: /reference/forms/types/options/trim.rst.inc
4043

4144
.. include:: /reference/forms/types/options/read_only.rst.inc

‎reference/forms/types/entity.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ objects from the database.
2323
+-------------+------------------------------------------------------------------+
2424
| Inherited | - `required`_ |
2525
| options | - `label`_ |
26+
| | - `label_attr`_ |
2627
| | - `multiple`_ |
2728
| | - `expanded`_ |
2829
| | - `preferred_choices`_ |
@@ -190,6 +191,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
190191

191192
.. include:: /reference/forms/types/options/label.rst.inc
192193

194+
.. include:: /reference/forms/types/options/label_attr.rst.inc
195+
193196
.. include:: /reference/forms/types/options/read_only.rst.inc
194197

195198
.. include:: /reference/forms/types/options/disabled.rst.inc

‎reference/forms/types/file.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The ``file`` type represents a file input in your form.
1111
+-------------+---------------------------------------------------------------------+
1212
| Inherited | - `required`_ |
1313
| options | - `label`_ |
14+
| | - `label_attr`_ |
1415
| | - `read_only`_ |
1516
| | - `disabled`_ |
1617
| | - `error_bubbling`_ |
@@ -85,6 +86,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
8586

8687
.. include:: /reference/forms/types/options/label.rst.inc
8788

89+
.. include:: /reference/forms/types/options/label_attr.rst.inc
90+
8891
.. include:: /reference/forms/types/options/read_only.rst.inc
8992

9093
.. include:: /reference/forms/types/options/disabled.rst.inc

‎reference/forms/types/form.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ on all fields.
1313

1414
.. include:: /reference/forms/types/options/required.rst.inc
1515

16+
.. include:: /reference/forms/types/options/label.rst.inc
17+
18+
.. include:: /reference/forms/types/options/label_attr.rst.inc
19+
1620
.. include:: /reference/forms/types/options/constraints.rst.inc
1721

1822
.. include:: /reference/forms/types/options/cascade_validation.rst.inc

0 commit comments

Comments
 (0)