New Navigate component (#34)

- Create `navigate` component
- Better key value identity of route components
- Remove initial URL handling from the `History` component due to reactpy rendering bugs
   - This is now handled by a new `FirstLoad` element.
- Fix docs publishing workflow
- Add arg descriptions to all public functions
- Better styling for autodocs.
- Support Python 3.12

Author: Archmonger

.github/workflows/test-docs.yml

@@ -25,7 +25,6 @@ jobs:
           pip install -r requirements/build-docs.txt
           pip install -r requirements/check-types.txt
           pip install -r requirements/check-style.txt
-          pip install -e .
       - name: Check docs build
         run: |
           linkcheckMarkdown docs/ -v -r

.github/workflows/test-src.yaml

@@ -1,40 +1,40 @@
 name: Test
 
 on:
-    push:
-        branches:
-            - main
-    pull_request:
-        branches:
-            - main
-    schedule:
-        - cron: "0 0 * * *"
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: "0 0 * * *"
 
 jobs:
-    source:
-        runs-on: ubuntu-latest
-        strategy:
-            matrix:
-                python-version: ["3.9", "3.10", "3.11"]
-        steps:
-            - uses: actions/checkout@v4
-            - name: Use Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v5
-              with:
-                  python-version: ${{ matrix.python-version }}
-            - name: Install Python Dependencies
-              run: pip install -r requirements/test-run.txt
-            - name: Run Tests
-              run: nox -t test
-    coverage:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-            - name: Use Latest Python
-              uses: actions/setup-python@v5
-              with:
-                  python-version: "3.10"
-            - name: Install Python Dependencies
-              run: pip install -r requirements/test-run.txt
-            - name: Run Tests
-              run: nox -t test -- --coverage
+  source:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Python Dependencies
+        run: pip install -r requirements/test-run.txt
+      - name: Run Tests
+        run: nox -t test
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Latest Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install Python Dependencies
+        run: pip install -r requirements/test-run.txt
+      - name: Run Tests
+        run: nox -t test -- --coverage

CHANGELOG.md

@@ -42,14 +42,15 @@ Using the following categories, list your changes in this order:
 -   Rename `CONVERSION_TYPES` to `CONVERTERS`.
 -   Change "Match Any" syntax from a star `*` to `{name:any}`.
 -   Rewrite `reactpy_router.link` to be a server-side component.
--   Simplified top-level exports within `reactpy_router`.
+-   Simplified top-level exports that are available within `reactpy_router.*`.
 
 ### Added
 
--   New error for ReactPy router elements being used outside router context.
--   Configurable/inheritable `Resolver` base class.
 -   Add debug log message for when there are no router matches.
 -   Add slug as a supported type.
+-   Add `reactpy_router.navigate` component that will force the client to navigate to a new URL (when rendered).
+-   New error for ReactPy router elements being used outside router context.
+-   Configurable/inheritable `Resolver` base class.
 
 ### Fixed
 
@@ -58,6 +59,7 @@ Using the following categories, list your changes in this order:
 -   Fix bug where `link` elements could not have `@component` type children.
 -   Fix bug where the ReactPy would not detect the current URL after a reconnection.
 -   Fix bug where `ctrl` + `click` on a `link` element would not open in a new tab.
+-   Fix test suite on Windows machines.
 
 ## [0.1.1] - 2023-12-13
 

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

@@ -1,4 +1,5 @@
 from reactpy import component, html, run
+
 from reactpy_router import browser_router, route
 
 

docs/examples/python/basic-routing.py

@@ -1,4 +1,5 @@
 from reactpy import component, html, run
+
 from reactpy_router import browser_router, route
 
 

docs/mkdocs.yml

@@ -8,7 +8,7 @@ nav:
           - Hooks: learn/hooks.md
           - Creating a Custom Router 🚧: learn/custom-router.md
   - Reference:
-      - Router Components: reference/router.md
+      - Routers: reference/routers.md
       - Components: reference/components.md
       - Hooks: reference/hooks.md
       - Types: reference/types.md
@@ -96,8 +96,21 @@ plugins:
             - https://reactpy.dev/docs/objects.inv
             - https://installer.readthedocs.io/en/stable/objects.inv
           options:
-            show_bases: false
+            signature_crossrefs: true
+            scoped_crossrefs: true
+            relative_crossrefs: true
+            modernize_annotations: true
+            unwrap_annotated: true
+            find_stubs_package: true
             show_root_members_full_path: true
+            show_bases: false
+            show_source: false
+            show_root_toc_entry: false
+            show_labels: false
+            show_symbol_type_toc: true
+            show_symbol_type_heading: true
+            show_object_full_path: true
+            heading_level: 3
 extra:
   generator: false
   version:

docs/src/dictionary.txt

@@ -37,3 +37,4 @@ misconfiguration
 misconfigurations
 backhaul
 sublicense
+contravariant

docs/src/reference/components.md

@@ -1,4 +1,4 @@
 ::: reactpy_router
 
     options:
-        members: ["route", "link"]
+        members: ["route", "link", "navigate"]

docs/src/reference/router.md renamed to docs/src/reference/routers.md

@@ -1 +1,5 @@
 ::: reactpy_router.types
+
+    options:
+        summary: true
+        docstring_section_style: "list"