Skip to content

Commit eb72c4f

Browse files
committed
add warning to router
1 parent 4066adb commit eb72c4f

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/src/reference/router.md

+7
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ A Single Page Application URL router, which is a variant of [`reactpy-router`](h
1818

1919
URL router that enables the ability to conditionally render other components based on the client's current URL `#!python path`.
2020

21+
!!! warning "Pitfall"
22+
23+
All pages where this component exists must have the same, or more permissive exposure within Django's [URL patterns](https://docs.djangoproject.com/en/5.0/topics/http/urls/#example). You can think of this component as a secondary, client-side router. Django still handles the primary server-side routes.
24+
25+
We recommend creating a route with a wildcard `.*` to forward routes to ReactPy. For example...
26+
`#!python re_path(r"^/router/.*$", my_reactpy_view)`
27+
2128
=== "components.py"
2229

2330
```python

0 commit comments

Comments
 (0)