simple.router -> browser_router

docs/examples/python/basic-routing-more-routes.py

@@ -1,11 +1,10 @@
 from reactpy import component, html, run
-
-from reactpy_router import route, simple
+from reactpy_router import browser_router, route
 
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route("/", html.h1("Home Page 🏠")),
         route("/messages", html.h1("Messages 💬")),
         route("*", html.h1("Missing Link 🔗‍💥")),

docs/examples/python/basic-routing.py

@@ -1,11 +1,10 @@
 from reactpy import component, html, run
-
-from reactpy_router import route, simple
+from reactpy_router import browser_router, route
 
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route("/", html.h1("Home Page 🏠")),
         route("*", html.h1("Missing Link 🔗‍💥")),
     )

docs/examples/python/nested-routes.py

@@ -1,7 +1,7 @@
 from typing import TypedDict
 
 from reactpy import component, html, run
-from reactpy_router import link, route, simple
+from reactpy_router import browser_router, link, route
 
 message_data: list["MessageDataType"] = [
     {"id": 1, "with": ["Alice"], "from": None, "message": "Hello!"},
@@ -17,7 +17,7 @@
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route("/", home()),
         route(
             "/messages",
@@ -40,10 +40,7 @@ def home():
 
 @component
 def all_messages():
-    last_messages = {
-        ", ".join(msg["with"]): msg
-        for msg in sorted(message_data, key=lambda m: m["id"])
-    }
+    last_messages = {", ".join(msg["with"]): msg for msg in sorted(message_data, key=lambda m: m["id"])}
     return html.div(
         html.h1("All Messages 💬"),
         html.ul(

docs/examples/python/route-links.py

@@ -1,11 +1,10 @@
 from reactpy import component, html, run
-
-from reactpy_router import link, route, simple
+from reactpy_router import browser_router, link, route
 
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route("/", home()),
         route("/messages", html.h1("Messages 💬")),
         route("*", html.h1("Missing Link 🔗‍💥")),

docs/examples/python/route-parameters.py

@@ -1,7 +1,7 @@
 from typing import TypedDict
 
 from reactpy import component, html, run
-from reactpy_router import link, route, simple
+from reactpy_router import browser_router, link, route
 from reactpy_router.core import use_params
 
 message_data: list["MessageDataType"] = [
@@ -18,7 +18,7 @@
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route("/", home()),
         route(
             "/messages",
@@ -39,10 +39,7 @@ def home():
 
 @component
 def all_messages():
-    last_messages = {
-        ", ".join(msg["with"]): msg
-        for msg in sorted(message_data, key=lambda m: m["id"])
-    }
+    last_messages = {", ".join(msg["with"]): msg for msg in sorted(message_data, key=lambda m: m["id"])}
     return html.div(
         html.h1("All Messages 💬"),
         html.ul(

docs/examples/python/use-params.py

@@ -1,6 +1,5 @@
 from reactpy import component, html
-
-from reactpy_router import link, route, simple, use_params
+from reactpy_router import browser_router, link, route, use_params
 
 
 @component
@@ -11,7 +10,7 @@ def user():
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route(
             "/",
             html.div(

docs/examples/python/use-query.py

@@ -1,5 +1,5 @@
 from reactpy import component, html
-from reactpy_router import link, route, simple, use_search_params
+from reactpy_router import browser_router, link, route, use_search_params
 
 
 @component
@@ -10,7 +10,7 @@ def search():
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route(
             "/",
             html.div(

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

@@ -4,14 +4,14 @@ We include built-in components that automatically handle routing, which enable S
 
 ## Routers and Routes
 
-The [`simple.router`][src.reactpy_router.simple.router] component is one possible implementation of a [Router][src.reactpy_router.types.Router]. Routers takes a series of [route][src.reactpy_router.route] objects as positional arguments and render whatever element matches the current location.
+The [`browser_router`][src.reactpy_router.browser_router] component is one possible implementation of a [Router][src.reactpy_router.types.Router]. Routers takes a series of [route][src.reactpy_router.route] objects as positional arguments and render whatever element matches the current location.
 
 !!! abstract "Note"
 
     The current location is determined based on the browser's current URL and can be found
     by checking the [`use_location`][reactpy.backend.hooks.use_location] hook.
 
-Here's a basic example showing how to use `#!python simple.router` with two routes.
+Here's a basic example showing how to use `#!python browser_router` with two routes.
 
 === "components.py"
 
@@ -21,9 +21,9 @@ Here's a basic example showing how to use `#!python simple.router` with two rout
 
 Here we'll note some special syntax in the route path for the second route. The `#!python "*"` is a wildcard that will match any path. This is useful for creating a "404" page that will be shown when no other route matches.
 
-### Simple Router
+### Browser Router
 
-The syntax for declaring routes with the [simple.router][src.reactpy_router.simple.router] is very similar to the syntax used by [`starlette`](https://www.starlette.io/routing/) (a popular Python web framework). As such route parameters are declared using the following syntax:
+The syntax for declaring routes with the [`browser_router`][src.reactpy_router.browser_router] is very similar to the syntax used by [`starlette`](https://www.starlette.io/routing/) (a popular Python web framework). As such route parameters are declared using the following syntax:
 
 ```python linenums="0"
 /my/route/{param}

docs/src/learn/simple-application.md

@@ -1,6 +1,6 @@
 <p class="intro" markdown>
 
-Here you'll learn the various features of `reactpy-router` and how to use them. These examples will utilize the [`reactpy_router.simple.router`][src.reactpy_router.simple.router].
+Here you'll learn the various features of `reactpy-router` and how to use them. These examples will utilize the [`reactpy_router.browser_router`][src.reactpy_router.browser_router].
 
 </p>
 

docs/src/reference/router.md

@@ -1 +1 @@
-::: src.reactpy_router.simple
+::: src.reactpy_router.browser_router

src/reactpy_router/__init__.py

@@ -1,8 +1,9 @@
 # the version is statically loaded by setup.py
 __version__ = "0.1.1"
 
-from . import simple
+from . import routers
 from .core import create_router, link, route, router_component, use_params, use_search_params
+from .routers import browser_router
 from .types import Route, RouteCompiler, RouteResolver
 
 __all__ = (
@@ -11,10 +12,11 @@
     "route",
     "route",
     "Route",
+    "routers",
     "RouteCompiler",
     "router_component",
     "RouteResolver",
-    "simple",
+    "browser_router",
     "use_params",
     "use_search_params",
 )

src/reactpy_router/simple.py → src/reactpy_router/routers.py

@@ -11,7 +11,7 @@
 from reactpy_router.core import create_router
 from reactpy_router.types import Route
 
-__all__ = ["router"]
+__all__ = ["browser_router"]
 
 ConversionFunc: TypeAlias = "Callable[[str], Any]"
 ConverterMapping: TypeAlias = "dict[str, ConversionFunc]"
@@ -94,5 +94,7 @@ class ConversionInfo(TypedDict):
 """The supported conversion types"""
 
 
-router = create_router(SimpleResolver)
-"""The simple router"""
+browser_router = create_router(SimpleResolver)
+"""This is the recommended router for all ReactPy Router web projects.
+It uses the DOM History API to update the URL and manage the history stack."""
+# TODO: Check if this is true. If not, make it true.

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_search_params
+from reactpy_router import link, route, routers, use_params, use_search_params
 
 
 async def test_simple_router(display: DisplayFixture):
@@ -18,7 +18,7 @@ def check_location():
 
     @component
     def sample():
-        return simple.router(
+        return routers.browser_router(
             make_location_check("/a"),
             make_location_check("/b"),
             make_location_check("/c"),
@@ -50,7 +50,7 @@ def sample():
 async def test_nested_routes(display: DisplayFixture):
     @component
     def sample():
-        return simple.router(
+        return routers.browser_router(
             route(
                 "/a",
                 html.h1({"id": "a"}, "A"),
@@ -79,7 +79,7 @@ async def test_navigate_with_link(display: DisplayFixture):
     @component
     def sample():
         render_count.current += 1
-        return simple.router(
+        return routers.browser_router(
             route("/", link("Root", to="/a", id="root")),
             route("/a", link("A", to="/b", id="a")),
             route("/b", link("B", to="/c", id="b")),
@@ -110,7 +110,7 @@ def check_params():
 
     @component
     def sample():
-        return simple.router(
+        return routers.browser_router(
             route(
                 "/first/{first:str}",
                 check_params(),
@@ -146,7 +146,7 @@ def check_query():
 
     @component
     def sample():
-        return simple.router(route("/", check_query()))
+        return routers.browser_router(route("/", check_query()))
 
     await display.show(sample)
 
@@ -158,7 +158,7 @@ def sample():
 async def test_browser_popstate(display: DisplayFixture):
     @component
     def sample():
-        return simple.router(
+        return routers.browser_router(
             route("/", link("Root", to="/a", id="root")),
             route("/a", link("A", to="/b", id="a")),
             route("/b", link("B", to="/c", id="b")),
@@ -190,7 +190,7 @@ def sample():
 async def test_relative_links(display: DisplayFixture):
     @component
     def sample():
-        return simple.router(
+        return routers.browser_router(
             route("/", link("Root", to="/a", id="root")),
             route("/a", link("A", to="/a/b", id="a")),
             route("/a/b", link("B", to="../a/b/c", id="b")),

tests/test_simple.py

@@ -2,8 +2,7 @@
 import uuid
 
 import pytest
-
-from reactpy_router.simple import parse_path
+from reactpy_router.routers import parse_path
 
 
 def test_parse_path():