npmpackage.info

Gathering detailed insights and metrics for @mdx-js/react

Other packages similar to @mdx-js/react

@mdx-js/util

2.0.0

Deprecated: this package is no longer maintained.

@mdx-js/loader

3.1.0

Webpack loader for MDX

@mdx-js/esbuild

3.1.0

esbuild plugin for MDX

@mdx-js/rollup

3.1.0

Rollup plugin for MDX

Gathering detailed insights and metrics for @mdx-js/react

@mdx-js/react - 3.1.0 | npmpackage.info

@mdx-js/react

Markdown for the component era

3.1.0

18,598

MIT

JavaScript

14.05 kB

4.5

Installations

npm install @mdx-js/react

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

23.0.0

NPM Version

10.9.0 Pull Requests

Open

8

Total

1,439

Closed

327

Merged

1,104

Issues

Open

7

Total

683

Closed

676

Releases

119

3.1.0

Updated on Oct 18, 2024

3.0.1

Updated on Feb 12, 2024

3.0.0

Updated on Oct 24, 2023

2.3.0

Updated on Feb 09, 2023

2.2.1

Updated on Dec 14, 2022

2.2.0

Updated on Dec 14, 2022

View All 119 releases

Languages

JavaScript

MDX

JavaScript (100%)

Developer

mdx-js

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

18,598 Stars

1,762 Commits

1,160 Forks

88 Watchers

11 Branches

189 Contributors

Updated on Jul 12, 2025

Sponsor this package

https://opencollective.com/unified

Maintainers

View All 189 Contributors

Package Meta Information

Latest Version

3.1.0

Package Id

@mdx-js/react@3.1.0

Unpacked Size

14.05 kB

Size

5.03 kB

File Count

NPM Version

10.9.0

Node Version

23.0.0

Published on

Oct 18, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/mdx

Peer Dependencies

@types/react react

`@mdx-js/react`

React context for MDX.

What is this?
When should I use this?
Install
Use
API
Types
Compatibility
Security
Contribute
License

What is this?

This package is a context based components provider for combining React with MDX.

When should I use this?

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.

Install

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>

Use

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.

API

This package exports the identifiers MDXProvider and useMDXComponents. There is no default export.

`MDXProvider(properties?)`

Provider for MDX context.

Parameters

properties (Props) — configuration

Returns

Element (JSX.Element).

`useMDXComponents(components?)`

Get current components from the MDX Context.

Parameters

components (MDXComponents from mdx/types.js or MergeComponents, optional) — additional components to use or a function that creates them

Returns

Current components (MDXComponents from mdx/types.js).

`MergeComponents`

Custom merge function (TypeScript type).

Parameters

components (MDXComponents from mdx/types.js) — current components from the context

Returns

Additional components (MDXComponents from mdx/types.js).

`Props`

Configuration for MDXProvider (TypeScript type).

Fields

children (ReactNode from react, optional) — children
components (MDXComponents from mdx/types.js or MergeComponents, optional) — additional components to use or a function that creates them
disableParentContext (boolean, default: false) — turn off outer component context

Types

This 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.

Compatibility

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.

Security

See § Security on our website for information.

Contribute

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.

License

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

6

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Maintained

Determines if the project is "actively maintained".

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 4

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/bb.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/bb.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 3 out of 3 npmCommand dependencies pinned

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.5

/10

Last Scanned on 2025-07-07

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

Other packages similar to @mdx-js/react

Other packages similar to @mdx-js/react

@mdx-js/react

Installations

Developer Guide

Yes

ESM

23.0.0

10.9.0

Pull Requests

8

1,439

327

1,104

Issues

7

683

676

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

@mdx-js/react

Contents

What is this?

When should I use this?

Install

Use

API

MDXProvider(properties?)

Parameters

Returns

useMDXComponents(components?)

Parameters

Returns

MergeComponents

Parameters

Returns

Props

Fields

Types

Compatibility

Security

Contribute

License

10

10

10

10

6

5

4

1

0

0

0

0

0

4.5

/10

`@mdx-js/react`

`MDXProvider(properties?)`

`useMDXComponents(components?)`

`MergeComponents`

`Props`