@openlettermarketing/olc-react-sdk 1.8.5-beta.1 → 1.8.6-beta.1
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 +7 -2
- package/build/index.js +3 -3
- package/build/index.js.map +1 -1
- package/build/types/src/utils/constants.d.ts +4 -0
- package/build/types/version.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -70,10 +70,15 @@ The SDK uses several properties to manage its behavior. Below is a breakdown of
|
|
|
70
70
|
| `createTemplateRoute` | _string_ | The route/path for creating new templates. _(begins with slash `/`)_ | ⤫ | `'/create-template'` |
|
|
71
71
|
| `templateBuilderRoute` | _string_ | The route/path for editing existing templates. _(begins with slash `/`)_ | ⤫ | `'/edit-template'` |
|
|
72
72
|
| `olcTemplate` | _object_ | The template object to be edited or used as a base. | ⤫ | `{ ... }` |
|
|
73
|
-
| `sandbox` | _boolean_ | The sandbox setting can be either true or false. Set to true for demo purposes and false for production. | ⤫ | `true`
|
|
73
|
+
| `sandbox` | _boolean_ | The sandbox setting can be either true or false. Set to true for demo purposes and false for production. | ⤫ | `true`
|
|
74
|
+
| `templateGalleryModal` | _boolean_ | The templateGalleryModal setting can be either true or false. Set to true for modal view and false for sidebar template gallery. | ⤫ | `true`
|
|
75
|
+
| `designerQueryAmount` | _number_ | The designerQueryAmount prop is used in the "Hire a Designer" card within the template gallery section to display the specified amount. | ⤫ | `25`
|
|
76
|
+
| `allowedAddOns` | _string[ ]_ | The allowedAddOns prop lets you specify which add-ons appear in the add-ons section by providing their keys as an array of strings. You can add or remove add-ons as needed by updating this array. | ⤫ | `['property_offer','gsv']` |
|
|
74
77
|
| `allowSenderFields` | _boolean_ | The allowSenderFields prop can be set to either true or false. When set to true, it makes the sender fields visible in the custom fields section. | ⤫ | `true` |
|
|
75
78
|
| `allowPropertyFields` | _boolean_ | The allowPropertyFields prop can be set to either true or false. When set to true, it makes the property fields visible in the custom fields section. | ⤫ | `true` |
|
|
76
|
-
| `
|
|
79
|
+
| `allowedTemplateSections` | _string[ ]_ | The allowedTemplateSections prop lets you control which sections appear in the template gallery by adding or removing them as needed. | ⤫ | `['my_templates', 'team_templates']` |
|
|
80
|
+
| `restrictedProducts` | _number[]_ | The restrictedProducts prop filters products on the product selection screen, allowing you to show or hide products as needed. Simply include the product IDs in the array to filter out specific products. | ⤫ | `[9, 11, 13]` |
|
|
81
|
+
| `excludedFields` | _string[ ]_ | The excludedFields prop allows you to remove specific fields from the custom fields section by their key | ⤫ | `['{{C.EMAIL}}','{{SPF.LAST_NAME}}']` |
|
|
77
82
|
| `templateGalleryModal` | _boolean_ | The templateGalleryModal prop can be set to either true or false. When set to false, it disables the template gallery modal and activates the sidebar gallery in the template builder. | ⤫ | `true` |
|
|
78
83
|
| `onReturnAndNavigate` | _function_ | An event which triggers when a user navigates away. | ⤫ | `onReturnAndNavigate () { ... }` |
|
|
79
84
|
| `onGetOneTemplate` | _function_ | An event which triggers when fetching a specific template. | ⤫ | `onGetOneTemplate ( payload ) { ... }` |
|