doc

Author: mbuliard

src/LiveComponent/doc/index.rst

@@ -2677,6 +2677,46 @@ It can be used to perform more generic operations inside of the modifier that ca
 
 The ``query`` value will appear in the URL like ``/search?query=my+important+query&secondary-query=my+secondary+query``.
 
+Map the parameter to path instead of query
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 2.27
+
+    The ``mapPath`` option was added in LiveComponents 2.27.
+
+Instead of setting the LiveProp as a query parameter, you can set it as route parameter.
+definition::
+
+    // ...
+    use Symfony\UX\LiveComponent\Metadata\UrlMapping;
+
+    #[AsLiveComponent]
+    class NodeModule
+    {
+        #[LiveProp(writable: true, url: new UrlMapping(mapPath: true))]
+        public string $id = '';
+
+        // ...
+    }
+
+
+The if the symfony route is defined like this::
+
+    // src/Controller/NodeController.php
+    // ...
+
+    #[Route('/node/{id}', name: 'node')]
+    public function node(NodeModule $nodeModule): Response
+    {
+        // ...
+    }
+
+Then the ``id`` value will appear in the URL like ``https://my.domain/node/my-node-id``.
+
+If the route parameter name is different from the LiveProp name, the ``as`` option can be used to map the LiveProp.
+
+If the route parameter is not defined, the ``mapPath`` option will be ignored and the LiveProp value will fallback to a query parameter.
+
 Validating the Query Parameter Values
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~