(@mdx-js/react) Where is the exported Components type?

[khinshankhan]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Affected packages and versions

@mdx-js/react^2.1.2

Link to runnable example

Steps to reproduce

Install the package @mdx-js/react and try to import mdx components type.

Expected behavior

Until recently I was on an old version of v1, which had MDXProviderComponentsProp as an available when using @types/mdx-js__react + https://mdxjs.com/packages/react/#types seemed to indicate it was exported? So, I expected there to be an export for Components.

Actual behavior

Components is not available

Seeing https://github.com/mdx-js/mdx/blob/main/packages/react/index.js didn't export it, I figured out after going through the package to install mdx/types and am now using MDXComponents ie import { MDXComponents } from "mdx/types";.

If this is the proper way to use the type, I think https://mdxjs.com/packages/react/#types might be a little misleading and could include the bit to install the package to use this type. Actually, it should probably link to https://mdxjs.com/docs/getting-started/#types?

Runtime

Node v16

Package manager

pnpm

OS

Linux

Build and bundle tools

Gatsby

[wooorm]

Types are in @types/mdx indeed, as documented in the Types section of the Getting started docs.
It is indeed correct that the docs for @mdx-js/react are out of date (and likely also for preact, vue). A PR improving them, including a link you mention, would be appreciated!

[wooorm]

@khinshankhan Interested in working on a PR?

[khinshankhan]

Sure. I only know + tested with react, so should I only update the react docs or just use generic terminology for all the frameworks?

[wooorm]

You can see that our packages for react, preact, and vue, each have the exact same types section.
Depending on what wording you think of for react, I don’t think it needs to be specific to React either, I am thus assuming that the same wording can be reused for the others!