Update prop types to allow for environment
to be an empty object (the default)
#1530
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What:
Allows for the
environment
type to be an empty object in both the propTypes and TypescriptWhy:
The default value of environment is set to an empty object ({}) during server-side rendering (or in any environment where window is undefined), but an empty object violated the shape defined for environment in prop types. This in turn triggers a console.warn.
How:
In #1525 it was suggested to remove
isRequired
from all properties ofenvironment
, but this had a few downsides:environment
is provided, it should be of the proper shapeInstead, I opted to allow for
environment
to be an empty object in both the propTypes and Typescript typings. However, ifenvironment
is specified (and not an empty object) it will be properly typed.Checklist:
Fixes #1525