Skip to content

fix: React 19 compatibility #1173

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 4 commits into from
Oct 30, 2024
Merged

fix: React 19 compatibility #1173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
70ce894
change peerdep to react 19
YousefED Oct 22, 2024
5d9fb0e
make sure react/jsx-runtime is not in bundle
YousefED Oct 22, 2024
aa620df
update docs
YousefED Oct 22, 2024
6058773
fix lint
YousefED Oct 22, 2024
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
2 changes: 1 addition & 1 deletion .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ module.exports = {
"error",
{
devDependencies: true,
peerDependencies: true,
optionalDependencies: false,
peerDependencies: false,
bundledDependencies: false,
},
],
Expand Down
16 changes: 14 additions & 2 deletions docs/pages/docs/advanced/nextjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,26 @@ export default function Editor() {

## Import as dynamic

Now, you can use [Dynamic Imports](https://nextjs.org/docs/pages/building-your-application/optimizing/lazy-loading) to make sure BlockNote is only imported on the client-side.
In the same directory, create a new file called `DyanmicEditor.tsx`:
Here, we will use [Dynamic Imports](https://nextjs.org/docs/pages/building-your-application/optimizing/lazy-loading) to make sure BlockNote is only imported on the client-side.

You can import the component we just created above using `next/dynamic` in your page:

```typescript jsx
"use client";

import dynamic from "next/dynamic";

const Editor = dynamic(() => import("../components/Editor"), { ssr: false });
export const Editor = dynamic(() => import("./Editor"), { ssr: false });
```

## Import in a page / app

Now, you can import the dynamic editor in your page or app:

```typescript jsx
import { Editor } from "../components/DynamicEditor";


function App() {
return (
Expand Down
83 changes: 42 additions & 41 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"@typescript-eslint/parser": "^5.5.0",
"eslint": "^8.22.0",
"eslint-config-react-app": "^7.0.0",
"eslint-plugin-import": "^2.28.0",
"eslint-plugin-import": "^2.31.0",
"glob": "^10.3.10",
"lerna": "^5.4.0",
"patch-package": "^6.4.7",
Expand All @@ -34,4 +34,4 @@
"postpublish": "rm -rf packages/core/README.md && rm -rf packages/react/README.md",
"clean": "lerna run --stream clean"
}
}
}
8 changes: 3 additions & 5 deletions packages/ariakit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@
"dependencies": {
"@ariakit/react": "^0.4.3",
"@blocknote/core": "^0.17.1",
"@blocknote/react": "^0.17.1",
"react": "^18",
"react-dom": "^18"
"@blocknote/react": "^0.17.1"
},
"devDependencies": {
"@types/react": "^18.0.25",
Expand All @@ -71,8 +69,8 @@
"vite-plugin-externalize-deps": "^0.8.0"
},
"peerDependencies": {
"react": "^18",
"react-dom": "^18"
"react": "18 - 19",
"react-dom": "18 - 19"
},
"eslintConfig": {
"extends": [
Expand Down
13 changes: 8 additions & 5 deletions packages/ariakit/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,14 @@ export default defineConfig((conf) => ({
rollupOptions: {
// make sure to externalize deps that shouldn't be bundled
// into your library
external: Object.keys({
...pkg.dependencies,
...pkg.peerDependencies,
...pkg.devDependencies,
}),
external: [
...Object.keys({
...pkg.dependencies,
...pkg.peerDependencies,
...pkg.devDependencies,
}),
"react/jsx-runtime",
],
output: {
// Provide global variables to use in the UMD build
// for externalized deps
Expand Down
6 changes: 2 additions & 4 deletions packages/mantine/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@
"@mantine/core": "^7.10.1",
"@mantine/hooks": "^7.10.1",
"@mantine/utils": "^6.0.21",
"react": "^18",
"react-dom": "^18",
"react-icons": "^5.2.1"
},
"devDependencies": {
Expand All @@ -74,8 +72,8 @@
"vite-plugin-externalize-deps": "^0.8.0"
},
"peerDependencies": {
"react": "^18",
"react-dom": "^18"
"react": "18 - 19",
"react-dom": "18 - 19"
},
"eslintConfig": {
"extends": [
Expand Down
13 changes: 8 additions & 5 deletions packages/mantine/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,14 @@ export default defineConfig((conf) => ({
rollupOptions: {
// make sure to externalize deps that shouldn't be bundled
// into your library
external: Object.keys({
...pkg.dependencies,
...pkg.peerDependencies,
...pkg.devDependencies,
}),
external: [
...Object.keys({
...pkg.dependencies,
...pkg.peerDependencies,
...pkg.devDependencies,
}),
"react/jsx-runtime",
],
output: {
// Provide global variables to use in the UMD build
// for externalized deps
Expand Down
6 changes: 2 additions & 4 deletions packages/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@
"@tiptap/core": "^2.7.1",
"@tiptap/react": "^2.7.1",
"lodash.merge": "^4.6.2",
"react": "^18",
"react-dom": "^18",
"react-icons": "^5.2.1"
},
"devDependencies": {
Expand All @@ -80,8 +78,8 @@
"vitest": "^2.0.3"
},
"peerDependencies": {
"react": "^18",
"react-dom": "^18"
"react": "18 - 19",
"react-dom": "18 - 19"
},
"eslintConfig": {
"extends": [
Expand Down
13 changes: 8 additions & 5 deletions packages/react/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,14 @@ export default defineConfig((conf) => ({
rollupOptions: {
// make sure to externalize deps that shouldn't be bundled
// into your library
external: Object.keys({
...pkg.dependencies,
...pkg.peerDependencies,
...pkg.devDependencies,
}),
external: [
...Object.keys({
...pkg.dependencies,
...pkg.peerDependencies,
...pkg.devDependencies,
}),
"react/jsx-runtime",
],
output: {
// Provide global variables to use in the UMD build
// for externalized deps
Expand Down
Loading
Loading