⚠️ THIS REPOSITORY IS ARCHIVED ⚠️

Don't worry, it's still being actively developed, we've just moved 😅

New Repository: OHIF/Viewers

New Location: OHIF/Viewers --> root/platform/ui/

Related announcement: 🎉 From Many Repositories to a Monorepo 🤖

react-viewerbase

React Viewerbase is a collection of components and utilities that power OHIF's zero-footprint DICOM viewer.

Read The Docs | Edit the docs

This set of "Medical Imaging Viewer" React components are maintained separately to:

Decouple presentation from business logic
Test and develop components in isolation
Provide well documented, reusable components
Aid rapid application development for context specific viewers

Install

This component library is pre- v1.0. All realeases until a v1.0 have the possibility of introducing breaking changes. Please depend on an "exact" version in your projects to prevent issues caused by loose versioning.

For full installation instructions, be sure to check out our getting started guide.

// with npm
npm i react-viewerbase --save-exact

// with yarn
yarn add react-viewerbase --exact

Usage

import React, { Component } from 'react';
import { LayoutButton } from 'react-viewerbase';

class Example extends Component {
  constructor(props) {
    super(props);

    this.state = {
      selectedCell: {
        className: 'hover',
        col: 1,
        row: 1,
      },
    };
  }

  render() {
    return (
      <LayoutButton
        selectedCell={this.state.selectedCell}
        onChange={cell => this.setState({ selectedCell: cell })}
      />
    );
  }
}

Running Locally

Restore dependencies after cloning:

cd react-viewerbase
yarn install

Develop w/ Hot Reloading:

yarn dev

Build for Production:

yarn build

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Erik Ziegler} 💻 🚧	_{Danny Brown} 💻 🚧	_{Gustavo André Lelis} 💻 🚧	_{Thiago Maltempi} 💻	_{Esref Durna} 💻	_{Steve Pieper} 💻	_{Biharck Araujo} 💻
_{Rodrigo Antinarelli} 💻	_{João Felipe de Medeiros Moreira} 💻	_{James Gosbell} 💻	_{Evren Ozkan} 💻	_{Zach S.} 💻	_{Mete Ugur Akdogan} 💻