@enerex/template-studio 1.1.35 → 1.1.37
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 +63 -63
- package/dist/enerex-template-editor.es.js +615 -501
- package/dist/enerex-template-editor.umd.js +3 -3
- package/dist/template-studio.css +1 -1
- package/dist/types/component/editor/index.d.ts +1 -0
- package/dist/types/component/template-form/index.d.ts +1 -0
- package/dist/types/context/configuration-provider.d.ts +9 -0
- package/dist/types/queries/mark_favourite.mutation.d.ts +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,63 +1,63 @@
|
|
|
1
|
-
# Template Studio - React Component Library
|
|
2
|
-
|
|
3
|
-
A powerful and customizable editor widget built for React applications. This library simplifies the integration of dynamic template editing within your UI.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
To install the `template-editor` package, use npm:
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
npm i @enerex/template-studio
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Peer Dependencies
|
|
14
|
-
|
|
15
|
-
You must install the following required packages to ensure proper styling and component behavior:
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
npm i bootstrap@5.0.2 react-bootstrap@2.2.0
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Styles Integration
|
|
22
|
-
|
|
23
|
-
Import the component's stylesheet into your main CSS file (typically `App.css`):
|
|
24
|
-
|
|
25
|
-
```css
|
|
26
|
-
/* App.css */
|
|
27
|
-
@import "@enerex/template-studio/dist/template-studio.css";
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
## Usage Example
|
|
31
|
-
|
|
32
|
-
Here is a basic example of how to use the `EditorWidget` component:
|
|
33
|
-
|
|
34
|
-
```jsx
|
|
35
|
-
import React from "react";
|
|
36
|
-
import { EditorWidget } from '@enerex/template-studio';
|
|
37
|
-
|
|
38
|
-
function App() {
|
|
39
|
-
return (
|
|
40
|
-
<EditorWidget
|
|
41
|
-
config={{
|
|
42
|
-
apiKey: "(api-key)",
|
|
43
|
-
clientId: "(client-id)",
|
|
44
|
-
projectId: "(project-id)",
|
|
45
|
-
enerexIdentifier: "(enerex-identifier)",
|
|
46
|
-
userName: "(username)",
|
|
47
|
-
}}
|
|
48
|
-
/>
|
|
49
|
-
);
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
export default App;
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
Replace the placeholder values in `config` with your actual API credentials.
|
|
56
|
-
|
|
57
|
-
## License
|
|
58
|
-
|
|
59
|
-
MIT
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
For more advanced usage and customization options, refer to the full documentation (coming soon).
|
|
1
|
+
# Template Studio - React Component Library
|
|
2
|
+
|
|
3
|
+
A powerful and customizable editor widget built for React applications. This library simplifies the integration of dynamic template editing within your UI.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
To install the `template-editor` package, use npm:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm i @enerex/template-studio
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Peer Dependencies
|
|
14
|
+
|
|
15
|
+
You must install the following required packages to ensure proper styling and component behavior:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm i bootstrap@5.0.2 react-bootstrap@2.2.0
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Styles Integration
|
|
22
|
+
|
|
23
|
+
Import the component's stylesheet into your main CSS file (typically `App.css`):
|
|
24
|
+
|
|
25
|
+
```css
|
|
26
|
+
/* App.css */
|
|
27
|
+
@import "@enerex/template-studio/dist/template-studio.css";
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Usage Example
|
|
31
|
+
|
|
32
|
+
Here is a basic example of how to use the `EditorWidget` component:
|
|
33
|
+
|
|
34
|
+
```jsx
|
|
35
|
+
import React from "react";
|
|
36
|
+
import { EditorWidget } from '@enerex/template-studio';
|
|
37
|
+
|
|
38
|
+
function App() {
|
|
39
|
+
return (
|
|
40
|
+
<EditorWidget
|
|
41
|
+
config={{
|
|
42
|
+
apiKey: "(api-key)",
|
|
43
|
+
clientId: "(client-id)",
|
|
44
|
+
projectId: "(project-id)",
|
|
45
|
+
enerexIdentifier: "(enerex-identifier)",
|
|
46
|
+
userName: "(username)",
|
|
47
|
+
}}
|
|
48
|
+
/>
|
|
49
|
+
);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export default App;
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Replace the placeholder values in `config` with your actual API credentials.
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
For more advanced usage and customization options, refer to the full documentation (coming soon).
|