react-cornerstone-viewport-hooks

react-cornerstone-viewport-hooks

react cornerstone viewport component (with hooks)

This repository is functionally equivalent to https://github.com/cornerstonejs/react-cornerstone-viewport with the major differences being that this component uses react hooks under the hood and does not support all the features that the original component does at the moment.

Feature parity is planned and the props should be API compatible as much as possible.

Please check the source for more information.

Install

npm install --save react-cornerstone-viewport-hooks

Usage

import {
  ReactCornerstoneViewportHooks,
  ReactCornerstoneViewportHooksHelpers,
  RectangleRoiUniqueTool,
} from "react-cornerstone-viewport-hooks";

import "react-cornerstone-viewport-hooks/dist/index.css";

const {
  TOOL_NAMES,
  getToolState,
  setInitialToolState,
} = ReactCornerstoneViewportHooksHelpers;

Development

Bootstrapped via create-react-library.

Publish

All you need to do is to update the code and push commits to master. Thereafter create a version via npm and publish. The publish command will take care of updating the dist folder and uploading it.

npm version <patch, minor, major> # creates git tag
npm publish
git push
git push --tags

License

MIT © wheresvic