Skip to content

Commit

Permalink
update miew-react readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreiMazol committed Jan 25, 2022
1 parent 8d16084 commit 4bdd0f9
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions packages/miew-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Downloads](https://img.shields.io/npm/dm/miew-react)](https://www.npmjs.com/package/miew-react)
[![License](https://img.shields.io/badge/MIT%20-blue.svg)](https://opensource.org/licenses/MIT)

Copyright (c) 2022 [EPAM Systems, Inc.](https://www.epam.com/)
Copyright (c) 2015–2022 [EPAM Systems, Inc.](https://www.epam.com/)

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

Expand Down Expand Up @@ -32,16 +32,18 @@ yarn add miew-react
import Viewer from 'miew-react'

const MyComponent = () => {
return (
<Viewer />
)
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)
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](../../LICENSE.md)

0 comments on commit 4bdd0f9

Please sign in to comment.