Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zakodium-oss/react-ocl
React components integrating OpenChemLib
https://github.com/zakodium-oss/react-ocl
editor hacktoberfest molecule molfile reactjs smiles
Last synced: 27 days ago
JSON representation
React components integrating OpenChemLib
- Host: GitHub
- URL: https://github.com/zakodium-oss/react-ocl
- Owner: zakodium-oss
- License: mit
- Created: 2017-01-09T16:06:52.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-09T15:15:14.000Z (27 days ago)
- Last Synced: 2024-10-09T18:08:41.961Z (27 days ago)
- Topics: editor, hacktoberfest, molecule, molfile, reactjs, smiles
- Language: TypeScript
- Homepage: https://react-ocl.pages.dev
- Size: 11.9 MB
- Stars: 10
- Watchers: 5
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# react-ocl
React components integrating OpenChemLib.
These react component allows to display and edit molfile and smiles.
Maintained by Zakodium
[![NPM version][npm-image]][npm-url]
[![build status][ci-image]][ci-url]
[![npm download][download-image]][download-url]
## Installation
```console
npm install openchemlib react-ocl
```
## Usage
```jsx
import { SmilesSvgRenderer } from 'react-ocl';
function MyComponent() {
return ;
}
```
## Which version of the library should I use?
This library is available in three versions, like openchemlib: `react-ocl/minimal`
(also available as `react-ocl`), `react-ocl/core` and `react-ocl/full`.
- If you only use the SvgRenderer component, you can choose any version, minimal
being the smallest one.
- If you want to use the StructureEditor component, you must import `react-ocl/full`.
- If you are writing a library and want to allow your consumer to provide the OCL
version for rendering, you must import `react-ocl/base`.
## Documentation
See https://react-ocl.pages.dev for detailed usage examples.
[npm-image]: https://img.shields.io/npm/v/react-ocl.svg
[npm-url]: https://npmjs.org/package/react-ocl
[ci-image]: https://github.com/zakodium-oss/react-ocl/workflows/Node.js%20CI/badge.svg?branch=main
[ci-url]: https://github.com/zakodium-oss/react-ocl/actions?query=workflow%3A%22Node.js+CI%22
[download-image]: https://img.shields.io/npm/dm/react-ocl.svg
[download-url]: https://npmjs.org/package/react-ocl