readme.md

mobiledoc-jsx-renderer

Renders mobiledoc to JSX

Similar to mobiledoc-vdom-renderer but returns jsx instead of directly invoking a supplied createElement function. This allows consumers to transform it to the desired output via their own tooling or use the react-jsx/runtime by default.

Install

npm install mobiledoc-jsx-renderer --save

Usage

import { MobiledocJsxRenderer } from 'mobiledoc-jsx-renderer'

const render = MobiledocJsxRenderer()
render(mobiledoc)

Options

interface MobiledocJsxRendererOptions {
  getCardComponent?: (card: string) => JSX.Element // Required if you have custom cards to renderer
  getAtomComponent?: (atom: string) => JSX.Element // Required if you have custom atoms to renderer
  getMarkupComponent?: (tag: string) => JSX.Element // Optional, allowing you to alter/change output for markup tags
}

Raw JSX

Out of the box, the JSX is transformed to js using react/jsx-runtime. If you want the the raw jsx to transform yourself, import at:

import { MobiledocJsxRenderer } from 'mobiledoc-jsx-renderer/jsx'

Note that your bundler will have to be configured to transform the jsx in node_modules and not exclude it.