Skip to content
On this page

MarkdownViewer

Displays rendered Markdown and facilitates interaction.
  • Draft
  • Review pending by accessibility team
On this page
import {MarkdownViewer} from '@primer/react/drafts'

The MarkdownViewer displays rendered Markdown and handles interaction (link clicking and checkbox checking/unchecking) with that content.

Examples

Simple Example

Checkbox Interaction Example

Status

Alpha

  • Component props are documented on primer.style/react.
  • Component does not have any unnecessary third-party dependencies.
  • Component can adapt to different themes.
  • Component can adapt to different screen sizes.
  • Component has 100% test coverage.

Beta

  • Component is used in a production application.
  • Common usage examples are documented on primer.style/react.
  • Common usage examples are documented in storybook stories.
  • Component has been reviewed by a systems designer and any resulting issues have been addressed.
  • Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Stable

  • Component API has been stable with no breaking changes for at least one month.
  • Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
  • Component has corresponding design guidelines documented in the interface guidelines.
  • Component has corresponding Figma component in the Primer Web library.