Description
Describe the bug
Hydration errors appear on Browser's Console with messages:
Uncaught Error: Minified React error
#418
; visit https://reactjs.org/docs/error-decoder.html?invariant=418 for the full message or use the non-minified dev environment for full errors and additional helpful warnings.
Uncaught Error: Minified React error#423
; visit https://reactjs.org/docs/error-decoder.html?invariant=423 for the full message or use the non-minified dev environment for full errors and additional helpful warnings.
To Reproduce
Steps to reproduce the behavior:
- Given this
redocly.yaml
file:
extends:
- recommended
apis:
main:
root: openapi.yaml
theme:
openapi:
hideDownloadButton: false
- And this OpenAPI file:
openapi: 3.0.3
info:
title: Sample API
version: 1.0.0
description: A simple example of OpenAPI with Redocly.
servers:
- url: https://api.example.com/v1
paths:
/hello:
get:
summary: Returns a greeting
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
message:
type: string
-
Run this command with these arguments:
Using @redocly/cli version 1.34.3 run:
redocly build-docs --disableGoogleFont openapi.yaml -o dist/index.html
-
See error
Serve the createddist/index.html
file and open it with a Browser (tested on Firefox and Chrome).
Choose toInspect
the created API Docs and go to the tabConsole
. The hydration messages (mentioned in the description above) will be reported. -
Repeat without the Download Button
SethideDownloadButton
to true in redocly.yaml and rebuild the docs:
redocly build-docs --disableGoogleFont openapi.yaml -o dist/index.html
Serve the static file and inspect it in your browser. No errors should be logged there.
Expected behavior
Download button does not cause any hydration errors.
Additional context
Redocly/redocly-cli#2113