@nteract/connected-components

Connected components exported from @nteract/core

Usage no npm install needed!

<script type="module">
  import nteractConnectedComponents from 'https://cdn.skypack.dev/@nteract/connected-components';
</script>

README

@nteract/connected-components

This package contains React components for rendering navigation menus and modals in nteract applications. To see this package in action, you can view the source code for the nteract-on-Jupyter application.

Installation

$ yarn add @nteract/connected-components

$ npm install --save @nteract/connected-components

Usage

The example below shows we can use the ModalController component within this package to render an about modal.

import { ModalController, MODAL_TYPES } from "@nteract/connected-components";

export default () => {
  return <ModalController modalType={MODAL_TYPES.ABOUT} />;
};

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:connected-components label.

License

BSD-3-Clause