build-docs fails with React 19

[simoneguzzi]

Hi All 👋 Thank you for the neat tool you developed 😎 I just updated my project to React 19, and the build-docs script seems to have a problem with that.

Describe the bug

build-docs fails with React 19.

To Reproduce
Steps to reproduce the behavior:

1. I'm not using a config file
2. Doesn't seem to be relevant
3. node_modules/.bin/redocly build-docs your-openapi-schema.yaml
4. Error: Objects are not valid as a React child (found: object with keys {$$typeof, type, key, props, _owner, _store}). If you meant to render a collection of children, use an array instead.

Expected behavior

Script should run without errors.

Logs

❯ node_modules/.bin/redocly build-docs schema.yaml
Found undefined and using theme.openapi options
Prerendering docs
Error: Objects are not valid as a React child (found: object with keys {$$typeof, type, key, props, _owner, _store}). If you meant to render a collection of children, use an array instead.

OpenAPI description

Redocly Version(s)

❯ node_modules/.bin/redocly --version
1.26.0

Node.js Version(s)

❯ node --version
v20.13.1

OS, environment

macOS 15.1.1 (24B91)

Additional context

[rsshilli]

I'm having this problem and I don't have React declared at all. I see now the Redocly is pulling in the latest React and that's why I'm seeing this error.

Here's my patch to make it work:

Subject: [PATCH] Redocly failing on React 19
---
Index: package.json
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/package.json b/package.json
--- a/package.json	(revision 75b42621a61d9e66ca968586b48b02aa0a22956c)
+++ b/package.json	(date 1734369197008)
@@ -105,7 +105,8 @@
     "punycode": "1.4.1",
     "puppeteer-core": "15.3.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
     "resolve-url-loader": "4.0.0",
     "sass": "1.53.0",
     "sass-loader": "10.4.1",

[tatomyr]

Thanks for rising this issue!

@AlexVarchuk could you check if that's a Redoc issue? Does it support React 19 at all?

[AlexVarchuk]

Hi @tatomyr, I think it is a React 19 issue in Redoc. We'll look into it.