@wandelbots/wandelbots-js-react-components 3.2.0-pr.feat-improve-exports.414.2479f4b → 3.2.0-pr.feat-improve-exports.414.34cf950
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 +14 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,9 +12,9 @@ Built with TypeScript, Material-UI, and React Three Fiber. Provides robot contro
|
|
|
12
12
|
npm install @wandelbots/wandelbots-js-react-components react react-dom @mui/material @emotion/react @emotion/styled
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
## Modular Imports
|
|
15
|
+
## Modular Imports + Peer Dependencies
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Please note that some modules require extra dependencies, like three.js. If you don't need 3d rendering in your application, make sure you always import from `@wandelbots/wandelbots-js-react-components/core`.
|
|
18
18
|
|
|
19
19
|
```typescript
|
|
20
20
|
import {
|
|
@@ -25,36 +25,30 @@ import {
|
|
|
25
25
|
} from "@wandelbots/wandelbots-js-react-components/core"
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
For 3D-enabled components, use
|
|
28
|
+
For 3D-enabled components, use `@wandelbots/wandelbots-js-react-components/3d`:
|
|
29
29
|
|
|
30
30
|
```typescript
|
|
31
31
|
import { Robot, RobotCard } from "@wandelbots/wandelbots-js-react-components/3d"
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
```typescript
|
|
37
|
-
import { WandelscriptEditor } from "@wandelbots/wandelbots-js-react-components/wandelscript"
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
You can also import everything from the main entry point, but you'll need to install all optional peer dependencies:
|
|
34
|
+
You can also import from top-level `@wandelbots/wandelbots-js-react-components`, but then you'll need to provide all optional dependencies:
|
|
41
35
|
|
|
42
36
|
```bash
|
|
43
37
|
npm install @wandelbots/wandelbots-js-react-components \
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
38
|
+
react react-dom \
|
|
39
|
+
@mui/material @mui/icons-material @emotion/react @emotion/styled \
|
|
40
|
+
three @react-three/fiber @react-three/drei three-stdlib \
|
|
41
|
+
@monaco-editor/react shiki @shikijs/monaco
|
|
48
42
|
```
|
|
49
43
|
|
|
50
44
|
**Available Entry Points:**
|
|
51
45
|
|
|
52
|
-
| Entry Point | Components | Required Peer Dependencies
|
|
53
|
-
| ------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
54
|
-
| **Main** (`.`) | All components | React 18+, MUI v6/v7, @emotion/react, @emotion/styled, + all below
|
|
55
|
-
| **`/core`** | Base components (AppHeader, ProgramControl, SafetyBar, VelocitySlider, JoggingPanel, DataGrid, Timer, themes, i18n, etc.) | React 18+, MUI v6/v7, @emotion/react, @emotion/styled
|
|
56
|
-
| **`/3d`** | 3D visualization (Robot, RobotCard, CollisionSceneRenderer, SafetyZonesRenderer, TrajectoryRenderer) | All from `/core` + three, @react-three/fiber, @react-three/drei, three-stdlib
|
|
57
|
-
| **`/wandelscript`** | Code editor (WandelscriptEditor) | All from `/core` + @monaco-editor/react
|
|
46
|
+
| Entry Point | Components | Required Peer Dependencies |
|
|
47
|
+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
48
|
+
| **Main** (`.`) | All components | React 18+, MUI v6/v7, @emotion/react, @emotion/styled, @mui/icons-material + all below |
|
|
49
|
+
| **`/core`** | Base components (AppHeader, ProgramControl, SafetyBar, VelocitySlider, JoggingPanel, DataGrid, Timer, themes, i18n, etc.) | React 18+, MUI v6/v7, @emotion/react, @emotion/styled, @mui/icons-material |
|
|
50
|
+
| **`/3d`** | 3D visualization (Robot, RobotCard, CollisionSceneRenderer, SafetyZonesRenderer, TrajectoryRenderer) | All from `/core` + three, @react-three/fiber, @react-three/drei, three-stdlib |
|
|
51
|
+
| **`/wandelscript`** | Code editor (WandelscriptEditor) | All from `/core` + @monaco-editor/react |
|
|
58
52
|
|
|
59
53
|
## Getting Started
|
|
60
54
|
|
|
@@ -214,8 +208,6 @@ Components integrate with the Wandelbots Nova ecosystem:
|
|
|
214
208
|
**For `/wandelscript` (code editor):**
|
|
215
209
|
|
|
216
210
|
- @monaco-editor/react
|
|
217
|
-
- shiki
|
|
218
|
-
- @shikijs/monaco
|
|
219
211
|
|
|
220
212
|
## Development
|
|
221
213
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wandelbots/wandelbots-js-react-components",
|
|
3
|
-
"version": "3.2.0-pr.feat-improve-exports.414.
|
|
3
|
+
"version": "3.2.0-pr.feat-improve-exports.414.34cf950",
|
|
4
4
|
"description": "React UI toolkit for building applications on top of the Wandelbots platform",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|