nteract transforms

It's likely you don't need to use this package directly and can instead use a release of the display area (:soon:).

Installation

npm install @nteract/transforms

Note: React is a peer dependencies you'll have to install yourself.

Usage

Standard Jupyter Transforms

import {
  richestMimetype,
  standardDisplayOrder,
  standardTransforms,
} from '@nteract/transforms'

// Jupyter style MIME bundle
const bundle = {
  'text/plain': 'This is great',
  'image/png': 'R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7'
}

// Find out which mimetype is the richest
const mimetype = richestMimetype(bundle, standardDisplayOrder, standardTransforms)

// Get the matching React.Component for that mimetype
let Transform = standardTransforms[mimetype]

// Create a React element
return <Transform data={bundle[mimetype]} />

Adding New Transforms

import {
  richestMimetype,
  registerTransform,
  standardTransforms,
  standardDisplayOrder,
} from '@nteract/transforms'

import geoTransform from '@nteract/transform-geojson'

const {
  transforms,
  displayOrder,
} = registerTransform({
  transforms: standardTransforms,
  displayOrder: standardDisplayOrder,
}, geoTransform)

...

const Transform = transforms[mimetype];