mc-react-library 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -0
- package/dist/main.css +1 -0
- package/dist/mc-react-library.js +3688 -0
- package/package.json +33 -0
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Materials Cloud React component library
|
|
2
|
+
|
|
3
|
+
React component library used in Materials Cloud, built with vite and bootstrap.
|
|
4
|
+
|
|
5
|
+
Install via
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
npm install mc-react-library
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Note: make sure all `peerDependencies` (defined in `package.json`) are installed in the host application!
|
|
12
|
+
|
|
13
|
+
Project structure:
|
|
14
|
+
|
|
15
|
+
- `lib\` - contains the React components of the library.
|
|
16
|
+
- `src\` - contains a demo page that renders the components just for development.
|
|
17
|
+
|
|
18
|
+
## Development
|
|
19
|
+
|
|
20
|
+
### Using the demo page
|
|
21
|
+
|
|
22
|
+
For developing the library of components, start the demo page (in `src\`) by
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
npm install
|
|
26
|
+
npm run dev
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
and update the components in `lib\`.
|
|
30
|
+
|
|
31
|
+
### Building and testing locally
|
|
32
|
+
|
|
33
|
+
To build the library and test it locally in an external application (before publishing to npm), use
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
npm run build
|
|
37
|
+
npm pack
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
which will create a `.tgz` file that can then be installed by the external application via
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
npm install /path/to/mc-react-library-x.y.z.tgz
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Publishing a new version
|
|
47
|
+
|
|
48
|
+
To make a new version and publish to npm via GitHub Actions:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm version <patch/minor/major>
|
|
52
|
+
git push --follow-tags
|
|
53
|
+
```
|
package/dist/main.css
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
._button_qg5kh_1{background-color:#f90;color:#fff;border:solid 2px black;border-radius:5px;cursor:pointer;transition:background-color .3s ease;height:30px;width:80px}._button_qg5kh_1:hover{background-color:#ad6800}._archive_doicitation_5woyi_1{color:#333;font-size:100%;margin-bottom:0;margin-top:0}._archive_doicitation_5woyi_1 span._doi_badge_5woyi_8{white-space:nowrap;display:inline-block}._archive_doicitation_5woyi_1 span._doi_left_5woyi_12{border-radius:.25rem;border-top-right-radius:0;border-bottom-right-radius:0;color:#fff;background-color:#343a40;padding:.25em .4em;font-size:75%;line-height:1;text-align:center;white-space:nowrap;vertical-align:baseline;display:inline-block}._archive_doicitation_5woyi_1 a._doi_right_5woyi_28{border-radius:.25rem;border-top-left-radius:0;border-bottom-left-radius:0;color:#212529;background-color:#a2cbff;display:inline-block;padding:.25em .4em;font-size:75%;font-weight:500;line-height:1;text-align:center;white-space:nowrap;vertical-align:baseline;text-decoration:none}._archive_doicitation_5woyi_1 a._doi_right_5woyi_28[href]:focus,._archive_doicitation_5woyi_1 a._doi_right_5woyi_28[href]:hover{color:#212529;text-decoration:none;background-color:#c0dbff}._help_button_1s4g5_1{width:1.25em;height:1.25em;box-sizing:border-box;box-shadow:0 0 0 1px #686868 inset;border-radius:50%;cursor:default;-webkit-user-select:none;user-select:none;background:#ececec;text-align:center;display:flex;justify-content:center;align-content:center;flex-direction:column}._help_button_1s4g5_1:hover{filter:brightness(85%)}
|