Skip to content

Allow passing in routerProps to <StartClient #1026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 29, 2023
Merged

Allow passing in routerProps to <StartClient #1026

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dbd6231
Allow passing in `routerProps` to `<StartClient`
devinrhode2 Aug 23, 2023
c7e4177
Fix type error in `islands/entry-client.ts`
devinrhode2 Aug 23, 2023
db1848d
Merge branch 'main' into allow-passing-routerProps-through-StartClient
ryansolid Aug 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions packages/start/entry-client/StartClient.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,22 @@ function throwClientError(field: string): any {
);
}

export default () => {
export default ({
routerProps
}: {
/**
* Override props passed to `<Router`.
*
* Only `source` is supported today.
*
* If you need to pass in other props, please submit a PR.
*/
// Before actually submitting a PR, you can test out the new prop like so:
// import type { RouterProps } from "@solidjs/router";
// const routerProps = { newProp } as RouterProps;
// <StartClient routerProps={routerProps as unknown as undefined} />
routerProps?: Pick<RouterProps, 'source'>
} = {}) => {
let mockFetchEvent: PageEvent = {
get request() {
if (process.env.NODE_ENV === "development") {
Expand Down Expand Up @@ -95,7 +110,7 @@ export default () => {
return (
<ServerContext.Provider value={mockFetchEvent}>
<MetaProvider>
<StartRouter base={basePath} data={dataFn}>
<StartRouter base={basePath} data={dataFn} {...routerProps}>
<Root />
</StartRouter>
</MetaProvider>
Expand Down