Skip to content

Commit 4d229a6

Browse files
committed
minor #8635 clarify allowed property path value types (xabbuh)
This PR was merged into the master branch. Discussion ---------- clarify allowed property path value types fixes #8627 ping @javiereguiluz Commits ------- 7d33abb clarify allowed property path value types
2 parents e92386c + 7d33abb commit 4d229a6

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed
Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
property_path
22
~~~~~~~~~~~~~
33

4-
**type**: ``any`` **default**: ``the field's name``
4+
**type**: ``PropertyPathInterface|string|null`` **default**: ``null``
55

66
Fields display a property value of the form's domain object by default.
77
When the form is submitted, the submitted value is written back into the
88
object.
99
1010
If you want to override the property that a field reads from and writes
11-
to, you can set the ``property_path`` option. Its default value is the field's
12-
name.
13-
14-
If you wish the field to be ignored when reading or writing to the object
15-
you can set the ``property_path`` option to ``false``, but using
16-
``property_path`` for this purpose is deprecated, you should use the
17-
``mapped`` option.
11+
to, you can set the ``property_path`` option. Its default value (``null``)
12+
will use the field's name as the property.

0 commit comments

Comments
 (0)