use_query -> use_search_params

Author: Archmonger

docs/examples/python/use-query.py

@@ -1,11 +1,10 @@
 from reactpy import component, html
-
-from reactpy_router import link, route, simple, use_query
+from reactpy_router import link, route, simple, use_search_params
 
 
 @component
 def search():
-    query = use_query()
+    query = use_search_params()
     return html.h1(f"Search Results for {query['q'][0]} 🔍")
 
 

docs/src/learn/hooks.md

@@ -8,7 +8,7 @@ Several pre-fabricated hooks are provided to help integrate with routing feature
 
 ## Use Query
 
-The [`use_query`][src.reactpy_router.use_query] hook can be used to access query parameters from the current location. It returns a dictionary of query parameters, where each value is a list of strings.
+The [`use_search_params`][src.reactpy_router.use_search_params] hook can be used to access query parameters from the current location. It returns a dictionary of query parameters, where each value is a list of strings.
 
 === "components.py"
 

docs/src/learn/routers-routes-and-links.md

@@ -54,7 +54,7 @@ Any route parameters collected from the current location then be accessed using
 
 !!! warning "Pitfall"
 
-    While it is possible to use route parameters to capture values from query strings (such as `#!python /my/route/?foo={bar}`), this is not recommended. Instead, you should use the [`use_query`][src.reactpy_router.use_query] hook to access query string values.
+    While it is possible to use route parameters to capture values from query strings (such as `#!python /my/route/?foo={bar}`), this is not recommended. Instead, you should use the [`use_search_params`][src.reactpy_router.use_search_params] hook to access query string values.
 
 ## Route Links
 

src/reactpy_router/__init__.py

@@ -2,7 +2,7 @@
 __version__ = "0.1.1"
 
 from . import simple
-from .core import create_router, link, route, router_component, use_params, use_query
+from .core import create_router, link, route, router_component, use_params, use_search_params
 from .types import Route, RouteCompiler, RouteResolver
 
 __all__ = (
@@ -16,5 +16,5 @@
     "RouteResolver",
     "simple",
     "use_params",
-    "use_query",
+    "use_search_params",
 )

src/reactpy_router/core.py

@@ -88,14 +88,22 @@ def use_params() -> dict[str, Any]:
     return _use_route_state().params
 
 
-def use_query(
+def use_search_params(
     keep_blank_values: bool = False,
     strict_parsing: bool = False,
     errors: str = "replace",
     max_num_fields: int | None = None,
     separator: str = "&",
 ) -> dict[str, list[str]]:
-    """See :func:`urllib.parse.parse_qs` for parameter info."""
+    """
+    The `use_search_params` hook is used to read and modify the query string in the URL \
+    for the current location. Like React's own `use_state` hook, `use_search_params returns \
+    an array of two values: the current location's search params and a function that may \
+    be used to update them.
+
+    See `urllib.parse.parse_qs` for info on this hook's parameters."""
+
+    # FIXME: This needs to return a tuple of the search params and a function to update them
     return parse_qs(
         use_location().search[1:],
         keep_blank_values=keep_blank_values,

tests/test_core.py

@@ -2,7 +2,7 @@
 
 from reactpy import Ref, component, html, use_location
 from reactpy.testing import DisplayFixture
-from reactpy_router import link, route, simple, use_params, use_query
+from reactpy_router import link, route, simple, use_params, use_search_params
 
 
 async def test_simple_router(display: DisplayFixture):
@@ -40,7 +40,8 @@ def sample():
         root_element = await display.root_element()
     except AttributeError:
         root_element = await display.page.wait_for_selector(
-            f"#display-{display._next_view_id}", state="attached"  # type: ignore
+            f"#display-{display._next_view_id}",
+            state="attached",  # type: ignore
         )
 
     assert not await root_element.inner_html()
@@ -140,7 +141,7 @@ async def test_use_query(display: DisplayFixture):
 
     @component
     def check_query():
-        assert use_query() == expected_query
+        assert use_search_params() == expected_query
         return html.h1({"id": "success"}, "success")
 
     @component