vike-react 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/renderer/+config.d.ts +2 -2
- package/dist/renderer/+config.js +1 -1
- package/dist/renderer/PageContextProvider.d.ts +9 -9
- package/dist/renderer/getPageElement.d.ts +1 -1
- package/dist/renderer/getTitle.d.ts +1 -1
- package/dist/renderer/onRenderClient.d.ts +1 -1
- package/dist/renderer/onRenderHtml.d.ts +2 -2
- package/dist/renderer/onRenderHtml.js +1 -1
- package/package.json +10 -11
package/README.md
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
<!-- WARNING: keep links absolute in this file so they work on NPM too -->
|
2
2
|
|
3
|
-
[<img src="https://avatars.githubusercontent.com/u/86403530?s=200&v=4" align="right" width="64" height="64">](https://
|
3
|
+
[<img src="https://avatars.githubusercontent.com/u/86403530?s=200&v=4" align="right" width="64" height="64">](https://vike.dev)
|
4
4
|
[](https://www.npmjs.com/package/vike-react)
|
5
5
|
|
6
6
|
# `vike-react`
|
7
7
|
|
8
|
-
React integration for [Vike](https://github.com/
|
9
|
-
[V1 design](https://
|
8
|
+
React integration for [Vike](https://github.com/vikejs/vike/issues/736) (using the
|
9
|
+
[V1 design](https://vike.dev/migration/v1-design)).
|
10
10
|
|
11
|
-
> For integrations with Vue and Solid, see the other [`vike-*` packages](https://
|
11
|
+
> For integrations with Vue and Solid, see the other [`vike-*` packages](https://vike.dev/vike-packages).
|
12
12
|
|
13
13
|
See [examples/](https://github.com/vikejs/vike-react/tree/main/examples).
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import type { ConfigEffect } from '
|
1
|
+
import type { ConfigEffect } from 'vike/types';
|
2
2
|
declare const _default: {
|
3
3
|
onRenderHtml: "import:vike-react/renderer/onRenderHtml";
|
4
4
|
onRenderClient: "import:vike-react/renderer/onRenderClient";
|
@@ -59,7 +59,7 @@ declare global {
|
|
59
59
|
* If false, render mode is SPA. In other words, the page will only be
|
60
60
|
* rendered in the browser.
|
61
61
|
*
|
62
|
-
* See https://
|
62
|
+
* See https://vike.dev/render-modes
|
63
63
|
*
|
64
64
|
* @default true
|
65
65
|
*
|
package/dist/renderer/+config.js
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
// Depending on the value of `config.meta.ssr`, set other config options' `env`
|
2
2
|
// accordingly.
|
3
|
-
// See https://
|
3
|
+
// See https://vike.dev/meta#modify-existing-configurations
|
4
4
|
const toggleSsrRelatedConfig = ({ configDefinedAt, configValue }) => {
|
5
5
|
if (typeof configValue !== 'boolean') {
|
6
6
|
throw new Error(`${configDefinedAt} should be a boolean`);
|
@@ -1,19 +1,19 @@
|
|
1
1
|
export { PageContextProvider };
|
2
2
|
export { usePageContext };
|
3
3
|
import React from 'react';
|
4
|
-
import type { PageContext } from '
|
4
|
+
import type { PageContext } from 'vike/types';
|
5
5
|
declare function PageContextProvider({ pageContext, children }: {
|
6
6
|
pageContext: PageContext;
|
7
7
|
children: React.ReactNode;
|
8
|
-
}): JSX.Element;
|
8
|
+
}): React.JSX.Element;
|
9
9
|
/** Access the pageContext from any React component */
|
10
10
|
declare function usePageContext(): (Partial<{
|
11
11
|
Page: unknown;
|
12
12
|
routeParams: Record<string, string>;
|
13
|
-
config: import("
|
14
|
-
configEntries: import("
|
13
|
+
config: import("vike/dist/esm/shared/page-configs/Config/PageContextConfig.js").PageContextConfig;
|
14
|
+
configEntries: import("vike/dist/esm/shared/getPageFiles/getExports.js").ConfigEntries;
|
15
15
|
exports: Record<string, unknown>;
|
16
|
-
exportsAll: import("
|
16
|
+
exportsAll: import("vike/dist/esm/shared/getPageFiles/getExports.js").ExportsAll;
|
17
17
|
urlOriginal: string;
|
18
18
|
is404: boolean | null;
|
19
19
|
isClientSideNavigation: boolean;
|
@@ -25,10 +25,10 @@ declare function usePageContext(): (Partial<{
|
|
25
25
|
}> & Pick<{
|
26
26
|
Page: unknown;
|
27
27
|
routeParams: Record<string, string>;
|
28
|
-
config: import("
|
29
|
-
configEntries: import("
|
28
|
+
config: import("vike/dist/esm/shared/page-configs/Config/PageContextConfig.js").PageContextConfig;
|
29
|
+
configEntries: import("vike/dist/esm/shared/getPageFiles/getExports.js").ConfigEntries;
|
30
30
|
exports: Record<string, unknown>;
|
31
|
-
exportsAll: import("
|
31
|
+
exportsAll: import("vike/dist/esm/shared/getPageFiles/getExports.js").ExportsAll;
|
32
32
|
urlOriginal: string;
|
33
33
|
is404: boolean | null;
|
34
34
|
isClientSideNavigation: boolean;
|
@@ -40,4 +40,4 @@ declare function usePageContext(): (Partial<{
|
|
40
40
|
}, "Page" | "pageExports" | "config" | "configEntries" | "exports" | "exportsAll" | "abortReason"> & {
|
41
41
|
isHydration: boolean;
|
42
42
|
isBackwardNavigation: boolean | null;
|
43
|
-
} & import("
|
43
|
+
} & import("vike/dist/esm/shared/addUrlComputedProps.js").PageContextUrlComputedPropsClient & Vike.PageContext) | import("vike/dist/esm/shared/types.js").PageContextServer;
|
@@ -1,5 +1,5 @@
|
|
1
1
|
export default onRenderHtml;
|
2
|
-
import type { PageContext } from '
|
2
|
+
import type { PageContext } from 'vike/types';
|
3
3
|
declare function onRenderHtml(pageContext: PageContext): Promise<{
|
4
|
-
documentHtml: import("
|
4
|
+
documentHtml: import("vike/dist/esm/node/runtime/html/renderHtml.js").TemplateWrapped;
|
5
5
|
}>;
|
@@ -1,6 +1,6 @@
|
|
1
1
|
export default onRenderHtml;
|
2
2
|
import { renderToString } from 'react-dom/server';
|
3
|
-
import { escapeInject, dangerouslySkipEscape } from '
|
3
|
+
import { escapeInject, dangerouslySkipEscape } from 'vike/server';
|
4
4
|
import { getTitle } from './getTitle.js';
|
5
5
|
import { getPageElement } from './getPageElement.js';
|
6
6
|
import { PageContextProvider } from './PageContextProvider.js';
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "vike-react",
|
3
|
-
"version": "0.
|
3
|
+
"version": "0.3.0",
|
4
4
|
"type": "module",
|
5
5
|
"main": "./dist/renderer/+config.js",
|
6
6
|
"types": "./dist/renderer/+config.d.ts",
|
@@ -10,7 +10,6 @@
|
|
10
10
|
"./renderer/onRenderClient": "./dist/renderer/onRenderClient.js",
|
11
11
|
"./usePageContext": "./dist/components/usePageContext.js"
|
12
12
|
},
|
13
|
-
"dependencies": {},
|
14
13
|
"scripts": {
|
15
14
|
"dev": "tsc --watch",
|
16
15
|
"build": "rm -rf dist/ && tsc",
|
@@ -20,18 +19,18 @@
|
|
20
19
|
"peerDependencies": {
|
21
20
|
"react": "18.x.x",
|
22
21
|
"react-dom": "18.x.x",
|
23
|
-
"
|
24
|
-
"vite
|
22
|
+
"vike": "^0.4.142",
|
23
|
+
"vite": "^4.3.8"
|
25
24
|
},
|
26
25
|
"devDependencies": {
|
27
26
|
"@brillout/release-me": "^0.1.7",
|
28
|
-
"@types/node": "^18.
|
29
|
-
"@types/react": "^18.
|
30
|
-
"@types/react-dom": "^18.
|
31
|
-
"react": "^18.
|
32
|
-
"react-dom": "^18.
|
33
|
-
"typescript": "^5.
|
34
|
-
"
|
27
|
+
"@types/node": "^18.17.18",
|
28
|
+
"@types/react": "^18.2.22",
|
29
|
+
"@types/react-dom": "^18.2.7",
|
30
|
+
"react": "^18.2.0",
|
31
|
+
"react-dom": "^18.2.0",
|
32
|
+
"typescript": "^5.2.2",
|
33
|
+
"vike": "^0.4.142"
|
35
34
|
},
|
36
35
|
"typesVersions": {
|
37
36
|
"*": {
|