Due to an update to @types/react, certain intrinsic HTML element type have been updated to remove unsupported props, namely:
Removing crossOrigin from <input> and <textarea>
Removing placeholder from <h1>, <h2>, etc.
This means that if a consumer of this package were to upgrade their @types/react, while this package retains the older types, usages of components such as <TextInput> and <Heading> would be met with type errors complaining about missing those props that have been removed.
The more correct solution here would be to update the @types/react package in THIS package, we cannot do so because it causes similar errors stemming from ariakit, which is not trivial to upgrade.
As an interim solution, we are explicitly excluding those removed props from affected Reactist component props.
PR Checklist
[ ] Added tests for bugs / new features
[ ] Updated docs (storybooks, readme)
[x] Executed npm run validate and made sure no errors / warnings were shown
[x] Described changes in CHANGELOG.md
[x] Bumped version in package.json and package-lock.json (npm --no-git-tag-version version <major|minor|patch>) ref
[ ] Reviewed and approved Chromatic visual regression tests in CI
Versioning
This is technically a breaking change, as the interface of many components has changed.
Relates to:
Short description
Due to an update to
@types/react
, certain intrinsic HTML element type have been updated to remove unsupported props, namely:crossOrigin
from<input>
and<textarea>
placeholder
from<h1>
,<h2>
, etc.This means that if a consumer of this package were to upgrade their
@types/react
, while this package retains the older types, usages of components such as<TextInput>
and<Heading>
would be met with type errors complaining about missing those props that have been removed.The more correct solution here would be to update the
@types/react
package in THIS package, we cannot do so because it causes similar errors stemming fromariakit
, which is not trivial to upgrade.As an interim solution, we are explicitly excluding those removed props from affected Reactist component props.
PR Checklist
npm run validate
and made sure no errors / warnings were shownCHANGELOG.md
package.json
andpackage-lock.json
(npm --no-git-tag-version version <major|minor|patch>
) refVersioning
This is technically a breaking change, as the interface of many components has changed.