mc-react-structure-visualizer 0.4.3 → 0.5.0

package/README.md

@@ -1,74 +1,48 @@
-# React Materials Cloud Structure Visualizer
-
-A React component to visualize structures on the Materials Cloud platform.
-
-# Getting Started with Create React App
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
-
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
-
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
-
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+# Materials Cloud React Structure Visualizer
+
+A React component to visualize structures on the Materials Cloud platform.
+
+Install via
+
+```
+npm install mc-react-structure-visualizer
+```
+
+Note: make sure all `peerDependencies` (defined in `package.json`) are installed in the host application!
+
+Note: the library (i.e. npm package) only contains the code in `src/StructureVisualizer` folder. The rest of the code in `src/` is for development/demo purposes.
+
+## Development
+
+### Using the demo page
+
+For developing the library of components, start the demo page (in `src\`) by
+
+```
+npm install
+npm run dev
+```
+
+### Building and testing locally
+
+To build the library and test it locally in an external application (before publishing to npm), use
+
+```
+npm run build
+npm pack
+```
+
+which will create a `.tgz` file that can then be installed by the external application via
+
+```
+npm install /path/to/package-x.y.z.tgz
+```
+
+### Publishing a new version
+
+To make a new version and publish to npm via GitHub Actions:
+
+```bash
+npm version <patch/minor/major>
+git push --follow-tags
+```

package/dist/index.css

@@ -1,3 +1 @@
-.structure-visualizer {
-  width: 450px;
-}
+.control-box{position:relative;z-index:1;height:100px;width:450px;background:#fafafa;text-align:center;border:1px solid #999;display:flex;flex-direction:column;justify-content:center;align-items:start;margin-top:-20px;padding:30px 10px 10px;border-radius:5px}.supercell-container{display:flex;align-items:center;gap:2px}.supercell-input{width:45px;height:25px}.supercell-input::-webkit-inner-spin-button,.supercell-input::-webkit-outer-spin-button{opacity:1}.control-box-row{padding:4px 10px;width:100%;line-height:inherit;display:flex;justify-content:space-between;align-items:stretch}.form-label{margin-bottom:0rem}.form-control{padding:0rem .275rem}.camera-controls{margin-left:auto;margin-right:auto;display:inline-flex;align-items:center;justify-items:center;text-align:center;gap:2px}.camera-button{border-width:1px;border-color:#000;border-radius:4px;display:inline-flex;align-items:center;justify-items:center;color:#000;background-color:#e0e0e0;padding:8px;height:25px}.camera-button:hover{color:#000;background-color:#b9b9b9}.control-box-row .form-check-input{margin-left:0}.control-box-row .form-check-label{margin-left:4px}.control-box-row .form-check{margin:0;padding:0}.gldiv{width:98%;height:98%;position:relative}.structure-window-outer{position:relative}.structure-window{position:relative;z-index:2;height:370px;width:450px;background:#fff;text-align:center;border:1px solid #999;display:flex;justify-content:center;align-items:center;border-radius:5px}.disable-mouse{pointer-events:none}.mouse-disabled-note{background-color:#fff1f1;border:1px solid black;color:#353434;padding:2px 6px;border-radius:5px;position:absolute;top:10px;left:10px;z-index:3;cursor:pointer;-webkit-user-select:none;user-select:none}.on{background-color:#e9ffe7}.mouse-disabled-note:hover{filter:brightness(90%)}.structure-visualizer{width:450px;font-size:16px}