Gathering detailed insights and metrics for @mdx-js/react
Gathering detailed insights and metrics for @mdx-js/react
Gathering detailed insights and metrics for @mdx-js/react
Gathering detailed insights and metrics for @mdx-js/react
npm install @mdx-js/react
Typescript
Module System
Node Version
NPM Version
JavaScript (100%)
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
MIT License
18,598 Stars
1,762 Commits
1,160 Forks
88 Watchers
11 Branches
189 Contributors
Updated on Jul 11, 2025
Latest Version
3.1.0
Package Id
@mdx-js/react@3.1.0
Unpacked Size
14.05 kB
Size
5.03 kB
File Count
9
NPM Version
10.9.0
Node Version
23.0.0
Published on
Oct 18, 2024
Cumulative downloads
Total Downloads
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
1
2
@mdx-js/react
React context for MDX.
This package is a context based components provider for combining React with MDX.
This package is not needed for MDX to work with React. See ¶ MDX provider in § Using MDX for when and how to use an MDX provider.
If you use Next.js, do not use this.
Add an mdx-components.tsx
(in src/
or /
) file instead.
See Configuring MDX on nextjs.org
for more info.
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install @mdx-js/react
In Deno with esm.sh
:
1import {MDXProvider} from 'https://esm.sh/@mdx-js/react@3'
In browsers with esm.sh
:
1<script type="module"> 2 import {MDXProvider} from 'https://esm.sh/@mdx-js/react@3?bundle' 3</script>
1/** 2 * @import {MDXComponents} from 'mdx/types.js' 3 */ 4 5import {MDXProvider} from '@mdx-js/react' 6import Post from './post.mdx' 7// ^-- Assumes an integration is used to compile MDX to JS, such as 8// `@mdx-js/esbuild`, `@mdx-js/loader`, `@mdx-js/node-loader`, or 9// `@mdx-js/rollup`, and that it is configured with 10// `options.providerImportSource: '@mdx-js/react'`. 11 12/** @type {MDXComponents} */ 13const components = { 14 em(properties) { 15 return <i {...properties} /> 16 } 17} 18 19console.log( 20 <MDXProvider components={components}> 21 <Post /> 22 </MDXProvider> 23)
👉 Note: you don’t have to use
MDXProvider
and can pass components directly:1-<MDXProvider components={components}> 2- <Post /> 3-</MDXProvider> 4+<Post components={components} />
See ¶ React in § Getting started for how to get started with MDX and React. See ¶ MDX provider in § Using MDX for how to use an MDX provider.
This package exports the identifiers MDXProvider
and
useMDXComponents
.
There is no default export.
MDXProvider(properties?)
Provider for MDX context.
properties
(Props
)
— configurationElement (JSX.Element
).
useMDXComponents(components?)
Get current components from the MDX Context.
components
(MDXComponents
from mdx/types.js
or MergeComponents
, optional)
— additional components to use or a function that creates themCurrent components (MDXComponents
from
mdx/types.js
).
MergeComponents
Custom merge function (TypeScript type).
components
(MDXComponents
from mdx/types.js
)
— current components from the contextAdditional components (MDXComponents
from
mdx/types.js
).
Props
Configuration for MDXProvider
(TypeScript type).
children
(ReactNode
from react
,
optional)
— childrencomponents
(MDXComponents
from mdx/types.js
or MergeComponents
, optional)
— additional components to use or a function that creates themdisableParentContext
(boolean
, default: false
)
— turn off outer component contextThis package is fully typed with TypeScript.
It exports the additional types MergeComponents
and
Props
.
For types to work, make sure the TypeScript JSX
namespace is typed.
This is done by installing and using the types of your framework, as in
@types/react
.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, @mdx-js/react@^3
,
compatible with Node.js 16.
See § Security on our website for information.
See § Contribute on our website for ways to get started. See § Support for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
security policy file detected
Details
Reason
4 existing vulnerabilities detected
Details
Reason
2 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 5
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
Reason
Found 4/28 approved changesets -- score normalized to 1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More