Jason Grout 25152cd7c0 Prerelease version 6 years ago
..
src 021f08a022 Add note about `fragment` attribute to `IMimeModel` `metadata` documentation. 6 years ago
README.md cba7c89454 Update to Vega 5 (#6133) 6 years ago
package.json 25152cd7c0 Prerelease version 6 years ago
tdoptions.json 5fee8c5389 Switch to ts 3.1 6 years ago
tsconfig.json 9b465f43d7 Clean up handling of src 6 years ago

README.md

@jupyterlab/rendermime-interfaces

A package for JupyterLab which provides interfaces for implementing mime renderer extensions.

A general JupyterLab plugin involves a certain amount of boilerplate code that can be annoying for authors of relatively extensions. The interfaces in this package are meant to give an easier way for extension authors to provide a plugin that renders mime bundles and documents of a specific mime type.

When using these interfaces, extensions only need to provide some metadata about wht kind of mime bundle they are able to render, and a Widget with a renderModel method that renders the mime bundle.

Examples can be found in @jupyterlab/vega5-extension and @jupyterlab/pdf-extension.