Noiseless Party Machine

    @nteract/transforms-full
    TypeScript icon, indicating that this package has built-in type declarations

    7.0.4-alpha.0 • Public • Published

    @nteract/transforms-full

    This package contains a full set of transforms for rendering plain-text, rich media, and custom visualizations within nteract applications.

    Installation

    $ yarn add @nteract/transforms-full
    
    $ npm install --save @nteract/transforms-full
    

    Usage

    The example below shows how to use the standard set of transforms to render plain text and image data.

    import {
      richestMimetype,
      transforms,
      displayOrder
    } from "@nteract/transforms-full";
    
    // 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, transforms);
    
    // Get the matching React.Component for that mimetype
    let Transform = transforms[mimetype];
    
    // Create a React element
    return <Transform data={bundle[mimetype]} />;

    The following example shows how you can extend the set of transforms with your own unique transforms. This allows you to create custom renders for different media types.

    import {
      richestMimetype,
      registerTransform,
      transforms,
      displayOrder,
    } from '@nteract/transforms-full'
    
    import someCustomTransform from 'somewhere';
    
    let registry = { transforms, displayOrder };
    
    registry = registerTransform(registry, someCustomTransform);
    
    ...
    
    const Transform = registry.transforms[mimetype];

    Documentation

    We're working on adding more documentation for this component. Stay tuned by watching this repository!

    Support

    If you experience an issue while using this package or have a feature request, please file an issue on the issue board and add the pkg:transforms-full label.

    License

    BSD-3-Clause

    Install

    npm i @nteract/transforms-full

    DownloadsWeekly Downloads

    7

    Version

    7.0.4-alpha.0

    License

    BSD-3-Clause

    Unpacked Size

    8.13 kB

    Total Files

    7

    Last publish

    Collaborators

    • hydrosquall
    • benabel
    • alexandercbooth
    • benrussert
    • mpacer
    • theengineear
    • yuvipanda
    • rgbkrk
    • lgeiger
    • ivanov
    • captainsafia
    • peggyrayzis
    • jdetle
    • hasch
    • willingc
    • stormpython
    • crystalline-cat
    • emeeks