@wandelbots/wandelbots-js-react-components 3.2.0-pr.feat-improve-exports.414.2848e0f → 3.2.0-pr.feat-improve-exports.414.f74e11f
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 +40 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -52,9 +52,47 @@ npm install @wandelbots/wandelbots-js-react-components \
|
|
|
52
52
|
|
|
53
53
|
## Getting Started
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
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`.
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
```typescript
|
|
58
|
+
import {
|
|
59
|
+
SafetyBar,
|
|
60
|
+
JoggingPanel,
|
|
61
|
+
DataGrid,
|
|
62
|
+
Timer,
|
|
63
|
+
} from "@wandelbots/wandelbots-js-react-components/core"
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
For 3D-enabled components, use `@wandelbots/wandelbots-js-react-components/3d`:
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import { Robot, RobotCard } from "@wandelbots/wandelbots-js-react-components/3d"
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
You can also import from top-level `@wandelbots/wandelbots-js-react-components`, but then you'll need to provide all optional dependencies:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npm install @wandelbots/wandelbots-js-react-components \
|
|
76
|
+
react react-dom \
|
|
77
|
+
@mui/material @mui/icons-material @emotion/react @emotion/styled \
|
|
78
|
+
three @react-three/fiber @react-three/drei three-stdlib \
|
|
79
|
+
@monaco-editor/react shiki @shikijs/monaco
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Available Entry Points:**
|
|
83
|
+
|
|
84
|
+
| Entry Point | Components | Required Peer Dependencies |
|
|
85
|
+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
86
|
+
| **Main** (`.`) | All components | React 18+, MUI v6/v7, @emotion/react, @emotion/styled, @mui/icons-material + all below |
|
|
87
|
+
| **`/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 |
|
|
88
|
+
| **`/3d`** | 3D visualization (Robot, RobotCard, CollisionSceneRenderer, SafetyZonesRenderer, TrajectoryRenderer) | All from `/core` + three, @react-three/fiber, @react-three/drei, three-stdlib |
|
|
89
|
+
| **`/wandelscript`** | Code editor (WandelscriptEditor) | All from `/core` + @monaco-editor/react |
|
|
90
|
+
|
|
91
|
+
## 2.x to 3.x Migration Guide
|
|
92
|
+
|
|
93
|
+
See [Migration Guide](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/migration-guide--docs) for assistance.
|
|
94
|
+
|
|
95
|
+
## Interactive Documentation
|
|
58
96
|
|
|
59
97
|
See the [Storybook](https://wandelbotsgmbh.github.io/wandelbots-js-react-components) for interactive examples and API documentation.
|
|
60
98
|
|
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.f74e11f",
|
|
4
4
|
"description": "React UI toolkit for building applications on top of the Wandelbots platform",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|