https://github.com/nteract/outputs
A collection of React components for displaying rich Jupyter display objects
https://github.com/nteract/outputs
Last synced: 2 months ago
JSON representation
A collection of React components for displaying rich Jupyter display objects
- Host: GitHub
- URL: https://github.com/nteract/outputs
- Owner: nteract
- License: bsd-3-clause
- Created: 2020-03-19T03:40:06.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-29T15:03:33.000Z (over 1 year ago)
- Last Synced: 2025-03-30T21:02:29.365Z (2 months ago)
- Language: TypeScript
- Size: 2 MB
- Stars: 27
- Watchers: 9
- Forks: 19
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# transforms
This monorepo contains a collection of nteract transforms. Transforms are React components that take Jupyter display objects as inputs and render rich views as outputs.
## Installation
To use the basic set of transforms, you can use the `@nteract/outputs` package.
```
$ npm install --save @nteract/outputs
```
## Usage
The example below shows how we can use the `ExecuteResult` component within the `@nteract/outputs` package to render the response to an execution request sent by our Jupyter kernel.
```javascript
import { ExecuteResult } from "@nteract/outputs";
export default () => {
const Plain = props =>
{props.data};
Plain.defaultProps = {
mediaType: "text/plain"
};
return (
);
};
```
Usage instructions for other transforms are documented within each transform's README.
## Documentation
Transforms are documented in the [docs](./docs) directory.
## Support
If you experience an issue while using this package or have a feature request, please file an issue on the [issue board](https://github.com/nteract/outputs/issues).
## License
[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)