@openlettermarketing/olc-react-sdk 2.1.14 → 2.1.16
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
CHANGED
|
@@ -84,17 +84,12 @@ key props:
|
|
|
84
84
|
| `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']` |
|
|
85
85
|
| `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` |
|
|
86
86
|
| `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` |
|
|
87
|
-
| `showQrScanNotificationFields` | _boolean_ | Shows the QR code scan notification checkbox and notification email field when creating or editing QR codes. Defaults to false. | ⤫ | `true` |
|
|
88
|
-
| `defaultQrNotificationEmail` | _string_ | Prefills the QR code notification email as an editable suggestion when scan notification fields are enabled. Defaults to an empty string. | ⤫ | `'user@example.com'` |
|
|
89
|
-
| `qrScanNotificationEnabled` | _boolean_ | Enables the QR scan notification checkbox when the notification fields are visible. Set to false to show the feature disabled with an upgrade tooltip. Defaults to true. | ⤫ | `true` |
|
|
90
|
-
| `onUpgradePlanNavigate` | _function_ | Optional navigation callback for the QR scan notification upgrade tooltip. Use this to route users to your plan page without a full page reload. | ⤫ | `onUpgradePlanNavigate () { ... }` |
|
|
91
87
|
| `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']` |
|
|
92
88
|
| `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]` |
|
|
93
89
|
| `excludedFields` | _string[ ]_ | The excludedFields prop allows you to remove specific fields from the custom fields section by their key | ⤫ | `['{{C.EMAIL}}','{{SPF.LAST_NAME}}']` |
|
|
90
|
+
| `hideCurvedTextEffect` | _boolean_ | Hides the Polotno "Curved text" control from the text Effects menu. Defaults to `true` so users cannot apply the curved text effect in the template builder. | ⤫ | `true` |
|
|
94
91
|
| `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` |
|
|
95
92
|
| `onReturnAndNavigate` | _function_ | An event which triggers when a user navigates away. | ⤫ | `onReturnAndNavigate () { ... }` |
|
|
96
|
-
| `onHireDesignerNavigate` | _function_ | An event which triggers when the user selects the optional "Hire a Designer" card and clicks Next. | ⤫ | `onHireDesignerNavigate () { ... }` |
|
|
97
|
-
| `onUpgradePlanNavigate` | _function_ | Optional navigation callback for paid-feature upgrade links. | ⤫ | `onUpgradePlanNavigate () { ... }` |
|
|
98
93
|
| `onGetOneTemplate` | _function_ | An event which triggers when fetching a specific template. | ⤫ | `onGetOneTemplate ( payload ) { ... }` |
|
|
99
94
|
| `onGetTemplates` | _function_ | An event which triggers when fetching all templates. | ⤫ | `onGetTemplates ( payload ) { ... }` |
|
|
100
95
|
| `onGetCustomFields` | _function_ | An event which triggers when fetching custom fields for templates. | ⤫ | `onGetCustomFields () { ... }` |
|
|
@@ -142,6 +137,7 @@ const App = () => {
|
|
|
142
137
|
secretKey: 'your-secret-key',
|
|
143
138
|
publicApiKey: 'your-api-key',
|
|
144
139
|
sandbox: false,
|
|
140
|
+
hideCurvedTextEffect: true,
|
|
145
141
|
async onSubmit (payload) {
|
|
146
142
|
console.log('Template submitted:', payload);
|
|
147
143
|
// Implement your submission logic here
|