@pixeasy/customizer-stage 0.0.1-beta
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/LICENSE +20 -0
- package/README.md +477 -0
- package/assets/images/logos/google-icon.png +0 -0
- package/assets/styles/_variables.css +0 -0
- package/assets/styles/theme.css +53 -0
- package/assets/theme/custom-preset.ts +256 -0
- package/index.d.ts +112 -0
- package/media/remixicon.eot +0 -0
- package/media/remixicon.svg +9709 -0
- package/media/remixicon.ttf +0 -0
- package/media/remixicon.woff +0 -0
- package/media/remixicon.woff2 +0 -0
- package/package.json +34 -0
- package/pixeasy-customizer.css +1 -0
- package/pixeasy-customizer.min.js +4620 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
Pixeasy Customizer SDK License
|
|
2
|
+
|
|
3
|
+
Copyright (c) Pixeasy.
|
|
4
|
+
All rights reserved.
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted to any person obtaining a copy of this software and
|
|
7
|
+
associated documentation files (the "Software") to use the Software for internal
|
|
8
|
+
evaluation and integration with authorized Pixeasy services only.
|
|
9
|
+
|
|
10
|
+
Any redistribution, sublicensing, sale, modification for redistribution, or
|
|
11
|
+
public hosting of the Software is prohibited unless expressly authorized in
|
|
12
|
+
writing by Pixeasy.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
+
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
|
|
18
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM,
|
|
19
|
+
OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,477 @@
|
|
|
1
|
+
# Pixeasy Customizer SDK
|
|
2
|
+
|
|
3
|
+
Framework-agnostic SDK to embed the Pixeasy customizer in Angular, React, Vue, or any ESM app.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @pixeasy/customizer
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { createPixeasyBuilder } from '@pixeasy/customizer';
|
|
15
|
+
import '@pixeasy/customizer/styles.css';
|
|
16
|
+
|
|
17
|
+
const builder = createPixeasyBuilder();
|
|
18
|
+
|
|
19
|
+
builder.open({
|
|
20
|
+
container: 'pixeasyBuilder',
|
|
21
|
+
apiKey: 'dk_xxx_yyy',
|
|
22
|
+
productId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Note:** `container` can be a CSS selector string (element id) or an `HTMLElement` reference.
|
|
27
|
+
|
|
28
|
+
## API Reference
|
|
29
|
+
|
|
30
|
+
### `createPixeasyBuilder()`
|
|
31
|
+
|
|
32
|
+
Creates and returns a new `PixeasyBuilder` instance. You can create multiple builder instances if needed.
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
const builder = createPixeasyBuilder();
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### `PixeasyBuilder.open(options)`
|
|
39
|
+
|
|
40
|
+
Opens the customizer with the specified configuration.
|
|
41
|
+
|
|
42
|
+
#### Options
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
type PixeasyOpenOptions = {
|
|
46
|
+
// Required
|
|
47
|
+
container: string | HTMLElement; // CSS selector or DOM element to mount the customizer
|
|
48
|
+
apiKey: string; // Your API key (format: dk_xxx_yyy)
|
|
49
|
+
productId: string; // Product ID (UUID format)
|
|
50
|
+
|
|
51
|
+
// Optional
|
|
52
|
+
predesignId?: string; // Load a pre-designed template
|
|
53
|
+
submissionNumber?: string; // Load an existing submission for editing
|
|
54
|
+
locale?: string; // Language/locale code (e.g., 'en', 'fr', 'de')
|
|
55
|
+
theme?: string; // Theme name or color scheme
|
|
56
|
+
readonly?: boolean; // Set to true to disable editing (view-only mode)
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
#### Option Details
|
|
61
|
+
|
|
62
|
+
| Option | Type | Required | Description |
|
|
63
|
+
| ------------------ | ----------------------- | -------- | ------------------------------------------------------------------------------------- |
|
|
64
|
+
| `container` | `string \| HTMLElement` | Yes | Target container to mount the customizer. If string, treated as element ID. |
|
|
65
|
+
| `apiKey` | `string` | Yes | Your Pixeasy API key for authentication. |
|
|
66
|
+
| `productId` | `string` | Yes | UUID of the product to customize. |
|
|
67
|
+
| `predesignId` | `string` | No | Load a pre-designed template/predesign. Useful for template-based workflows. |
|
|
68
|
+
| `submissionNumber` | `string` | No | Load an existing submission for editing or review. Use with `readonly` for view-only. |
|
|
69
|
+
| `locale` | `string` | No | Set the UI language. Examples: `'en'`, `'fr'`, `'de'`, `'es'`. |
|
|
70
|
+
| `theme` | `string` | No | Apply a theme or color scheme to the customizer UI. |
|
|
71
|
+
| `readonly` | `boolean` | No | Enable view-only mode. Prevents editing and submission. Perfect for order review. |
|
|
72
|
+
|
|
73
|
+
### Events
|
|
74
|
+
|
|
75
|
+
All events can be subscribed using `builder.on(eventName, handler)`.
|
|
76
|
+
|
|
77
|
+
| Event | When it fires | Payload |
|
|
78
|
+
| -------------------- | -------------------------------------------------------------------------------------------- | ------------------------------ |
|
|
79
|
+
| `manifest-loaded` | After the product manifest loads successfully. | `ManifestLoadedEventDetail` |
|
|
80
|
+
| `sdk-ready` | After the customizer initializes and is ready for interaction. | `SdkReadyEventDetail` |
|
|
81
|
+
| `submission:success` | After a successful submission. | `SubmissionSuccessEventDetail` |
|
|
82
|
+
| `submission:failed` | When submission fails (API error, network issue, or validation error). | `SubmissionFailedEventDetail` |
|
|
83
|
+
| `error` | When a runtime error occurs (invalid config, manifest load failed, asset load failed, etc.). | `ErrorEventDetail` |
|
|
84
|
+
| `closed` | When the customizer is closed via `builder.close()`. | `undefined` |
|
|
85
|
+
|
|
86
|
+
#### Event Payload Types
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
// Fires after manifest is loaded
|
|
90
|
+
interface ManifestLoadedEventDetail {
|
|
91
|
+
productId: string;
|
|
92
|
+
manifestMeta?: {
|
|
93
|
+
version?: string;
|
|
94
|
+
} | null;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
// Fires when SDK is ready for use
|
|
98
|
+
interface SdkReadyEventDetail {
|
|
99
|
+
productId: string;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
// Fires on successful submission
|
|
103
|
+
interface SubmissionSuccessEventDetail {
|
|
104
|
+
productId?: string;
|
|
105
|
+
views?: string[]; // Generated views/angles
|
|
106
|
+
submissionNumber: string; // Unique submission identifier
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
// Fires when submission fails
|
|
110
|
+
interface SubmissionFailedEventDetail {
|
|
111
|
+
productId?: string;
|
|
112
|
+
views?: string[];
|
|
113
|
+
message: string; // Error message
|
|
114
|
+
errors?: string[]; // Detailed error list
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
// Fires on SDK errors
|
|
118
|
+
interface ErrorEventDetail {
|
|
119
|
+
code: 'INVALID_CONFIG' | 'MANIFEST_LOAD_FAILED' | 'ASSET_LOAD_FAILED' | 'RUNTIME_ERROR';
|
|
120
|
+
message: string;
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
#### Event Subscription Example
|
|
125
|
+
|
|
126
|
+
```ts
|
|
127
|
+
import { SDK_EVENTS } from '@pixeasy/customizer';
|
|
128
|
+
|
|
129
|
+
const builder = createPixeasyBuilder();
|
|
130
|
+
|
|
131
|
+
builder.open({
|
|
132
|
+
container: 'pixeasyBuilder',
|
|
133
|
+
apiKey: 'dk_xxx_yyy',
|
|
134
|
+
productId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
// Subscribe to events
|
|
138
|
+
builder
|
|
139
|
+
.on(SDK_EVENTS.MANIFEST_LOADED, (event) => {
|
|
140
|
+
console.log('Manifest loaded for product:', event.productId);
|
|
141
|
+
})
|
|
142
|
+
.on(SDK_EVENTS.SDK_READY, (event) => {
|
|
143
|
+
console.log('Customizer is ready!', event.productId);
|
|
144
|
+
})
|
|
145
|
+
.on(SDK_EVENTS.SUBMISSION_SUCCESS, (event) => {
|
|
146
|
+
console.log('Submission successful:', event.submissionNumber);
|
|
147
|
+
console.log('Generated views:', event.views);
|
|
148
|
+
})
|
|
149
|
+
.on(SDK_EVENTS.SUBMISSION_FAILED, (event) => {
|
|
150
|
+
console.error('Submission failed:', event.message);
|
|
151
|
+
if (event.errors) {
|
|
152
|
+
console.error('Errors:', event.errors);
|
|
153
|
+
}
|
|
154
|
+
})
|
|
155
|
+
.on(SDK_EVENTS.ERROR, (event) => {
|
|
156
|
+
console.error(`Error [${event.code}]:`, event.message);
|
|
157
|
+
})
|
|
158
|
+
.on(SDK_EVENTS.CLOSED, () => {
|
|
159
|
+
console.log('Customizer closed');
|
|
160
|
+
});
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
#### Unsubscribing from Events
|
|
164
|
+
|
|
165
|
+
```ts
|
|
166
|
+
const handleSuccess = (event) => console.log('Success:', event.submissionNumber);
|
|
167
|
+
|
|
168
|
+
builder.on(SDK_EVENTS.SUBMISSION_SUCCESS, handleSuccess);
|
|
169
|
+
|
|
170
|
+
// Later, remove the listener
|
|
171
|
+
builder.off(SDK_EVENTS.SUBMISSION_SUCCESS, handleSuccess);
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## Framework Examples
|
|
175
|
+
|
|
176
|
+
### React
|
|
177
|
+
|
|
178
|
+
#### Basic Usage
|
|
179
|
+
|
|
180
|
+
```tsx
|
|
181
|
+
import { useEffect } from 'react';
|
|
182
|
+
import { createPixeasyBuilder } from '@pixeasy/customizer';
|
|
183
|
+
import '@pixeasy/customizer/styles.css';
|
|
184
|
+
|
|
185
|
+
export function CustomizerHost() {
|
|
186
|
+
useEffect(() => {
|
|
187
|
+
const builder = createPixeasyBuilder();
|
|
188
|
+
|
|
189
|
+
builder.open({
|
|
190
|
+
container: 'pixeasyBuilder',
|
|
191
|
+
apiKey: 'dk_xxx_yyy',
|
|
192
|
+
productId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
return () => builder.close();
|
|
196
|
+
}, []);
|
|
197
|
+
|
|
198
|
+
return <div id="pixeasyBuilder" />;
|
|
199
|
+
}
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
#### Advanced Usage with Events
|
|
203
|
+
|
|
204
|
+
```tsx
|
|
205
|
+
import { useEffect } from 'react';
|
|
206
|
+
import { createPixeasyBuilder, SDK_EVENTS } from '@pixeasy/customizer';
|
|
207
|
+
import '@pixeasy/customizer/styles.css';
|
|
208
|
+
|
|
209
|
+
export function CustomizerWithEvents() {
|
|
210
|
+
useEffect(() => {
|
|
211
|
+
const builder = createPixeasyBuilder();
|
|
212
|
+
|
|
213
|
+
builder
|
|
214
|
+
.on(SDK_EVENTS.SDK_READY, () => {
|
|
215
|
+
console.log('Customizer ready');
|
|
216
|
+
})
|
|
217
|
+
.on(SDK_EVENTS.SUBMISSION_SUCCESS, (event) => {
|
|
218
|
+
console.log('Submission successful:', event.submissionNumber);
|
|
219
|
+
// Handle success - e.g., show confirmation, redirect, etc.
|
|
220
|
+
})
|
|
221
|
+
.on(SDK_EVENTS.ERROR, (event) => {
|
|
222
|
+
console.error('Error occurred:', event.message);
|
|
223
|
+
})
|
|
224
|
+
.open({
|
|
225
|
+
container: 'pixeasyBuilder',
|
|
226
|
+
apiKey: 'dk_xxx_yyy',
|
|
227
|
+
productId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
228
|
+
locale: 'en',
|
|
229
|
+
theme: 'dark',
|
|
230
|
+
});
|
|
231
|
+
|
|
232
|
+
return () => builder.close();
|
|
233
|
+
}, []);
|
|
234
|
+
|
|
235
|
+
return <div id="pixeasyBuilder" style={{ width: '100%', height: '100vh' }} />;
|
|
236
|
+
}
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
#### Load Existing Submission
|
|
240
|
+
|
|
241
|
+
```tsx
|
|
242
|
+
import { useEffect } from 'react';
|
|
243
|
+
import { createPixeasyBuilder, SDK_EVENTS } from '@pixeasy/customizer';
|
|
244
|
+
import '@pixeasy/customizer/styles.css';
|
|
245
|
+
|
|
246
|
+
export function EditSubmission({ submissionNumber }: { submissionNumber: string }) {
|
|
247
|
+
useEffect(() => {
|
|
248
|
+
const builder = createPixeasyBuilder();
|
|
249
|
+
|
|
250
|
+
builder
|
|
251
|
+
.on(SDK_EVENTS.SUBMISSION_SUCCESS, (event) => {
|
|
252
|
+
console.log('Updated submission:', event.submissionNumber);
|
|
253
|
+
})
|
|
254
|
+
.open({
|
|
255
|
+
container: 'pixeasyBuilder',
|
|
256
|
+
apiKey: 'dk_xxx_yyy',
|
|
257
|
+
productId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
258
|
+
submissionNumber: submissionNumber, // Load for editing
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
return () => builder.close();
|
|
262
|
+
}, [submissionNumber]);
|
|
263
|
+
|
|
264
|
+
return <div id="pixeasyBuilder" />;
|
|
265
|
+
}
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
#### View-Only Mode
|
|
269
|
+
|
|
270
|
+
```tsx
|
|
271
|
+
import { useEffect } from 'react';
|
|
272
|
+
import { createPixeasyBuilder } from '@pixeasy/customizer';
|
|
273
|
+
import '@pixeasy/customizer/styles.css';
|
|
274
|
+
|
|
275
|
+
export function ViewSubmission({ submissionNumber }: { submissionNumber: string }) {
|
|
276
|
+
useEffect(() => {
|
|
277
|
+
const builder = createPixeasyBuilder();
|
|
278
|
+
|
|
279
|
+
builder.open({
|
|
280
|
+
container: 'pixeasyBuilder',
|
|
281
|
+
apiKey: 'dk_xxx_yyy',
|
|
282
|
+
productId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
283
|
+
submissionNumber: submissionNumber,
|
|
284
|
+
readonly: true, // Enable view-only mode
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
return () => builder.close();
|
|
288
|
+
}, [submissionNumber]);
|
|
289
|
+
|
|
290
|
+
return <div id="pixeasyBuilder" />;
|
|
291
|
+
}
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
### Vue
|
|
295
|
+
|
|
296
|
+
#### Basic Usage
|
|
297
|
+
|
|
298
|
+
```ts
|
|
299
|
+
import { onMounted, onBeforeUnmount } from 'vue';
|
|
300
|
+
import { createPixeasyBuilder } from '@pixeasy/customizer';
|
|
301
|
+
import '@pixeasy/customizer/styles.css';
|
|
302
|
+
|
|
303
|
+
export default {
|
|
304
|
+
setup() {
|
|
305
|
+
const builder = createPixeasyBuilder();
|
|
306
|
+
|
|
307
|
+
onMounted(() => {
|
|
308
|
+
builder.open({
|
|
309
|
+
container: 'pixeasyBuilder',
|
|
310
|
+
apiKey: 'dk_xxx_yyy',
|
|
311
|
+
productId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
312
|
+
});
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
onBeforeUnmount(() => builder.close());
|
|
316
|
+
|
|
317
|
+
return {};
|
|
318
|
+
},
|
|
319
|
+
};
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
#### With Events and Options
|
|
323
|
+
|
|
324
|
+
```ts
|
|
325
|
+
import { onMounted, onBeforeUnmount } from 'vue';
|
|
326
|
+
import { createPixeasyBuilder, SDK_EVENTS } from '@pixeasy/customizer';
|
|
327
|
+
import '@pixeasy/customizer/styles.css';
|
|
328
|
+
|
|
329
|
+
export default {
|
|
330
|
+
props: {
|
|
331
|
+
submissionNumber: [String, null],
|
|
332
|
+
},
|
|
333
|
+
setup(props) {
|
|
334
|
+
const builder = createPixeasyBuilder();
|
|
335
|
+
|
|
336
|
+
onMounted(() => {
|
|
337
|
+
builder
|
|
338
|
+
.on(SDK_EVENTS.SDK_READY, () => {
|
|
339
|
+
console.log('Customizer initialized');
|
|
340
|
+
})
|
|
341
|
+
.on(SDK_EVENTS.SUBMISSION_SUCCESS, (event) => {
|
|
342
|
+
console.log('Saved:', event.submissionNumber);
|
|
343
|
+
})
|
|
344
|
+
.open({
|
|
345
|
+
container: 'pixeasyBuilder',
|
|
346
|
+
apiKey: 'dk_xxx_yyy',
|
|
347
|
+
productId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
348
|
+
submissionNumber: props.submissionNumber || undefined,
|
|
349
|
+
locale: 'en',
|
|
350
|
+
});
|
|
351
|
+
});
|
|
352
|
+
|
|
353
|
+
onBeforeUnmount(() => builder.close());
|
|
354
|
+
|
|
355
|
+
return {};
|
|
356
|
+
},
|
|
357
|
+
};
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
## Exports
|
|
361
|
+
|
|
362
|
+
The package exports the following:
|
|
363
|
+
|
|
364
|
+
### Classes & Functions
|
|
365
|
+
|
|
366
|
+
- **`createPixeasyBuilder()`** - Factory function to create a new `PixeasyBuilder` instance
|
|
367
|
+
- **`PixeasyBuilder`** - Main class for managing the customizer lifecycle
|
|
368
|
+
- **`definePixeasyCustomizerElement()`** - Registers the `<pixeasy-customizer>` custom element (auto-called internally)
|
|
369
|
+
- **`generateThumbnails()`** - Utility function to generate product thumbnails from SVG and 3D models
|
|
370
|
+
|
|
371
|
+
### Types
|
|
372
|
+
|
|
373
|
+
- **`PixeasyOpenOptions`** - Configuration object for `builder.open()`
|
|
374
|
+
- **`SdkElementConfig`** - Base configuration interface
|
|
375
|
+
- **`ManifestLoadedEventDetail`** - Payload for manifest-loaded event
|
|
376
|
+
- **`SdkReadyEventDetail`** - Payload for sdk-ready event
|
|
377
|
+
- **`SubmissionSuccessEventDetail`** - Payload for submission:success event
|
|
378
|
+
- **`SubmissionFailedEventDetail`** - Payload for submission:failed event
|
|
379
|
+
- **`ErrorEventDetail`** - Payload for error event
|
|
380
|
+
- **`SDK_EVENTS`** - Enum of all available event names
|
|
381
|
+
- **`BuilderEventName`** - Type-safe event name type
|
|
382
|
+
- **`ThumbnailView`** - View types for thumbnail generation ('front' | 'right' | 'back' | 'left')
|
|
383
|
+
- **`GeneratedThumbnail`** - Thumbnail generation result
|
|
384
|
+
|
|
385
|
+
### Stylesheets
|
|
386
|
+
|
|
387
|
+
- **`@pixeasy/customizer/styles.css`** - Required stylesheet (import once in your app)
|
|
388
|
+
|
|
389
|
+
## Common Use Cases
|
|
390
|
+
|
|
391
|
+
### Create a New Design from Scratch
|
|
392
|
+
|
|
393
|
+
```ts
|
|
394
|
+
builder.open({
|
|
395
|
+
container: 'pixeasyBuilder',
|
|
396
|
+
apiKey: 'dk_xxx_yyy',
|
|
397
|
+
productId: 'product-uuid',
|
|
398
|
+
});
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
### Use a Template/Predesign
|
|
402
|
+
|
|
403
|
+
```ts
|
|
404
|
+
builder.open({
|
|
405
|
+
container: 'pixeasyBuilder',
|
|
406
|
+
apiKey: 'dk_xxx_yyy',
|
|
407
|
+
productId: 'product-uuid',
|
|
408
|
+
predesignId: 'predesign-uuid', // Start with a pre-designed template
|
|
409
|
+
});
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
### Edit an Existing Submission
|
|
413
|
+
|
|
414
|
+
```ts
|
|
415
|
+
builder.open({
|
|
416
|
+
container: 'pixeasyBuilder',
|
|
417
|
+
apiKey: 'dk_xxx_yyy',
|
|
418
|
+
productId: 'product-uuid',
|
|
419
|
+
submissionNumber: 'SUB-12345', // Load existing submission
|
|
420
|
+
});
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
### Review Order (Read-Only)
|
|
424
|
+
|
|
425
|
+
```ts
|
|
426
|
+
builder.open({
|
|
427
|
+
container: 'pixeasyBuilder',
|
|
428
|
+
apiKey: 'dk_xxx_yyy',
|
|
429
|
+
productId: 'product-uuid',
|
|
430
|
+
submissionNumber: 'SUB-12345',
|
|
431
|
+
readonly: true, // Disable editing
|
|
432
|
+
});
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
### Multi-Language Support
|
|
436
|
+
|
|
437
|
+
```ts
|
|
438
|
+
builder.open({
|
|
439
|
+
container: 'pixeasyBuilder',
|
|
440
|
+
apiKey: 'dk_xxx_yyy',
|
|
441
|
+
productId: 'product-uuid',
|
|
442
|
+
locale: 'de', // German, or 'fr', 'es', etc.
|
|
443
|
+
});
|
|
444
|
+
```
|
|
445
|
+
|
|
446
|
+
## Best Practices
|
|
447
|
+
|
|
448
|
+
1. **Always import styles** - Include the CSS stylesheet once in your app:
|
|
449
|
+
|
|
450
|
+
```ts
|
|
451
|
+
import '@pixeasy/customizer/styles.css';
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
2. **Handle errors gracefully** - Always subscribe to the `error` event:
|
|
455
|
+
|
|
456
|
+
```ts
|
|
457
|
+
builder.on(SDK_EVENTS.ERROR, (event) => {
|
|
458
|
+
console.error(`Error [${event.code}]: ${event.message}`);
|
|
459
|
+
// Show user-friendly error message
|
|
460
|
+
});
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
3. **Validate API key and Product ID** - These are required for the customizer to function:
|
|
464
|
+
|
|
465
|
+
```ts
|
|
466
|
+
if (!apiKey || !productId) {
|
|
467
|
+
throw new Error('Missing required configuration');
|
|
468
|
+
}
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
4. **Clean up on unmount** - Always call `builder.close()` when the component unmounts to prevent memory leaks
|
|
472
|
+
|
|
473
|
+
5. **Use events for flow control** - Subscribe to `submission:success` to handle post-submission actions
|
|
474
|
+
|
|
475
|
+
6. **Handle locale properly** - Set the locale to match user preferences before opening
|
|
476
|
+
|
|
477
|
+
7. **Use readonly mode for reviews** - Enable `readonly: true` when showing past submissions or previews
|
|
Binary file
|
|
File without changes
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
@theme {
|
|
2
|
+
/* Primary Palette */
|
|
3
|
+
--color-primary-50: #aeaff2;
|
|
4
|
+
--color-primary-100: #a6a8f1;
|
|
5
|
+
--color-primary-200: #9698f0;
|
|
6
|
+
--color-primary-300: #8587f0;
|
|
7
|
+
--color-primary-400: #7477f0;
|
|
8
|
+
--color-primary-500: #6265f1;
|
|
9
|
+
--color-primary-600: #474aea;
|
|
10
|
+
--color-primary-700: #2c30e3;
|
|
11
|
+
--color-primary-800: #1f23ce;
|
|
12
|
+
--color-primary-900: #1e21ad;
|
|
13
|
+
--color-primary-950: #1d209d;
|
|
14
|
+
|
|
15
|
+
/* Updated Secondary Palette (Mint/Teal) */
|
|
16
|
+
--color-secondary-50: #e6fcf7;
|
|
17
|
+
--color-secondary-100: #ccf9f0;
|
|
18
|
+
--color-secondary-200: #99f3e1;
|
|
19
|
+
--color-secondary-300: #66ecd2;
|
|
20
|
+
--color-secondary-400: #33e6c4;
|
|
21
|
+
--color-secondary-500: #00dfb6;
|
|
22
|
+
--color-secondary-600: #00b394;
|
|
23
|
+
--color-secondary-700: #008772;
|
|
24
|
+
--color-secondary-800: #005c50;
|
|
25
|
+
--color-secondary-900: #003f38;
|
|
26
|
+
--color-secondary-950: #002e29;
|
|
27
|
+
|
|
28
|
+
/* PrimeNG variable aliases for Primary */
|
|
29
|
+
--color-p-primary-50: #aeaff2;
|
|
30
|
+
--color-p-primary-100: #a6a8f1;
|
|
31
|
+
--color-p-primary-200: #9698f0;
|
|
32
|
+
--color-p-primary-300: #8587f0;
|
|
33
|
+
--color-p-primary-400: #7477f0;
|
|
34
|
+
--color-p-primary-500: #6265f1;
|
|
35
|
+
--color-p-primary-600: #474aea;
|
|
36
|
+
--color-p-primary-700: #2c30e3;
|
|
37
|
+
--color-p-primary-800: #1f23ce;
|
|
38
|
+
--color-p-primary-900: #1e21ad;
|
|
39
|
+
--color-p-primary-950: #1d209d;
|
|
40
|
+
|
|
41
|
+
/* PrimeNG variable aliases for Updated Secondary Palette */
|
|
42
|
+
--color-p-secondary-50: #e6fcf7;
|
|
43
|
+
--color-p-secondary-100: #ccf9f0;
|
|
44
|
+
--color-p-secondary-200: #99f3e1;
|
|
45
|
+
--color-p-secondary-300: #66ecd2;
|
|
46
|
+
--color-p-secondary-400: #33e6c4;
|
|
47
|
+
--color-p-secondary-500: #00dfb6;
|
|
48
|
+
--color-p-secondary-600: #00b394;
|
|
49
|
+
--color-p-secondary-700: #008772;
|
|
50
|
+
--color-p-secondary-800: #005c50;
|
|
51
|
+
--color-p-secondary-900: #003f38;
|
|
52
|
+
--color-p-secondary-950: #002e29;
|
|
53
|
+
}
|