feat: rename component to NMRium

cheminfo · Apr 2, 2021 · 439688c · 439688c
1 parent e02a115
commit 439688c
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -80,10 +80,10 @@ from `openchemlib/full` to avoid having multiple OCL versions in your bundle.
 ### Use the component
 
 ```jsx
-import NMRDisplayer from 'nmr-displayer';
+import NMRium from 'nmr-displayer';
 
 function MyComponent() {
-  return <NMRDisplayer />;
+  return <NMRium />;
 }
 ```
 

diff --git a/package.json b/package.json
@@ -1,10 +1,10 @@
 {
-  "name": "nmr-displayer",
+  "name": "nmrium",
   "version": "0.8.1",
   "license": "MIT",
-  "main": "lib-cjs/component/NMRDisplayer.js",
-  "module": "lib/component/NMRDisplayer.js",
-  "types": "lib/component/NMRDisplayer.d.ts",
+  "main": "lib-cjs/component/NMRium.js",
+  "module": "lib/component/NMRium.js",
+  "types": "lib/component/NMRium.d.ts",
   "files": [
     "lib",
     "lib-cjs"

diff --git a/src/component/NMRDisplayer.tsx → src/component/NMRium.tsx b/src/component/NMRDisplayer.tsx → src/component/NMRium.tsx
@@ -185,7 +185,7 @@ export interface NMRDisplayerData {
   spectra: Spectra;
 }
 
-function NMRDisplayer({
+function NMRium({
   data: dataProp,
   onDataChange,
   docsBaseUrl,
@@ -386,7 +386,7 @@ function NMRDisplayer({
   );
 }
 
-NMRDisplayer.propTypes = {
+NMRium.propTypes = {
   docsBaseUrl: PropTypes.string,
   onDataChange: PropTypes.func,
   preferences: PropTypes.shape({
@@ -422,7 +422,7 @@ NMRDisplayer.propTypes = {
   }),
 };
 
-NMRDisplayer.defaultProps = {
+NMRium.defaultProps = {
   docsBaseUrl: 'https://cheminfo.github.io/nmr-displayer/docs/v0',
   onDataChange: () => null,
   preferences: {
@@ -464,4 +464,4 @@ NMRDisplayer.defaultProps = {
   },
 };
 
-export default memo(NMRDisplayer);
+export default memo(NMRium);
diff --git a/src/component/reducer/Reducer.ts b/src/component/reducer/Reducer.ts
@@ -4,7 +4,7 @@ import { predictionProton } from 'nmr-processing';
 import OCL from 'openchemlib/full';
 
 import * as SpectraManager from '../../data/SpectraManager';
-import { Spectra } from '../NMRDisplayer';
+import { Spectra } from '../NMRium';
 import { DefaultTolerance } from '../panels/SummaryPanel/CorrelationTable/Constants';
 import { options } from '../toolbar/ToolTypes';
 

diff --git a/src/component/reducer/actions/LoadActions.ts b/src/component/reducer/actions/LoadActions.ts
@@ -7,11 +7,7 @@ import { initiateDatum1D } from '../../../data/data1d/Datum1D';
 import { initiateDatum2D } from '../../../data/data2d/Datum2D';
 import * as MoleculeManager from '../../../data/molecules/MoleculeManager';
 import generateID from '../../../data/utilities/generateID';
-import {
-  Molecules,
-  NMRDisplayerPreferences,
-  Spectra,
-} from '../../NMRDisplayer';
+import { Molecules, NMRDisplayerPreferences, Spectra } from '../../NMRium';
 import { DefaultTolerance } from '../../panels/SummaryPanel/CorrelationTable/Constants';
 import { State } from '../Reducer';
 

diff --git a/src/demo/views/Exam.jsx b/src/demo/views/Exam.jsx
@@ -6,7 +6,7 @@ import { FaRegCopy, FaCheck } from 'react-icons/fa';
 import { MF } from 'react-mf';
 import { StructureEditor } from 'react-ocl/full';
 
-import NMRDisplayer from '../../component/NMRDisplayer';
+import NMRium from '../../component/NMRium';
 import { copyTextToClipboard } from '../../component/utility/Export.js';
 
 let answers = JSON.parse(localStorage.getItem('nmrium-exams') || '{}');
@@ -220,7 +220,7 @@ export default function Exam(props) {
           css={nmrContainer}
           style={{ height: answerAreaVisible ? '50%' : 'calc(100% - 25px)' }}
         >
-          <NMRDisplayer
+          <NMRium
             data={data}
             preferences={{
               general: {

diff --git a/src/demo/views/Exercise.jsx b/src/demo/views/Exercise.jsx
@@ -5,7 +5,7 @@ import { useState, useEffect, useCallback } from 'react';
 import { MF } from 'react-mf';
 import { StructureEditor } from 'react-ocl/full';
 
-import NMRDisplayer from '../../component/NMRDisplayer';
+import NMRium from '../../component/NMRium';
 
 let answers = JSON.parse(localStorage.getItem('nmrium-exercises') || '{}');
 
@@ -169,7 +169,7 @@ export default function Exercise(props) {
         <div
           style={{ height: answerAreaVisible ? '50%' : 'calc(100% - 25px)' }}
         >
-          <NMRDisplayer
+          <NMRium
             data={data}
             preferences={{
               general: {

diff --git a/src/demo/views/SingleView.jsx b/src/demo/views/SingleView.jsx
@@ -1,6 +1,6 @@
 import { useState, useEffect } from 'react';
 
-import NMRDisplayer from '../../component/NMRDisplayer';
+import NMRium from '../../component/NMRium';
 
 export default function SingleView(props) {
   const [data, setData] = useState();
@@ -56,7 +56,7 @@ export default function SingleView(props) {
           {path}
         </p>
       )}
-      <NMRDisplayer data={data} />
+      <NMRium data={data} />
     </div>
   );
 }
diff --git a/src/demo/views/Test.jsx b/src/demo/views/Test.jsx
@@ -1,6 +1,6 @@
 import { useState, useEffect } from 'react';
 
-import NMRDisplayer from '../../component/NMRDisplayer';
+import NMRium from '../../component/NMRium';
 
 async function loadData(file) {
   const response = await fetch(file);
@@ -62,7 +62,7 @@ export default function Test(props) {
           {title}
         </p>
       )}
-      <NMRDisplayer
+      <NMRium
         data={data}
         preferences={{
           panels: { hidePeaksPanel: true, hideStructuresPanel: true },

diff --git a/src/demo/views/TwoInstances.jsx b/src/demo/views/TwoInstances.jsx
@@ -1,6 +1,6 @@
 /** @jsxImportSource @emotion/react */
 
-import NMRDisplayer from '../../component/NMRDisplayer';
+import NMRium from '../../component/NMRium';
 
 const data1 = {
   spectra: [
@@ -75,10 +75,10 @@ export default function TwoInstances(props) {
         </p>
       )}
       <div style={{ flex: 1 }}>
-        <NMRDisplayer data={data1} key="1" />
+        <NMRium data={data1} key="1" />
       </div>
       <div style={{ flex: 1 }}>
-        <NMRDisplayer data={data2} key="2" />
+        <NMRium data={data2} key="2" />
       </div>
     </div>
   );

diff --git a/src/demo/views/View.jsx b/src/demo/views/View.jsx
@@ -1,7 +1,7 @@
 import { useState, useEffect, useCallback } from 'react';
 import { ObjectInspector } from 'react-inspector';
 
-import NMRDisplayer from '../../component/NMRDisplayer';
+import NMRium from '../../component/NMRium';
 
 async function loadData(file) {
   const response = await fetch(file);
@@ -113,7 +113,7 @@ export default function View(props) {
       >
         <div style={{ display: 'flex', flexDirection: 'row', width: '100%' }}>
           <div style={{ width: isCallbackVisible ? '75%' : '100%' }}>
-            <NMRDisplayer data={data} onDataChange={changeHadnler} />
+            <NMRium data={data} onDataChange={changeHadnler} />
           </div>
           {process.env.NODE_ENV !== 'production' && (
             <div