Skip to content

feat(QwikCityMockProvider): custom loaders & actions mocks #8102

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
+387 −9
Open

feat(QwikCityMockProvider): custom loaders & actions mocks #8102

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
287f18d
feat(QwikCityMockProvider): custom loaders mocks
alexismch Oct 29, 2025
e6a6463
docs(qwik-city): loaders mocking
alexismch Oct 29, 2025
800097b
docs(qwik-city api): describe new loaders prop of QwikCityMockProps
alexismch Oct 29, 2025
4bb9590
chore: changeset
alexismch Oct 29, 2025
3840f02
refactor(QwikCityMockProvider): loaders prop type
alexismch Oct 30, 2025
ba7a5b5
feat(QwikCityMockProvider): custom actions mocks
alexismch Oct 31, 2025
59a1549
Merge branch 'main' of github.com:alexismch/qwik into qwik-city-mock-…
alexismch Nov 3, 2025
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
Prev Previous commit
Next Next commit
refactor(QwikCityMockProvider): loaders prop type
  • Loading branch information
@alexismch
alexismch committed Oct 30, 2025
commit 3840f02c95b67116fe07fd6cec1ccd44d03bc022
2 changes: 1 addition & 1 deletion packages/docs/src/routes/api/qwik-city/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@
}
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityMockProps \n```\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[goto?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[RouteNavigate](#routenavigate)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[loaders?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ loader: LoaderConstructor; data: any; }\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[params?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[url?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"content": "```typescript\nexport interface QwikCityMockProps \n```\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[goto?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[RouteNavigate](#routenavigate)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[loaders?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nArray&lt;{ loader: [Loader](#loader_2)<!-- -->&lt;any&gt;; data: any; }&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[params?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[url?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/runtime/src/qwik-city-component.tsx",
"mdFile": "qwik-city.qwikcitymockprops.md"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/api/qwik-city/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1785,7 +1785,7 @@ _(Optional)_

</td><td>

\{ loader: LoaderConstructor; data: any; }[]
Array&lt;\{ loader: [Loader](#loader_2)&lt;any&gt;; data: any; }&gt;

</td><td>

Expand Down
11 changes: 6 additions & 5 deletions packages/qwik-city/src/runtime/src/qwik-city-component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ import type {
Editable,
EndpointResponse,
LoadedRoute,
LoaderConstructor,
Loader,
LoaderInternal,
MutableRouteLocation,
PageModule,
PreventNavigateCallback,
Expand Down Expand Up @@ -662,10 +663,10 @@ export interface QwikCityMockProps {
url?: string;
params?: Record<string, string>;
goto?: RouteNavigate;
loaders?: {
loader: LoaderConstructor;
loaders?: Array<{
loader: Loader<any>;
data: any;
}[];
}>;
}

/** @public */
Expand All @@ -684,7 +685,7 @@ export const QwikCityMockProvider = component$<QwikCityMockProps>((props) => {

const loaderState = useStore(
props.loaders?.reduce(
(acc, { loader, data }) => ({ ...acc, [(loader as any).__id]: data }),
(acc, { loader, data }) => ({ ...acc, [(loader as LoaderInternal).__id]: data }),
{} as Record<string, any>
) ?? {},
{ deep: false }
Expand Down
6 changes: 3 additions & 3 deletions packages/qwik-city/src/runtime/src/qwik-city.runtime.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,10 +333,10 @@ export interface QwikCityMockProps {
// (undocumented)
goto?: RouteNavigate;
// (undocumented)
loaders?: {
loader: LoaderConstructor;
loaders?: Array<{
loader: Loader_2<any>;
data: any;
}[];
}>;
// (undocumented)
params?: Record<string, string>;
// (undocumented)
Expand Down
Loading