@oicl/openbridge-webcomponents-react 0.0.15-dev-20250127114442 β 0.0.15-dev-20250205200936
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/package.json +2 -2
- package/readme.md +21 -8
package/package.json
CHANGED
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
"build": "tsc",
|
|
6
6
|
"build:watch": "tsc --watch"
|
|
7
7
|
},
|
|
8
|
-
"version": "0.0.15-dev-
|
|
8
|
+
"version": "0.0.15-dev-20250205200936",
|
|
9
9
|
"dependencies": {
|
|
10
|
-
"@oicl/openbridge-webcomponents": "^0.0.15-dev-
|
|
10
|
+
"@oicl/openbridge-webcomponents": "^0.0.15-dev-20250205200936",
|
|
11
11
|
"@lit/react": "^1.0.0"
|
|
12
12
|
},
|
|
13
13
|
"peerDependencies": {
|
package/readme.md
CHANGED
|
@@ -1,7 +1,15 @@
|
|
|
1
1
|
# Openbridge Web Components React
|
|
2
2
|
|
|
3
|
-
Welcome to the react wrapper of
|
|
3
|
+
Welcome to the react wrapper of Openbridge Web Components!
|
|
4
4
|
|
|
5
|
+
# π We are preparing to release OpenBridge 6.0 in March 2026 π
|
|
6
|
+
|
|
7
|
+
We are currently developing the code in a joint industry project, with funding from industry partners.
|
|
8
|
+
The code is only available for the partners until the release in March 2026. It is possible to get access to the code in active development by joining the project.
|
|
9
|
+
|
|
10
|
+
[π Click here to read more about the project.](https://docs.google.com/document/d/18ytBiUrfQrMYOPPz-hd7pgPjnG8ZBG-zr9xYl5Y2TTs/edit?tab=t.0)
|
|
11
|
+
|
|
12
|
+
[π Click here to register your interest in the form. (Note: Registering is not a commitment but will enroll you in our process.)](https://docs.google.com/forms/d/e/1FAIpQLSd2H7bbL_duBTMhHzjw7W52H9XXAiJ9A3sL7PsrfCTW_bNUhw/viewform)
|
|
5
13
|
|
|
6
14
|
> **βCautionβ** This repository is currently in early development and may not be stable. Please use with caution.
|
|
7
15
|
|
|
@@ -14,6 +22,7 @@ We have made an short introduction to the library. You can watch it [here](https
|
|
|
14
22
|
</a>
|
|
15
23
|
|
|
16
24
|
# Slack Channel
|
|
25
|
+
|
|
17
26
|
Join our slack channel to get the latest updates and to ask questions. Click [here](https://join.slack.com/t/openbridgegroup/shared_invite/zt-2e4clvl6s-uZLkN5L3g8O~c1UZCN1reQ) to join the slack workspace, and join the [#openbridge-webcomponents](https://openbridgegroup.slack.com/archives/C06LXTCR269) channel.
|
|
18
27
|
|
|
19
28
|
## Table of Contents
|
|
@@ -36,6 +45,7 @@ The demo showcases the project's functionality using react. It provides a live d
|
|
|
36
45
|
To access the demo, click [here](https://openbridge-demo.web.app/).
|
|
37
46
|
|
|
38
47
|
## Installation
|
|
48
|
+
|
|
39
49
|
To use the components in your project, you can install the package from npm:
|
|
40
50
|
|
|
41
51
|
```bash
|
|
@@ -45,28 +55,32 @@ npm install @oicl/openbridge-webcomponents-react
|
|
|
45
55
|
See also the [react demo](https://github.com/Ocean-Industries-Concept-Lab/openbridge-webcomponents/tree/main/packages/react-demo)
|
|
46
56
|
|
|
47
57
|
### Setup
|
|
58
|
+
|
|
48
59
|
1. Add the css file to your project:
|
|
49
60
|
```javascript
|
|
50
|
-
import
|
|
61
|
+
import "@oicl/openbridge-webcomponents/src/palettes/variables.css";
|
|
51
62
|
```
|
|
52
63
|
2. Select the pallet by setting the `data-obc-theme` attribute on the `html` tag:
|
|
53
64
|
```html
|
|
54
|
-
<html lang="en" data-obc-theme="day">
|
|
65
|
+
<html lang="en" data-obc-theme="day"></html>
|
|
55
66
|
```
|
|
56
67
|
3. Install the Noto Sans font by using the attached `NotoSans.ttf` file. Add the following to your css:
|
|
68
|
+
|
|
57
69
|
```css
|
|
58
70
|
@font-face {
|
|
59
|
-
|
|
60
|
-
|
|
71
|
+
font-family: "Noto Sans";
|
|
72
|
+
src: url("path/to/NotoSans.ttf");
|
|
61
73
|
}
|
|
62
74
|
|
|
63
75
|
* {
|
|
64
|
-
|
|
76
|
+
font-family: Noto Sans;
|
|
65
77
|
}
|
|
66
78
|
```
|
|
79
|
+
|
|
67
80
|
4. Import the desired components in your project, for instance:
|
|
81
|
+
|
|
68
82
|
```javascript
|
|
69
|
-
import {ObcTopBar} from
|
|
83
|
+
import { ObcTopBar } from "@oicl/openbridge-webcomponents-react/components/top-bar/top-bar";
|
|
70
84
|
```
|
|
71
85
|
|
|
72
86
|
5. Use the components in your project:
|
|
@@ -77,4 +91,3 @@ See also the [react demo](https://github.com/Ocean-Industries-Concept-Lab/openbr
|
|
|
77
91
|
## Contributing
|
|
78
92
|
|
|
79
93
|
Contributions are welcome!
|
|
80
|
-
|