UNPKG

@tanstack/solid-router

Version:

Modern and scalable routing for Solid applications

1 lines 13 kB
{"version":3,"file":"Matches.cjs","names":["Solid","replaceEqualDeep","rootRouteId","isServer","CatchBoundary","ErrorComponent","useRouter","Transitioner","nearestMatchContext","SafeFragment","Match","AnyRoute","AnyRouter","DeepPartial","Expand","MakeOptionalPathParams","MakeOptionalSearchParams","MakeRouteMatchUnion","MaskOptions","MatchRouteOptions","RegisteredRouter","ResolveRoute","ToSubOptionsProps","RouteMatchExtensions","meta","Array","JSX","IntrinsicElements","links","scripts","styles","headScripts","Matches","router","ResolvedSuspense","document","ssr","Suspense","rootRoute","routesById","PendingComponent","options","pendingComponent","defaultPendingComponent","OptionalWrapper","InnerWrap","_$createComponent","children","fallback","MatchesInner","matchId","stores","firstId","get","routeId","undefined","match","getRouteMatchStore","hasPendingMatch","Boolean","pendingRouteIds","resetKey","loadedAt","nearestMatch","hasPending","matchComponent","Show","when","Provider","value","_$memo","disableGlobalCatchBoundary","getResetKey","errorComponent","onCatch","process","env","NODE_ENV","error","console","warn","message","toString","UseMatchRouteOptions","TFrom","TRouter","TTo","TMaskFrom","TMaskTo","useMatchRoute","opts","Accessor","createMemo","pending","caseSensitive","fuzzy","includeSearch","rest","matchRouteDeps","matchRoute","MakeMatchRouteOptions","params","Element","MatchRoute","props","renderedChild","matchedParams","child","UseMatchesBaseOptions","select","matches","TSelected","UseMatchesResult","useMatches","prev","res","useParentMatches","contextMatchId","useContext","slice","findIndex","d","id","useChildMatches"],"sources":["../../src/Matches.tsx"],"sourcesContent":["import * as Solid from 'solid-js'\nimport { replaceEqualDeep, rootRouteId } from '@tanstack/router-core'\nimport { isServer } from '@tanstack/router-core/isServer'\nimport { CatchBoundary, ErrorComponent } from './CatchBoundary'\nimport { useRouter } from './useRouter'\nimport { Transitioner } from './Transitioner'\nimport { nearestMatchContext } from './matchContext'\nimport { SafeFragment } from './SafeFragment'\nimport { Match } from './Match'\nimport type {\n AnyRoute,\n AnyRouter,\n DeepPartial,\n Expand,\n MakeOptionalPathParams,\n MakeOptionalSearchParams,\n MakeRouteMatchUnion,\n MaskOptions,\n MatchRouteOptions,\n RegisteredRouter,\n ResolveRoute,\n ToSubOptionsProps,\n} from '@tanstack/router-core'\n\ndeclare module '@tanstack/router-core' {\n export interface RouteMatchExtensions {\n meta?: Array<Solid.JSX.IntrinsicElements['meta'] | undefined>\n links?: Array<Solid.JSX.IntrinsicElements['link'] | undefined>\n scripts?: Array<Solid.JSX.IntrinsicElements['script'] | undefined>\n styles?: Array<Solid.JSX.IntrinsicElements['style'] | undefined>\n headScripts?: Array<Solid.JSX.IntrinsicElements['script'] | undefined>\n }\n}\n\nexport function Matches() {\n const router = useRouter()\n\n const ResolvedSuspense =\n (isServer ?? router.isServer) ||\n (typeof document !== 'undefined' && router.ssr)\n ? SafeFragment\n : Solid.Suspense\n\n const rootRoute: () => AnyRoute = () => router.routesById[rootRouteId]\n const PendingComponent =\n rootRoute().options.pendingComponent ??\n router.options.defaultPendingComponent\n\n const OptionalWrapper = router.options.InnerWrap || SafeFragment\n\n return (\n <OptionalWrapper>\n <ResolvedSuspense\n fallback={PendingComponent ? <PendingComponent /> : null}\n >\n <Transitioner />\n <MatchesInner />\n </ResolvedSuspense>\n </OptionalWrapper>\n )\n}\n\nfunction MatchesInner() {\n const router = useRouter()\n const matchId = () => router.stores.firstId.get()\n const routeId = () => (matchId() ? rootRouteId : undefined)\n const match = () =>\n routeId() ? router.stores.getRouteMatchStore(rootRouteId).get() : undefined\n const hasPendingMatch = () =>\n routeId()\n ? Boolean(router.stores.pendingRouteIds.get()[rootRouteId])\n : false\n const resetKey = () => router.stores.loadedAt.get()\n const nearestMatch = {\n matchId,\n routeId,\n match,\n hasPending: hasPendingMatch,\n }\n\n const matchComponent = () => {\n return (\n <Solid.Show when={matchId()}>\n <Match matchId={matchId()!} />\n </Solid.Show>\n )\n }\n\n return (\n <nearestMatchContext.Provider value={nearestMatch}>\n {router.options.disableGlobalCatchBoundary ? (\n matchComponent()\n ) : (\n <CatchBoundary\n getResetKey={() => resetKey()}\n errorComponent={ErrorComponent}\n onCatch={\n process.env.NODE_ENV !== 'production'\n ? (error) => {\n console.warn(\n `Warning: The following error wasn't caught by any route! At the very least, consider setting an 'errorComponent' in your RootRoute!`,\n )\n console.warn(`Warning: ${error.message || error.toString()}`)\n }\n : undefined\n }\n >\n {matchComponent()}\n </CatchBoundary>\n )}\n </nearestMatchContext.Provider>\n )\n}\n\nexport type UseMatchRouteOptions<\n TRouter extends AnyRouter = RegisteredRouter,\n TFrom extends string = string,\n TTo extends string | undefined = undefined,\n TMaskFrom extends string = TFrom,\n TMaskTo extends string = '',\n> = ToSubOptionsProps<TRouter, TFrom, TTo> &\n DeepPartial<MakeOptionalSearchParams<TRouter, TFrom, TTo>> &\n DeepPartial<MakeOptionalPathParams<TRouter, TFrom, TTo>> &\n MaskOptions<TRouter, TMaskFrom, TMaskTo> &\n MatchRouteOptions\n\nexport function useMatchRoute<TRouter extends AnyRouter = RegisteredRouter>() {\n const router = useRouter()\n\n return <\n const TFrom extends string = string,\n const TTo extends string | undefined = undefined,\n const TMaskFrom extends string = TFrom,\n const TMaskTo extends string = '',\n >(\n opts: UseMatchRouteOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>,\n ): Solid.Accessor<\n false | Expand<ResolveRoute<TRouter, TFrom, TTo>['types']['allParams']>\n > => {\n return Solid.createMemo(() => {\n const { pending, caseSensitive, fuzzy, includeSearch, ...rest } = opts\n\n router.stores.matchRouteDeps.get()\n return router.matchRoute(rest as any, {\n pending,\n caseSensitive,\n fuzzy,\n includeSearch,\n })\n })\n }\n}\n\nexport type MakeMatchRouteOptions<\n TRouter extends AnyRouter = RegisteredRouter,\n TFrom extends string = string,\n TTo extends string | undefined = undefined,\n TMaskFrom extends string = TFrom,\n TMaskTo extends string = '',\n> = UseMatchRouteOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & {\n // If a function is passed as a child, it will be given the `isActive` boolean to aid in further styling on the element it returns\n children?:\n | ((\n params?: Expand<\n ResolveRoute<TRouter, TFrom, TTo>['types']['allParams']\n >,\n ) => Solid.JSX.Element)\n | Solid.JSX.Element\n}\n\nexport function MatchRoute<\n TRouter extends AnyRouter = RegisteredRouter,\n const TFrom extends string = string,\n const TTo extends string | undefined = undefined,\n const TMaskFrom extends string = TFrom,\n const TMaskTo extends string = '',\n>(props: MakeMatchRouteOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>): any {\n const matchRoute = useMatchRoute()\n const params = matchRoute(props as any)\n\n const renderedChild = Solid.createMemo(() => {\n const matchedParams = params()\n const child = props.children\n\n if (typeof child === 'function') {\n return (child as any)(matchedParams)\n }\n\n return matchedParams ? child : null\n })\n\n return <>{renderedChild()}</>\n}\n\nexport interface UseMatchesBaseOptions<TRouter extends AnyRouter, TSelected> {\n select?: (matches: Array<MakeRouteMatchUnion<TRouter>>) => TSelected\n}\n\nexport type UseMatchesResult<\n TRouter extends AnyRouter,\n TSelected,\n> = unknown extends TSelected ? Array<MakeRouteMatchUnion<TRouter>> : TSelected\n\nexport function useMatches<\n TRouter extends AnyRouter = RegisteredRouter,\n TSelected = unknown,\n>(\n opts?: UseMatchesBaseOptions<TRouter, TSelected>,\n): Solid.Accessor<UseMatchesResult<TRouter, TSelected>> {\n const router = useRouter<TRouter>()\n return Solid.createMemo((prev: TSelected | undefined) => {\n const matches = router.stores.matches.get() as Array<\n MakeRouteMatchUnion<TRouter>\n >\n const res = opts?.select ? opts.select(matches) : matches\n if (prev === undefined) return res\n return replaceEqualDeep(prev, res) as any\n }) as Solid.Accessor<UseMatchesResult<TRouter, TSelected>>\n}\n\nexport function useParentMatches<\n TRouter extends AnyRouter = RegisteredRouter,\n TSelected = unknown,\n>(\n opts?: UseMatchesBaseOptions<TRouter, TSelected>,\n): Solid.Accessor<UseMatchesResult<TRouter, TSelected>> {\n const contextMatchId = Solid.useContext(nearestMatchContext).matchId\n\n return useMatches({\n select: (matches: Array<MakeRouteMatchUnion<TRouter>>) => {\n matches = matches.slice(\n 0,\n matches.findIndex((d) => d.id === contextMatchId()),\n )\n return opts?.select ? opts.select(matches) : matches\n },\n } as any)\n}\n\nexport function useChildMatches<\n TRouter extends AnyRouter = RegisteredRouter,\n TSelected = unknown,\n>(\n opts?: UseMatchesBaseOptions<TRouter, TSelected>,\n): Solid.Accessor<UseMatchesResult<TRouter, TSelected>> {\n const contextMatchId = Solid.useContext(nearestMatchContext).matchId\n\n return useMatches({\n select: (matches: Array<MakeRouteMatchUnion<TRouter>>) => {\n matches = matches.slice(\n matches.findIndex((d) => d.id === contextMatchId()) + 1,\n )\n return opts?.select ? opts.select(matches) : matches\n },\n } as any)\n}\n"],"mappings":";;;;;;;;;;;;;AAkCA,SAAgBgC,UAAU;CACxB,MAAMC,SAAS3B,kBAAAA,UAAU;CAEzB,MAAM4B,oBACH/B,+BAAAA,YAAY8B,OAAO9B,aACnB,OAAOgC,aAAa,eAAeF,OAAOG,MACvC3B,qBAAAA,eACAT,SAAMqC;CAEZ,MAAMC,kBAAkCL,OAAOM,WAAWrC,sBAAAA;CAC1D,MAAMsC,mBACJF,UAAU,EAAEG,QAAQC,oBACpBT,OAAOQ,QAAQE;CAIjB,QAAA,GAAA,aAAA,iBAFwBV,OAAOQ,QAAQI,aAAapC,qBAAAA,cAGlC,EAAA,IAAAsC,WAAA;EAAA,QAAA,GAAA,aAAA,iBACbb,kBAAgB;GAAA,IACfc,WAAQ;IAAA,OAAER,oBAAAA,GAAAA,aAAAA,iBAAoBA,kBAAgB,CAAA,CAAA,IAAM;GAAI;GAAA,IAAAO,WAAA;IAAA,OAAA,EAAA,GAAA,aAAA,iBAEvDxC,qBAAAA,cAAY,CAAA,CAAA,IAAA,GAAA,aAAA,iBACZ0C,cAAY,CAAA,CAAA,CAAA;GAAA;EAAA,CAAA;CAAA,EAAA,CAAA;AAIrB;AAEA,SAASA,eAAe;CACtB,MAAMhB,SAAS3B,kBAAAA,UAAU;CACzB,MAAM4C,gBAAgBjB,OAAOkB,OAAOC,QAAQC,IAAI;CAChD,MAAMC,gBAAiBJ,QAAQ,IAAIhD,sBAAAA,cAAcqD,KAAAA;CACjD,MAAMC,cACJF,QAAQ,IAAIrB,OAAOkB,OAAOM,mBAAmBvD,sBAAAA,WAAW,EAAEmD,IAAI,IAAIE,KAAAA;CACpE,MAAMG,wBACJJ,QAAQ,IACJK,QAAQ1B,OAAOkB,OAAOS,gBAAgBP,IAAI,EAAEnD,sBAAAA,YAAY,IACxD;CACN,MAAM2D,iBAAiB5B,OAAOkB,OAAOW,SAAST,IAAI;CAClD,MAAMU,eAAe;EACnBb;EACAI;EACAE;EACAQ,YAAYN;CACd;CAEA,MAAMO,uBAAuB;EAC3B,QAAA,GAAA,aAAA,iBACGjE,SAAMkE,MAAI;GAAA,IAACC,OAAI;IAAA,OAAEjB,QAAQ;GAAC;GAAA,IAAAH,WAAA;IAAA,QAAA,GAAA,aAAA,iBACxBrC,cAAAA,OAAK,EAAA,IAACwC,UAAO;KAAA,OAAEA,QAAQ;IAAE,EAAA,CAAA;GAAA;EAAA,CAAA;CAGhC;CAEA,QAAA,GAAA,aAAA,iBACG1C,qBAAAA,oBAAoB4D,UAAQ;EAACC,OAAON;EAAY,IAAAhB,WAAA;GAAA,QAAA,GAAA,aAAA,YAC9C,CAAA,CAAAd,OAAOQ,QAAQ8B,0BAA0B,EAAA,IACxCN,eAAe,KAAA,GAAA,aAAA,iBAEd7D,sBAAAA,eAAa;IACZoE,mBAAmBX,SAAS;IAC5BY,gBAAgBpE,sBAAAA;IAAc,IAC9BqE,UAAO;KAAA,OAAA,QAAA,IAAA,aACoB,gBACpBI,UAAU;MACTC,QAAQC,KACN,qIACF;MACAD,QAAQC,KAAK,YAAYF,MAAMG,WAAWH,MAAMI,SAAS,GAAG;KAC9D,IACA3B,KAAAA;IAAS;IAAA,IAAAR,WAAA;KAAA,OAGdkB,eAAe;IAAC;GAAA,CAAA;EAEpB;CAAA,CAAA;AAGP;AAcA,SAAgBwB,gBAA8D;CAC5E,MAAMxD,SAAS3B,kBAAAA,UAAU;CAEzB,QAMEoF,SAGG;EACH,OAAO1F,SAAM4F,iBAAiB;GAC5B,MAAM,EAAEC,SAASC,eAAeC,OAAOC,eAAe,GAAGC,SAASP;GAElEzD,OAAOkB,OAAO+C,eAAe7C,IAAI;GACjC,OAAOpB,OAAOkE,WAAWF,MAAa;IACpCJ;IACAC;IACAC;IACAC;GACF,CAAC;EACH,CAAC;CACH;AACF;AAmBA,SAAgBO,WAMdC,OAA4E;CAE5E,MAAMH,SADaZ,cACJU,EAAWK,KAAY;CAatC,QAAA,GAAA,aAAA,MAXsBxG,SAAM4F,iBAAiB;EAC3C,MAAMc,gBAAgBL,OAAO;EAC7B,MAAMM,QAAQH,MAAMzD;EAEpB,IAAI,OAAO4D,UAAU,YACnB,OAAQA,MAAcD,aAAa;EAGrC,OAAOA,gBAAgBC,QAAQ;CACjC,CAEUF,CAAa;AACzB;AAWA,SAAgBQ,WAIdvB,MACsD;CACtD,MAAMzD,SAAS3B,kBAAAA,UAAmB;CAClC,OAAON,SAAM4F,YAAYsB,SAAgC;EACvD,MAAMJ,UAAU7E,OAAOkB,OAAO2D,QAAQzD,IAAI;EAG1C,MAAM8D,MAAMzB,MAAMmB,SAASnB,KAAKmB,OAAOC,OAAO,IAAIA;EAClD,IAAII,SAAS3D,KAAAA,GAAW,OAAO4D;EAC/B,QAAA,GAAA,sBAAA,kBAAwBD,MAAMC,GAAG;CACnC,CAAC;AACH;AAEA,SAAgBC,iBAId1B,MACsD;CACtD,MAAM2B,iBAAiBrH,SAAMsH,WAAW9G,qBAAAA,mBAAmB,EAAE0C;CAE7D,OAAO+D,WAAW,EAChBJ,SAASC,YAAiD;EACxDA,UAAUA,QAAQS,MAChB,GACAT,QAAQU,WAAWC,MAAMA,EAAEC,OAAOL,eAAe,CAAC,CACpD;EACA,OAAO3B,MAAMmB,SAASnB,KAAKmB,OAAOC,OAAO,IAAIA;CAC/C,EACF,CAAQ;AACV;AAEA,SAAgBa,gBAIdjC,MACsD;CACtD,MAAM2B,iBAAiBrH,SAAMsH,WAAW9G,qBAAAA,mBAAmB,EAAE0C;CAE7D,OAAO+D,WAAW,EAChBJ,SAASC,YAAiD;EACxDA,UAAUA,QAAQS,MAChBT,QAAQU,WAAWC,MAAMA,EAAEC,OAAOL,eAAe,CAAC,IAAI,CACxD;EACA,OAAO3B,MAAMmB,SAASnB,KAAKmB,OAAOC,OAAO,IAAIA;CAC/C,EACF,CAAQ;AACV"}