Skip to content

Latest commit

 

History

History
 
 

miew-react

miew-react

npm version Downloads License

Copyright (c) 2015–2022 EPAM Systems, Inc.

Miew is a high performance web library for advanced visualization and manipulation of molecular structures.

For more details please look at the following link.

The miew-react package contains only the functionality necessary to define components. It is used together with miew.

Installation

The miew-react library is available as an NPM package. Install it either with NPM:

npm install --save miew-react

or Yarn:

yarn add miew-react

Usage

import Viewer from 'miew-react'

const MyComponent = () => {
  return <Viewer />
}

Props

Imported component accepts the following optional props:

  • options: an object containing representation settings for Miew and initial structure to be shown (all the fields are also optional, when not provided, default settings are applied)
  • onInit: a callback function which recieves an instance of Miew, and called after initialization of Miew instance inside the Viewer component. With a help of this prop you can access Miew methods and fields.
  • theme: an object containing theme which should be used inside the Viewer component (all the fields are also optional, when not provided, default theme is applied)

License

MIT