diff --git a/404.html b/404.html index 6cc5b459..2bfd2a16 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ Chicane - + diff --git a/assets/js/16dfdcef.3da03351.js b/assets/js/16dfdcef.a1883f78.js similarity index 98% rename from assets/js/16dfdcef.3da03351.js rename to assets/js/16dfdcef.a1883f78.js index 42eda46e..4a6a98ef 100644 --- a/assets/js/16dfdcef.3da03351.js +++ b/assets/js/16dfdcef.a1883f78.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88],{9572:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var t=n(7624),s=n(2172);const o={title:"Router",sidebar_label:"Router"},a=void 0,i={id:"router",title:"Router",description:"The following cover the API exposed by a Router (check out how to create one).",source:"@site/docs/router.md",sourceDirName:".",slug:"/router",permalink:"/chicane/router",draft:!1,unlisted:!1,editUrl:"https://github.com/swan-io/chicane/edit/main/docs/docs/router.md",tags:[],version:"current",frontMatter:{title:"Router",sidebar_label:"Router"},sidebar:"docs",previous:{title:"Top-level API",permalink:"/chicane/top-level-api"},next:{title:"Components",permalink:"/chicane/components"}},u={},c=[{value:"Router.{RouteName}",id:"routerroutename",level:2},{value:"Router.useRoute",id:"routeruseroute",level:2},{value:"Router.getRoute",id:"routergetroute",level:2},{value:"Router.push",id:"routerpush",level:2},{value:"Router.replace",id:"routerreplace",level:2},{value:"Router.P.{RouteName}",id:"routerproutename",level:2}];function l(e){const r={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.M)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(r.p,{children:["The following cover the API exposed by a ",(0,t.jsx)(r.strong,{children:"Router"})," (",(0,t.jsx)(r.a,{href:"/creating-your-router",children:"check out how to create one"}),")."]}),"\n",(0,t.jsx)(r.h2,{id:"routerroutename",children:"Router.{RouteName}"}),"\n",(0,t.jsx)(r.p,{children:"The Router has one per route. Takes the route params (if it has some), and returns a build URL."}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": Required params for the route."]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'Router.UserDetail({ userId: "123" }); // "/users/123"\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routeruseroute",children:"Router.useRoute"}),"\n",(0,t.jsx)(r.p,{children:"Takes an array of routes to listen to (a subset of the router), and returns the route and its params if one matches."}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"routes"})," (",(0,t.jsx)(r.strong,{children:"required"}),"): ",(0,t.jsx)(r.code,{children:"RouteName[]"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["Returns a route match (or ",(0,t.jsx)(r.code,{children:"undefined"})," if nothing matches):"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"name"}),": a route name"]}),"\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": its associated params"]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'const route = Router.useRoute(["Home", "UserArea"]);\n\n// then match on the route\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routergetroute",children:"Router.getRoute"}),"\n",(0,t.jsx)(r.p,{children:"Takes an array of routes (a subset of the router), and returns the route and its params if one matches."}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"routes"})," (",(0,t.jsx)(r.strong,{children:"required"}),"): ",(0,t.jsx)(r.code,{children:"RouteName[]"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["Returns a route match (or ",(0,t.jsx)(r.code,{children:"undefined"})," if nothing matches):"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"name"}),": a route name"]}),"\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": its associated params"]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'const route = Router.getRoute(["Home", "UserArea"]);\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routerpush",children:"Router.push"}),"\n",(0,t.jsx)(r.p,{children:"Takes a route name and its associated params and navigates to it"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"name"}),": a route name"]}),"\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": its associated params"]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'Router.push("Home");\nRouter.push("UserDetail", { userId: "123" });\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routerreplace",children:"Router.replace"}),"\n",(0,t.jsxs)(r.p,{children:["Takes a route name and its associated params and navigates to it ",(0,t.jsx)(r.strong,{children:"without"})," creating a new entry in the browser history."]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"name"}),": a route name"]}),"\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": its associated params"]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'Router.replace("Home");\nRouter.replace("UserDetail", { userId: "123" });\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routerproutename",children:"Router.P.{RouteName}"}),"\n",(0,t.jsxs)(r.p,{children:["Provides ",(0,t.jsx)(r.code,{children:"ts-pattern"})," interop."]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-tsx",children:'const Router = createRouter({\n Home: "/",\n UserArea: "/users/*",\n User: "/users/:userId",\n});\n\nconst App = () => {\n const route = Router.useRoute(["Home", "UserArea", "User"]);\n\n return match(route)\n .with(Router.P.Home(P._), () => )\n .with(Router.P.UserArea(P._), () => )\n .with(Router.P.User({ userId: P.select() }), (id) => )\n .otherwise(() => null);\n};\n'})})]})}function d(e={}){const{wrapper:r}={...(0,s.M)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},2172:(e,r,n)=>{n.d(r,{I:()=>i,M:()=>a});var t=n(1504);const s={},o=t.createContext(s);function a(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88],{9572:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var t=n(7624),s=n(2172);const o={title:"Router",sidebar_label:"Router"},a=void 0,i={id:"router",title:"Router",description:"The following cover the API exposed by a Router (check out how to create one).",source:"@site/docs/router.md",sourceDirName:".",slug:"/router",permalink:"/chicane/router",draft:!1,unlisted:!1,editUrl:"https://github.com/swan-io/chicane/edit/main/docs/docs/router.md",tags:[],version:"current",frontMatter:{title:"Router",sidebar_label:"Router"},sidebar:"docs",previous:{title:"Top-level API",permalink:"/chicane/top-level-api"},next:{title:"Components",permalink:"/chicane/components"}},u={},c=[{value:"Router.{RouteName}",id:"routerroutename",level:2},{value:"Router.useRoute",id:"routeruseroute",level:2},{value:"Router.getRoute",id:"routergetroute",level:2},{value:"Router.push",id:"routerpush",level:2},{value:"Router.replace",id:"routerreplace",level:2},{value:"Router.P.{RouteName}",id:"routerproutename",level:2}];function l(e){const r={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.M)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(r.p,{children:["The following cover the API exposed by a ",(0,t.jsx)(r.strong,{children:"Router"})," (",(0,t.jsx)(r.a,{href:"/creating-your-router",children:"check out how to create one"}),")."]}),"\n",(0,t.jsx)(r.h2,{id:"routerroutename",children:"Router.{RouteName}"}),"\n",(0,t.jsx)(r.p,{children:"The Router has one per route. Takes the route params (if it has some), and returns a built URL."}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": Required params for the route."]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'Router.UserDetail({ userId: "123" }); // "/users/123"\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routeruseroute",children:"Router.useRoute"}),"\n",(0,t.jsx)(r.p,{children:"Takes an array of routes to listen to (a subset of the router), and returns the route and its params if one matches."}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"routes"})," (",(0,t.jsx)(r.strong,{children:"required"}),"): ",(0,t.jsx)(r.code,{children:"RouteName[]"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["Returns a route match (or ",(0,t.jsx)(r.code,{children:"undefined"})," if nothing matches):"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"name"}),": a route name"]}),"\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": its associated params"]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'const route = Router.useRoute(["Home", "UserArea"]);\n\n// then match on the route\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routergetroute",children:"Router.getRoute"}),"\n",(0,t.jsx)(r.p,{children:"Takes an array of routes (a subset of the router), and returns the route and its params if one matches."}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"routes"})," (",(0,t.jsx)(r.strong,{children:"required"}),"): ",(0,t.jsx)(r.code,{children:"RouteName[]"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["Returns a route match (or ",(0,t.jsx)(r.code,{children:"undefined"})," if nothing matches):"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"name"}),": a route name"]}),"\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": its associated params"]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'const route = Router.getRoute(["Home", "UserArea"]);\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routerpush",children:"Router.push"}),"\n",(0,t.jsx)(r.p,{children:"Takes a route name and its associated params and navigates to it"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"name"}),": a route name"]}),"\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": its associated params"]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'Router.push("Home");\nRouter.push("UserDetail", { userId: "123" });\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routerreplace",children:"Router.replace"}),"\n",(0,t.jsxs)(r.p,{children:["Takes a route name and its associated params and navigates to it ",(0,t.jsx)(r.strong,{children:"without"})," creating a new entry in the browser history."]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"name"}),": a route name"]}),"\n",(0,t.jsxs)(r.li,{children:[(0,t.jsx)(r.code,{children:"params"}),": its associated params"]}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:'Router.replace("Home");\nRouter.replace("UserDetail", { userId: "123" });\n'})}),"\n",(0,t.jsx)(r.h2,{id:"routerproutename",children:"Router.P.{RouteName}"}),"\n",(0,t.jsxs)(r.p,{children:["Provides ",(0,t.jsx)(r.code,{children:"ts-pattern"})," interop."]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-tsx",children:'const Router = createRouter({\n Home: "/",\n UserArea: "/users/*",\n User: "/users/:userId",\n});\n\nconst App = () => {\n const route = Router.useRoute(["Home", "UserArea", "User"]);\n\n return match(route)\n .with(Router.P.Home(P._), () => )\n .with(Router.P.UserArea(P._), () => )\n .with(Router.P.User({ userId: P.select() }), (id) => )\n .otherwise(() => null);\n};\n'})})]})}function d(e={}){const{wrapper:r}={...(0,s.M)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},2172:(e,r,n)=>{n.d(r,{I:()=>i,M:()=>a});var t=n(1504);const s={},o=t.createContext(s);function a(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.beb3f97a.js b/assets/js/runtime~main.41fd690b.js similarity index 98% rename from assets/js/runtime~main.beb3f97a.js rename to assets/js/runtime~main.41fd690b.js index f94ce253..efbe23b6 100644 --- a/assets/js/runtime~main.beb3f97a.js +++ b/assets/js/runtime~main.41fd690b.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,a,o,d={},c={};function n(e){var t=c[e];if(void 0!==t)return t.exports;var r=c[e]={id:e,loaded:!1,exports:{}};return d[e].call(r.exports,r,r.exports,n),r.loaded=!0,r.exports}n.m=d,n.c=c,e=[],n.O=(t,r,a,o)=>{if(!r){var d=1/0;for(b=0;b=o)&&Object.keys(n.O).every((e=>n.O[e](r[f])))?r.splice(f--,1):(c=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},n.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return n.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);n.r(o);var d={};t=t||[null,r({}),r([]),r(r)];for(var c=2&a&&e;"object"==typeof c&&!~t.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach((t=>d[t]=()=>e[t]));return d.default=()=>e,n.d(o,d),o},n.d=(e,t)=>{for(var r in t)n.o(t,r)&&!n.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce(((t,r)=>(n.f[r](e,t),t)),[])),n.u=e=>"assets/js/"+({8:"ad81055d",28:"0ed2bd80",88:"16dfdcef",160:"1f7c204c",164:"0a3cf8c5",304:"5e95c892",408:"49b3bb10",448:"3e1cf923",500:"a7bd4aaa",596:"9bbd3c58",600:"cf630e04",608:"f66cc48b",632:"c4f5d8e4",666:"a94703ab",696:"935f2afb",752:"17896441",760:"743a058c",840:"d589d3a7",956:"5f94b19d",984:"0a1adc19"}[e]||e)+"."+{8:"1828f9a7",28:"a09ed93e",88:"3da03351",160:"87305ae5",164:"a5044331",228:"b3b0e0b3",304:"d45d3d95",408:"6ab072b6",448:"7589e1ab",500:"a76895e9",552:"9d0e85bd",596:"894cca76",600:"875533cd",608:"99248da1",632:"d3e7e7b3",666:"e9548050",696:"689ee830",752:"ae17bb86",760:"1cd9866c",840:"44778203",956:"9ef7671e",984:"cb9c4227"}[e]+".js",n.miniCssF=e=>{},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="docs:",n.l=(e,t,r,d)=>{if(a[e])a[e].push(t);else{var c,f;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b{c.onerror=c.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],c.parentNode&&c.parentNode.removeChild(c),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=l.bind(null,c.onerror),c.onload=l.bind(null,c.onload),f&&document.head.appendChild(c)}},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.p="/chicane/",n.gca=function(e){return e={17896441:"752",ad81055d:"8","0ed2bd80":"28","16dfdcef":"88","1f7c204c":"160","0a3cf8c5":"164","5e95c892":"304","49b3bb10":"408","3e1cf923":"448",a7bd4aaa:"500","9bbd3c58":"596",cf630e04:"600",f66cc48b:"608",c4f5d8e4:"632",a94703ab:"666","935f2afb":"696","743a058c":"760",d589d3a7:"840","5f94b19d":"956","0a1adc19":"984"}[e]||e,n.p+n.u(e)},(()=>{var e={296:0,176:0};n.f.j=(t,r)=>{var a=n.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(17|29)6$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var d=n.p+n.u(t),c=new Error;n.l(d,(r=>{if(n.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),d=r&&r.target&&r.target.src;c.message="Loading chunk "+t+" failed.\n("+o+": "+d+")",c.name="ChunkLoadError",c.type=o,c.request=d,a[1](c)}}),"chunk-"+t,t)}},n.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,d=r[0],c=r[1],f=r[2],i=0;if(d.some((t=>0!==e[t]))){for(a in c)n.o(c,a)&&(n.m[a]=c[a]);if(f)var b=f(n)}for(t&&t(r);i{"use strict";var e,t,r,a,o,d={},c={};function n(e){var t=c[e];if(void 0!==t)return t.exports;var r=c[e]={id:e,loaded:!1,exports:{}};return d[e].call(r.exports,r,r.exports,n),r.loaded=!0,r.exports}n.m=d,n.c=c,e=[],n.O=(t,r,a,o)=>{if(!r){var d=1/0;for(b=0;b=o)&&Object.keys(n.O).every((e=>n.O[e](r[f])))?r.splice(f--,1):(c=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},n.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return n.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);n.r(o);var d={};t=t||[null,r({}),r([]),r(r)];for(var c=2&a&&e;"object"==typeof c&&!~t.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach((t=>d[t]=()=>e[t]));return d.default=()=>e,n.d(o,d),o},n.d=(e,t)=>{for(var r in t)n.o(t,r)&&!n.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce(((t,r)=>(n.f[r](e,t),t)),[])),n.u=e=>"assets/js/"+({8:"ad81055d",28:"0ed2bd80",88:"16dfdcef",160:"1f7c204c",164:"0a3cf8c5",304:"5e95c892",408:"49b3bb10",448:"3e1cf923",500:"a7bd4aaa",596:"9bbd3c58",600:"cf630e04",608:"f66cc48b",632:"c4f5d8e4",666:"a94703ab",696:"935f2afb",752:"17896441",760:"743a058c",840:"d589d3a7",956:"5f94b19d",984:"0a1adc19"}[e]||e)+"."+{8:"1828f9a7",28:"a09ed93e",88:"a1883f78",160:"87305ae5",164:"a5044331",228:"b3b0e0b3",304:"d45d3d95",408:"6ab072b6",448:"7589e1ab",500:"a76895e9",552:"9d0e85bd",596:"894cca76",600:"875533cd",608:"99248da1",632:"d3e7e7b3",666:"e9548050",696:"689ee830",752:"ae17bb86",760:"1cd9866c",840:"44778203",956:"9ef7671e",984:"cb9c4227"}[e]+".js",n.miniCssF=e=>{},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="docs:",n.l=(e,t,r,d)=>{if(a[e])a[e].push(t);else{var c,f;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b{c.onerror=c.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],c.parentNode&&c.parentNode.removeChild(c),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=l.bind(null,c.onerror),c.onload=l.bind(null,c.onload),f&&document.head.appendChild(c)}},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.p="/chicane/",n.gca=function(e){return e={17896441:"752",ad81055d:"8","0ed2bd80":"28","16dfdcef":"88","1f7c204c":"160","0a3cf8c5":"164","5e95c892":"304","49b3bb10":"408","3e1cf923":"448",a7bd4aaa:"500","9bbd3c58":"596",cf630e04:"600",f66cc48b:"608",c4f5d8e4:"632",a94703ab:"666","935f2afb":"696","743a058c":"760",d589d3a7:"840","5f94b19d":"956","0a1adc19":"984"}[e]||e,n.p+n.u(e)},(()=>{var e={296:0,176:0};n.f.j=(t,r)=>{var a=n.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(17|29)6$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var d=n.p+n.u(t),c=new Error;n.l(d,(r=>{if(n.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),d=r&&r.target&&r.target.src;c.message="Loading chunk "+t+" failed.\n("+o+": "+d+")",c.name="ChunkLoadError",c.type=o,c.request=d,a[1](c)}}),"chunk-"+t,t)}},n.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,d=r[0],c=r[1],f=r[2],i=0;if(d.some((t=>0!==e[t]))){for(a in c)n.o(c,a)&&(n.m[a]=c[a]);if(f)var b=f(n)}for(t&&t(r);i Components | Chicane - + diff --git a/creating-your-router/index.html b/creating-your-router/index.html index c1349187..539e82fb 100644 --- a/creating-your-router/index.html +++ b/creating-your-router/index.html @@ -4,7 +4,7 @@ Creating your router | Chicane - + diff --git a/getting-started/index.html b/getting-started/index.html index b7f53d7b..b3dbe1ac 100644 --- a/getting-started/index.html +++ b/getting-started/index.html @@ -4,7 +4,7 @@ Getting started | Chicane - + diff --git a/hooks/index.html b/hooks/index.html index f6abd44e..a5731e8d 100644 --- a/hooks/index.html +++ b/hooks/index.html @@ -4,7 +4,7 @@ Hooks | Chicane - + diff --git a/index.html b/index.html index f3e25871..d10252cf 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ Chicane: A safe router for React and TypeScript | Chicane - + diff --git a/linking-to-a-route/index.html b/linking-to-a-route/index.html index ecc3eb7a..b627ad2c 100644 --- a/linking-to-a-route/index.html +++ b/linking-to-a-route/index.html @@ -4,7 +4,7 @@ Linking to a route | Chicane - + diff --git a/lower-level-api/index.html b/lower-level-api/index.html index 3c64a592..fa194694 100644 --- a/lower-level-api/index.html +++ b/lower-level-api/index.html @@ -4,7 +4,7 @@ Lower-level API | Chicane - + diff --git a/matching-some-routes/index.html b/matching-some-routes/index.html index 84141ec7..6cd8120c 100644 --- a/matching-some-routes/index.html +++ b/matching-some-routes/index.html @@ -4,7 +4,7 @@ Matching some routes | Chicane - + diff --git a/route-focus/index.html b/route-focus/index.html index 892cdf7a..a548a977 100644 --- a/route-focus/index.html +++ b/route-focus/index.html @@ -4,7 +4,7 @@ Route focus | Chicane - + diff --git a/route-pattern-syntax/index.html b/route-pattern-syntax/index.html index 3e813bd2..14f680cd 100644 --- a/route-pattern-syntax/index.html +++ b/route-pattern-syntax/index.html @@ -4,7 +4,7 @@ The Route pattern syntax | Chicane - + diff --git a/router/index.html b/router/index.html index a387c64e..dc03aa17 100644 --- a/router/index.html +++ b/router/index.html @@ -4,13 +4,13 @@ Router | Chicane - +

Router

The following cover the API exposed by a Router (check out how to create one).

Router.{RouteName}​

-

The Router has one per route. Takes the route params (if it has some), and returns a build URL.

+

The Router has one per route. Takes the route params (if it has some), and returns a built URL.

  • params: Required params for the route.
diff --git a/server-side-rendering/index.html b/server-side-rendering/index.html index 7c9c7065..e8311b6f 100644 --- a/server-side-rendering/index.html +++ b/server-side-rendering/index.html @@ -4,7 +4,7 @@ Server-side rendering | Chicane - + diff --git a/top-level-api/index.html b/top-level-api/index.html index 22b227f1..2ee3086c 100644 --- a/top-level-api/index.html +++ b/top-level-api/index.html @@ -4,7 +4,7 @@ Top-level API | Chicane - +