@mxenabled/connect-widget 0.13.7 → 0.14.0
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 +13 -12
- package/dist/index.es.js +30 -5506
- package/dist/index.es.js.map +1 -1
- package/dist/lastBuild.txt +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,18 +34,19 @@ const App = () => {
|
|
|
34
34
|
|
|
35
35
|
## Props
|
|
36
36
|
|
|
37
|
-
| **Prop** | **Type**
|
|
38
|
-
| :----------------------------- |
|
|
39
|
-
| `clientConfig` | [`ClientConfigType`](./typings/connectProps.d.ts)
|
|
40
|
-
| `language` | [`LanguageType`](./typings/connectProps.d.ts)
|
|
41
|
-
| `onAnalyticEvent` | [`AnalyticContextType`](./typings/connectProps.d.ts)
|
|
42
|
-
| `onAnalyticPageview` | [`AnalyticContextType`](./typings/connectProps.d.ts)
|
|
43
|
-
| `onPostMessage` | [`PostMessageContextType`](./typings/connectProps.d.ts)
|
|
44
|
-
| `
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
37
|
+
| **Prop** | **Type** | **Description** | **Default** |
|
|
38
|
+
| :----------------------------- | :--------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------- |
|
|
39
|
+
| `clientConfig` | [`ClientConfigType`](./typings/connectProps.d.ts) | The connect widget uses the config to set the initial state and behavior of the widget. [More details](./docs/CLIENT_CONFIG.md) | See more details |
|
|
40
|
+
| `language` | [`LanguageType`](./typings/connectProps.d.ts) | The connect widget supports multiple languages and custom copy. Supported locale options: `en`, `es`, and `fr-ca`. | `{ locale: 'en', custom_copy_namespace: '' }` |
|
|
41
|
+
| `onAnalyticEvent` | [`AnalyticContextType`](./typings/connectProps.d.ts) | The connect widget provides a way to track events and pageviews using your own analytics provider. [More details](./docs/ANALYTICS.md#onanalyticevent) | `null` |
|
|
42
|
+
| `onAnalyticPageview` | [`AnalyticContextType`](./typings/connectProps.d.ts) | The connect widget provides a way to track events and pageviews using your own analytics provider. [More details](./docs/ANALYTICS.md#onanalyticpageview) | `null` |
|
|
43
|
+
| `onPostMessage` | [`PostMessageContextType`](./typings/connectProps.d.ts) | The connect widget uses post messages to communicate with the parent window. [More details](./docs/POST_MESSAGES.md) | `null` |
|
|
44
|
+
| `postMessageEventOverrides` | [`PostMessageEventOverrides`](./typings/connectProps.d.ts) | These can be used to override the post message events for specific post messages | `null` |
|
|
45
|
+
| `onShowConnectSuccessSurvey` | [`AnalyticContextType`](./typings/connectProps.d.ts#L100) | The connect widget provides a way to let your analytics provider know that the connect success survey was shown. [More details](./docs/ANALYTICS.md#onShowConnectSuccessSurvey) |
|
|
46
|
+
| `onSubmitConnectSuccessSurvey` | [`AnalyticContextType`](./typings/connectProps.d.ts#L101) | The connect widget provides a way to submit connect success survey responses using your own analytics provider. [More details](./docs/ANALYTICS.md#onSubmitConnectSuccessSurvey) | |
|
|
47
|
+
| `profiles` | [`ProfilesTypes`](./typings/connectProps.d.ts) | The connect widget uses the profiles to set the initial state of the widget. [More details](./docs/PROFILES.md) | See more details |
|
|
48
|
+
| `userFeatures` | [`UserFeaturesType`](./typings/connectProps.d.ts) | The connect widget uses user features to determine the behavior of the widget. [More details](./docs/USER_FEATURES.md) | See more details |
|
|
49
|
+
| `showTooSmallDialog` | `boolean` | The connect widget can show a warning when the widget size is below the supported 320px. | `true` |
|
|
49
50
|
|
|
50
51
|
## ApiProvider
|
|
51
52
|
|