Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.39 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.39 KB

react-vtkjs-viewport

VTK.js image viewport component for React

NPM FOSSA Status

Install

This project consumes vtk.js as an ES6 dependency. If you're unsure of how to consume vtk.js as an ES6 dependency, please check out Kitware's guide.

# With NPM
npm install --save react-vtkjs-viewport vtk.js

# With Yarn
yarn add react-vtkjs-viewport vtk.js

Development

Local development uses <root>/examples as a test application. You can import the VTK Viewport using a WebPack alias like so:

import VtkViewport from '@vtk-viewport'

Any updates to the example files or the VtkViewport's source will cause WebPack to rebuild.

# Restore Dependencies
yarn install

# Start Local Dev Server
yarn run dev

License

MIT © OHIF

FOSSA Status