v3 (#58)

Author: zoontek

ADOPTION.md

@@ -26,7 +26,6 @@ $ npm install --save @swan-io/chicane
 ## Links
 
 - 📘 [**Documentation**](https://swan-io.github.io/chicane)
-- 📗 [**Usage with other routers**](./ADOPTION.md)
 - ⚖️ [**License**](./LICENSE)
 
 ## Quickstart

README.md

@@ -1,5 +1,4 @@
 import { render } from "@testing-library/react";
-import * as React from "react";
 import { afterEach, expect, test, vi } from "vitest";
 import { Link, createRouter } from "../src";
 

__tests__/hydration.tsx

@@ -1,5 +1,5 @@
 import { act, render } from "@testing-library/react";
-import * as React from "react";
+import { useRef } from "react";
 import { beforeEach, expect, test } from "vitest";
 import { createRouter, pushUnsafe, useFocusReset } from "../src";
 import { setInitialHasLocationChanged } from "../src/history";
@@ -111,7 +111,7 @@ test("getRoute: should match the correct route for given location", () => {
 test("useFocusReset: should focus the correct element", () => {
   const App = () => {
     const route = useRoute(routesToMatch);
-    const containerRef = React.useRef(null);
+    const containerRef = useRef(null);
 
     useFocusReset({ route, containerRef });
 

__tests__/router.tsx

@@ -2,10 +2,10 @@
  * @vitest-environment node
  */
 
-import * as React from "react";
 import { renderToString } from "react-dom/server";
 import { expect, test } from "vitest";
-import { Link, ServerUrlProvider, createRouter } from "../src";
+import { Link, createRouter } from "../src";
+import { UrlProvider } from "../src/server";
 
 const Router = createRouter({
   Home: "/",
@@ -51,29 +51,29 @@ const App = () => {
 test("Should render home page correctly", () => {
   expect(
     renderToString(
-      <ServerUrlProvider value="/">
+      <UrlProvider value="/">
         <App />
-      </ServerUrlProvider>,
+      </UrlProvider>,
     ),
   ).toMatchSnapshot();
 });
 
 test("Should render users page correctly", () => {
   expect(
     renderToString(
-      <ServerUrlProvider value="/users">
+      <UrlProvider value="/users">
         <App />
-      </ServerUrlProvider>,
+      </UrlProvider>,
     ),
   ).toMatchSnapshot();
 });
 
 test("Should render user page correctly", () => {
   expect(
     renderToString(
-      <ServerUrlProvider value="/users/123">
+      <UrlProvider value="/users/123">
         <App />
-      </ServerUrlProvider>,
+      </UrlProvider>,
     ),
   ).toMatchSnapshot();
 });

__tests__/server.tsx

@@ -3,10 +3,10 @@ title: Server-side rendering
 sidebar_label: Server-side rendering
 ---
 
-To render your app server-side, wrap it with `ServerUrlProvider`:
+To render your app server-side, wrap it with `UrlProvider`:
 
 ```tsx {1,10-12}
-import { ServerUrlProvider } from "@swan-io/chicane";
+import { UrlProvider } from "@swan-io/chicane/server";
 import express from "express";
 import { renderToString } from "react-dom/server";
 import { App } from "../client/App";
@@ -15,9 +15,9 @@ const app = express();
 
 app.use("*", (req, res) => {
   const html = renderToString(
-    <ServerUrlProvider value={req.originalUrl}>
+    <UrlProvider value={req.originalUrl}>
       <App />
-    </ServerUrlProvider>,
+    </UrlProvider>,
   );
 
   // …

docs/docs/server-side-rendering.md

@@ -24,7 +24,6 @@ const config = {
   projectName: "chicane", // Usually your repo name.
 
   onBrokenLinks: "throw",
-  onBrokenMarkdownLinks: "warn",
 
   // Even if you don't use internationalization, you can use this field to set
   // useful metadata like html lang. For example, if your site is Chinese, you
@@ -34,6 +33,12 @@ const config = {
     locales: ["en"],
   },
 
+  markdown: {
+    hooks: {
+      onBrokenMarkdownLinks: "warn",
+    },
+  },
+
   presets: [
     [
       "classic",

docs/docusaurus.config.js

@@ -14,17 +14,17 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "3.4.0",
-    "@docusaurus/preset-classic": "3.4.0",
-    "@mdx-js/react": "^3.0.1",
+    "@docusaurus/core": "3.9.2",
+    "@docusaurus/preset-classic": "3.9.2",
+    "@mdx-js/react": "^3.1.1",
     "clsx": "^2.1.1",
-    "prism-react-renderer": "^2.3.1",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
+    "prism-react-renderer": "^2.4.1",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.4.0",
-    "@docusaurus/types": "3.4.0"
+    "@docusaurus/module-type-aliases": "3.9.2",
+    "@docusaurus/types": "3.9.2"
   },
   "browserslist": {
     "production": [