@wandelbots/wandelbots-js-react-components 3.3.0-pr.feat-upgrade-deps.415.9eb009d → 3.3.0-pr.feat-upgrade-deps.415.d18bf26

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.
Files changed (2) hide show
  1. package/README.md +10 -44
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -6,15 +6,17 @@ React UI components for building robotics applications on the [Wandelbots Nova p
6
6
 
7
7
  Built with TypeScript, Material-UI, and React Three Fiber. Provides robot control interfaces, 3D visualizations, and automation components that integrate with the Nova ecosystem.
8
8
 
9
+ ## Interactive Documentation
10
+
11
+ See the [Storybook](https://wandelbotsgmbh.github.io/wandelbots-js-react-components) for interactive examples and API documentation.
12
+
9
13
  ## Install
10
14
 
11
15
  ```bash
12
16
  npm install @wandelbots/wandelbots-js-react-components react react-dom @mui/material @emotion/react @emotion/styled
13
17
  ```
14
18
 
15
- ## Modular Imports + Peer Dependencies
16
-
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`.
19
+ Some modules require extra dependencies, like three.js. If you don't need 3D rendering in your application, always import from `/core`.
18
20
 
19
21
  ```typescript
20
22
  import {
@@ -25,51 +27,19 @@ import {
25
27
  } from "@wandelbots/wandelbots-js-react-components/core"
26
28
  ```
27
29
 
28
- For 3D-enabled components, use `@wandelbots/wandelbots-js-react-components/3d`:
30
+ For 3D-enabled components, use `/3d`:
29
31
 
30
32
  ```typescript
31
33
  import { Robot, RobotCard } from "@wandelbots/wandelbots-js-react-components/3d"
32
34
  ```
33
35
 
34
- You can also import from top-level `@wandelbots/wandelbots-js-react-components`, but then you'll need to provide all optional dependencies:
35
-
36
- ```bash
37
- npm install @wandelbots/wandelbots-js-react-components \
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
42
- ```
43
-
44
- **Available Entry Points:**
45
-
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 |
52
-
53
- ## Getting Started
54
-
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
-
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`:
36
+ For the code editor, use `/wandelscript`:
67
37
 
68
38
  ```typescript
69
- import { Robot, RobotCard } from "@wandelbots/wandelbots-js-react-components/3d"
39
+ import { WandelscriptEditor } from "@wandelbots/wandelbots-js-react-components/wandelscript"
70
40
  ```
71
41
 
72
- You can also import from top-level `@wandelbots/wandelbots-js-react-components`, but then you'll need to provide all optional dependencies:
42
+ You can also import from the top-level package, but then you'll need to provide all optional dependencies:
73
43
 
74
44
  ```bash
75
45
  npm install @wandelbots/wandelbots-js-react-components \
@@ -86,16 +56,12 @@ npm install @wandelbots/wandelbots-js-react-components \
86
56
  | **Main** (`.`) | All components | React 18+, MUI v6/v7, @emotion/react, @emotion/styled, @mui/icons-material + all below |
87
57
  | **`/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
58
  | **`/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 |
59
+ | **`/wandelscript`** | Code editor (WandelscriptEditor) | All from `/core` + @monaco-editor/react, shiki, @shikijs/monaco |
90
60
 
91
61
  ## 2.x to 3.x Migration Guide
92
62
 
93
63
  See [Migration Guide](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/migration-guide--docs) for assistance.
94
64
 
95
- ## Interactive Documentation
96
-
97
- See the [Storybook](https://wandelbotsgmbh.github.io/wandelbots-js-react-components) for interactive examples and API documentation.
98
-
99
65
  ## Components
100
66
 
101
67
  ### Robot Control & Jogging
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wandelbots/wandelbots-js-react-components",
3
- "version": "3.3.0-pr.feat-upgrade-deps.415.9eb009d",
3
+ "version": "3.3.0-pr.feat-upgrade-deps.415.d18bf26",
4
4
  "description": "React UI toolkit for building applications on top of the Wandelbots platform",
5
5
  "type": "module",
6
6
  "sideEffects": false,