vike-react 0.4.8 → 0.4.9

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/dist/+config.d.ts CHANGED
@@ -53,6 +53,11 @@ declare const _default: {
53
53
  server: true;
54
54
  };
55
55
  };
56
+ onBeforeRenderClient: {
57
+ env: {
58
+ client: true;
59
+ };
60
+ };
56
61
  onAfterRenderClient: {
57
62
  env: {
58
63
  client: true;
@@ -75,6 +80,12 @@ declare const _default: {
75
80
  config: true;
76
81
  };
77
82
  };
83
+ reactStrictMode: {
84
+ env: {
85
+ client: true;
86
+ server: true;
87
+ };
88
+ };
78
89
  };
79
90
  };
80
91
  export default _default;
package/dist/+config.js CHANGED
@@ -42,6 +42,9 @@ export default {
42
42
  _streamIsRequied: {
43
43
  env: { server: true }
44
44
  },
45
+ onBeforeRenderClient: {
46
+ env: { client: true }
47
+ },
45
48
  onAfterRenderClient: {
46
49
  env: { client: true }
47
50
  },
@@ -54,6 +57,9 @@ export default {
54
57
  // Vike already defines the setting 'name', but we redundantly define it here for older Vike versions (otherwise older Vike versions will complain that 'name` is an unknown config).
55
58
  name: {
56
59
  env: { config: true }
60
+ },
61
+ reactStrictMode: {
62
+ env: { client: true, server: true }
57
63
  }
58
64
  }
59
65
  };
@@ -6,11 +6,13 @@ function getPageElement(pageContext) {
6
6
  const Wrapper = pageContext.config.Wrapper ?? PassThrough;
7
7
  const VikeReactQueryWrapper = pageContext.config.VikeReactQueryWrapper ?? PassThrough;
8
8
  const { Page } = pageContext;
9
- const page = (React.createElement(React.StrictMode, null,
10
- React.createElement(PageContextProvider, { pageContext: pageContext },
11
- React.createElement(VikeReactQueryWrapper, { pageContext: pageContext },
12
- React.createElement(Wrapper, null,
13
- React.createElement(Layout, null, Page ? React.createElement(Page, null) : null))))));
9
+ let page = (React.createElement(PageContextProvider, { pageContext: pageContext },
10
+ React.createElement(VikeReactQueryWrapper, { pageContext: pageContext },
11
+ React.createElement(Wrapper, null,
12
+ React.createElement(Layout, null, Page ? React.createElement(Page, null) : null)))));
13
+ if (pageContext.config.reactStrictMode !== false) {
14
+ page = React.createElement(React.StrictMode, null, page);
15
+ }
14
16
  return page;
15
17
  }
16
18
  function PassThrough({ children }) {
@@ -5,14 +5,21 @@ import { getHeadSetting } from './getHeadSetting.js';
5
5
  import { getPageElement } from './getPageElement.js';
6
6
  let root;
7
7
  const onRenderClient = (pageContext) => {
8
+ // Use case:
9
+ // - Store hydration https://github.com/vikejs/vike-react/issues/110
10
+ pageContext.config.onBeforeRenderClient?.(pageContext);
8
11
  const page = getPageElement(pageContext);
9
12
  // TODO: implement this? So that, upon errors, onRenderClient() throws an error and Vike can render the error. As of April 2024 it isn't released yet.
10
13
  // - https://react-dev-git-fork-rickhanlonii-rh-root-options-fbopensource.vercel.app/reference/react-dom/client/createRoot#show-a-dialog-for-uncaught-errors
11
14
  // - https://react-dev-git-fork-rickhanlonii-rh-root-options-fbopensource.vercel.app/reference/react-dom/client/hydrateRoot#show-a-dialog-for-uncaught-errors
12
15
  const onUncaughtError = (_error, _errorInfo) => { };
13
16
  const container = document.getElementById('react-root');
14
- if (container.innerHTML !== '' && pageContext.isHydration) {
15
- // First render (hydration)
17
+ if (
18
+ // Whether the page was rendered to HTML. (I.e. whether the user set the [`ssr`](https://vike.dev/ssr) setting to `false`.)
19
+ container.innerHTML !== '' &&
20
+ // Whether the page was already rendered to HTML. (I.e. whether this is the first client-side rendering.)
21
+ pageContext.isHydration) {
22
+ // Hydration
16
23
  root = ReactDOM.hydrateRoot(container, page, {
17
24
  // @ts-expect-error
18
25
  onUncaughtError
@@ -44,6 +51,8 @@ const onRenderClient = (pageContext) => {
44
51
  }
45
52
  pageContext.page = page;
46
53
  pageContext.root = root;
54
+ // Use case:
55
+ // - Testing tool https://github.com/vikejs/vike-react/issues/95
47
56
  pageContext.config.onAfterRenderClient?.(pageContext);
48
57
  };
49
58
  // https://stackoverflow.com/questions/260857/changing-website-favicon-dynamically/260876#260876
@@ -16,9 +16,11 @@ const onRenderHtml = async (pageContext) => {
16
16
  const titleTag = !title ? '' : escapeInject `<title>${title}</title>`;
17
17
  const faviconTag = !favicon ? '' : escapeInject `<link rel="icon" href="${favicon}" />`;
18
18
  const Head = pageContext.config.Head || (() => React.createElement(React.Fragment, null));
19
- const head = (React.createElement(React.StrictMode, null,
20
- React.createElement(PageContextProvider, { pageContext: pageContext },
21
- React.createElement(Head, null))));
19
+ let head = (React.createElement(PageContextProvider, { pageContext: pageContext },
20
+ React.createElement(Head, null)));
21
+ if (pageContext.config.reactStrictMode !== false) {
22
+ head = React.createElement(React.StrictMode, null, head);
23
+ }
22
24
  const headHtml = dangerouslySkipEscape(renderToString(head));
23
25
  let pageView;
24
26
  if (!pageContext.Page) {
@@ -52,6 +52,16 @@ declare global {
52
52
  *
53
53
  */
54
54
  stream?: boolean;
55
+ /**
56
+ * Whether to use `<React.StrictMode>`, see https://react.dev/reference/react/StrictMode
57
+ *
58
+ * @default true
59
+ */
60
+ reactStrictMode?: boolean;
61
+ /**
62
+ * Client-side hook called before the page is rendered.
63
+ */
64
+ onBeforeRenderClient?: (pageContext: PageContextClient) => void;
55
65
  /**
56
66
  * Client-side hook called after the page is rendered.
57
67
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vike-react",
3
- "version": "0.4.8",
3
+ "version": "0.4.9",
4
4
  "type": "module",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -15,10 +15,10 @@
15
15
  },
16
16
  "scripts": {
17
17
  "dev": "tsc --watch",
18
- "build": "rm -rf dist/ && tsc",
19
- "release": "release-me --git-tag-prefix vike-react patch",
20
- "release:minor": "release-me --git-tag-prefix vike-react minor",
21
- "release:commit": "release-me --git-tag-prefix vike-react commit"
18
+ "build": "rimraf dist/ && tsc",
19
+ "release": "release-me patch",
20
+ "release:minor": "release-me minor",
21
+ "release:commit": "release-me commit"
22
22
  },
23
23
  "peerDependencies": {
24
24
  "react": "18.x.x",
@@ -28,12 +28,13 @@
28
28
  },
29
29
  "devDependencies": {
30
30
  "@biomejs/biome": "^1.6.4",
31
- "@brillout/release-me": "^0.2.1",
31
+ "@brillout/release-me": "^0.3.4",
32
32
  "@types/node": "^20.11.17",
33
33
  "@types/react": "^18.2.55",
34
34
  "@types/react-dom": "^18.2.19",
35
35
  "react": "^18.2.0",
36
36
  "react-dom": "^18.2.0",
37
+ "rimraf": "^5.0.5",
37
38
  "typescript": "^5.3.3",
38
39
  "vike": "^0.4.168"
39
40
  },