Skip to content

Commit bd1e53e

Browse files
committed
Revert "[#3338] Removing delete_empty details because this is first being committed to 2.3"
This re-introduces the delete_empty documentation to the master (2.5) branch, since it should live there. This reverts commit 72fa7b4.
1 parent 7112444 commit bd1e53e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

reference/forms/types/collection.rst

+11
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ forms, which is useful when creating forms that expose one-to-many relationships
1919
| | - `allow_delete`_ |
2020
| | - `prototype`_ |
2121
| | - `prototype_name`_ |
22+
| | - `delete_empty`_ |
2223
+-------------+-----------------------------------------------------------------------------+
2324
| Inherited | - `label`_ |
2425
| | - `label_attr`_ |
@@ -335,6 +336,16 @@ If you have several collections in your form, or worse, nested collections
335336
you may want to change the placeholder so that unrelated placeholders are not
336337
replaced with the same value.
337338

339+
delete_empty
340+
~~~~~~~~~~~~
341+
342+
**type**: ``Boolean`` **default**: ``false``
343+
344+
If you want to explicitly remove entirely empty collection entries from your
345+
form you have to set this option to true. However, existing collection entries
346+
will only be deleted if you have the allow_delete_ option enabled. Otherwise
347+
the empty values will be kept.
348+
338349
Inherited options
339350
-----------------
340351

0 commit comments

Comments
 (0)