hivewrite-sdk 1.1.20 → 1.1.21
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 -14
- package/bundle.min.js +1 -1
- package/index.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -98,19 +98,19 @@ Initializes and mounts the editor.
|
|
|
98
98
|
|
|
99
99
|
#### SDKConfig Parameters
|
|
100
100
|
|
|
101
|
-
| Parameter | Type | Required | Description
|
|
102
|
-
| :------------- | :---------------------- | :------- |
|
|
103
|
-
| `apiKey` | `string` | Yes | Your HiveWrite API Key
|
|
104
|
-
| `container` | `string \| HTMLElement` | Yes | CSS selector or DOM element to mount the editor
|
|
105
|
-
| `userId` | `string` | No | Unique identifier for the current user
|
|
106
|
-
| `mode` | `string` | Yes | `'FULL_EDITOR'`, `'DESIGN_ONLY'`, `'READ_ONLY'`
|
|
107
|
-
| `theme` | `string` | No | `'light'` (default) or `'dark'`
|
|
108
|
-
| `locale` | `string` | No | `'en'` (default), `'es'`, or `'fr'`
|
|
109
|
-
| `branding` | `object` | No | Custom white-labeling options (`primaryColor`, `secondaryColor`, `accentColor`, `logoUrl`, `customCSS`)
|
|
110
|
-
| `permissions` | `object` | No | Toggle features: `showExport`, `showAiMagic`, `showUploadImages`, `showSaveButton`, `showTemplateLibrary`, `showStarterTemplates` |
|
|
111
|
-
| `mergeTags` | `array` | No | Array of `{ label, value }` for dynamic content
|
|
112
|
-
| `portalTarget` | `string` | No | `'window'` (default) or `'container'`. Controls where dialogs render.
|
|
113
|
-
| `callbacks` | `object` | No | Event hooks for SDK actions
|
|
101
|
+
| Parameter | Type | Required | Description |
|
|
102
|
+
| :------------- | :---------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
103
|
+
| `apiKey` | `string` | Yes | Your HiveWrite API Key |
|
|
104
|
+
| `container` | `string \| HTMLElement` | Yes | CSS selector or DOM element to mount the editor |
|
|
105
|
+
| `userId` | `string` | No | Unique identifier for the current user |
|
|
106
|
+
| `mode` | `string` | Yes | `'FULL_EDITOR'`, `'DESIGN_ONLY'`, `'READ_ONLY'` |
|
|
107
|
+
| `theme` | `string` | No | `'light'` (default) or `'dark'` |
|
|
108
|
+
| `locale` | `string` | No | `'en'` (default), `'es'`, or `'fr'` |
|
|
109
|
+
| `branding` | `object` | No | Custom white-labeling options (`primaryColor`, `secondaryColor`, `accentColor`, `logoUrl`, `customCSS`) |
|
|
110
|
+
| `permissions` | `object` | No | Toggle features: `showExport`, `showAiMagic`, `showUploadImages`, `showSaveButton`, `showTemplateLibrary`, `showStarterTemplates`, `showHtmlImport` |
|
|
111
|
+
| `mergeTags` | `array` | No | Array of `{ label, value }` for dynamic content |
|
|
112
|
+
| `portalTarget` | `string` | No | `'window'` (default) or `'container'`. Controls where dialogs render. |
|
|
113
|
+
| `callbacks` | `object` | No | Event hooks for SDK actions |
|
|
114
114
|
|
|
115
115
|
---
|
|
116
116
|
|
|
@@ -336,7 +336,7 @@ The `loadDesign(data)` method and `onSave` callback use a specific JSON structur
|
|
|
336
336
|
"fontFamily": "Inter, sans-serif",
|
|
337
337
|
"padding": "32px",
|
|
338
338
|
"spacing": 16,
|
|
339
|
-
"mobileScaling": 80,
|
|
339
|
+
"mobileScaling": 80,
|
|
340
340
|
"branding": {
|
|
341
341
|
"primary": "#000000",
|
|
342
342
|
"secondary": "#4b5563",
|