Fix the JSX runtime types in RunOptions #2465
Conversation
`@types/react` now has types for `react/jsx-runtime` and `react/jsx-dev-runtime`. These types are not compatible with the types provided by `hast-util-to-jsx-runtime`, which are used by MDX. To resolve the issue, all runtime related options have been changed to `unknown`. Since the user is supposed to pass in whatever JSX runtime they imported, this should be sufficient. This fixes several type errors. An outdated workaround has been removed from the documentation. Closes #2463
remcohaszing
added
🐛 type/bug
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| * Function to generate an element in development mode. | ||
| * @property {Jsx | null | undefined} [jsxs] |
There was a problem hiding this comment.
Should we at least use something like Function?
We could also improve the hast-util-to-jsx-runtime types?
Fixing the type error is nice, but removing all type errors around this, not so sure?
There was a problem hiding this comment.
We could use Function, or better: (type: any, props: any) => any.
We should improve hast-util-to-jsx-runtime, but personally I think this type isn’t worth having an extra dependency regardless.
There was a problem hiding this comment.
or better:
(type: any, props: any) => any.
Right, and even better would be an even more correct type. We do know a lot about props and key. And at that point, it’s nice to have the more complex type defined and tested in a single place?
Initial checklist
Description of changes
@types/reactnow has types forreact/jsx-runtimeandreact/jsx-dev-runtime. These types are not compatible with the types provided byhast-util-to-jsx-runtime, which are used by MDX.To resolve the issue, all runtime related options have been changed to
unknown. Since the user is supposed to pass in whatever JSX runtime they imported, this should be sufficient. This removes the dependency onhast-util-to-jsx-runtime.This fixes several type errors. An outdated workaround has been removed from the documentation.
Closes #2463