Installations
npm install @mdx-js/preact
Developer Guide
Typescript
Yes
Module System
ESM
Node Version
23.0.0
NPM Version
10.9.0
Score
75.3
Supply Chain
95
Quality
82.4
Maintenance
100
Vulnerability
100
License
Releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (100%)
Developer
Download Statistics
Total Downloads
1,296,588
Last Day
202
Last Week
1,378
Last Month
13,014
Last Year
356,929
GitHub Statistics
17,880 Stars
1,743 Commits
1,138 Forks
88 Watching
10 Branches
193 Contributors
Sponsor this package
Package Meta Information
Latest Version
3.1.0
Package Id
@mdx-js/preact@3.1.0
Unpacked Size
13.72 kB
Size
4.89 kB
File Count
9
NPM Version
10.9.0
Node Version
23.0.0
Publised On
18 Oct 2024
Total Downloads
Cumulative downloads
Total Downloads
1,296,588
Last day
-53.7%
202
Compared to previous day
Last week
-42.7%
1,378
Compared to previous week
Last month
-31.1%
13,014
Compared to previous month
Last year
-36.9%
356,929
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
@mdx-js/preact
Preact context for MDX.
Contents
- 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 Preact with MDX.
When should I use this?
This package is not needed for MDX to work with Preact. See ¶ MDX provider in § Using MDX for when and how to use an MDX provider.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install @mdx-js/preact
In Deno with esm.sh
:
1import {MDXProvider} from 'https://esm.sh/@mdx-js/preact@3'
In browsers with esm.sh
:
1<script type="module"> 2 import {MDXProvider} from 'https://esm.sh/@mdx-js/preact@3?bundle' 3</script>
Use
1/** 2 * @import {MDXComponents} from 'mdx/types.js' 3 */ 4 5import {MDXProvider} from '@mdx-js/preact' 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/preact'`. 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 ¶ Preact in § Getting started for how to get started with MDX and Preact. 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
frommdx/types.js
orMergeComponents
, 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
frommdx/types.js
) — current components from the context
Returns
Additional components (MDXComponents
from
mdx/types.js
).
Props
Configuration for MDXProvider
(TypeScript type).
Fields
children
(ComponentChildren
frompreact
, optional) — childrencomponents
(MDXComponents
frommdx/types.js
orMergeComponents
, optional) — additional components to use or a function that creates themdisableParentContext
(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
preact
.
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/preact@^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
![Empty State](/_next/static/media/empty.e5fae2e5.png)
No vulnerabilities found.
Reason
16 commit(s) and 15 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/mdx-js/.github/security.md:1
- Info: Found linked content: github.com/mdx-js/.github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/mdx-js/.github/security.md:1
- Info: Found text in security policy: github.com/mdx-js/.github/security.md:1
Reason
2 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
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:12: 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:13: 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:18: 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:21: 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
Reason
Found 0/28 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/website.yml:7
- Warn: no topLevel permission defined: .github/workflows/bb.yml:1
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Warn: no topLevel permission defined: .github/workflows/website.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 2 are checked with a SAST tool
Score
5.1
/10
Last Scanned on 2024-12-23
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