surveysparrow-ionic-plugin 1.0.0 → 1.0.2
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 +24 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -65,8 +65,31 @@ loadFullScreenSurveyWithValidation(options: { domain: String; token: String; par
|
|
|
65
65
|
| Param | Type |
|
|
66
66
|
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
67
67
|
| **`options`** | <code>{ domain: <a href="#string">String</a>; token: <a href="#string">String</a>; params: <a href="#object">Object</a>; properties: <a href="#object">Object</a>; }</code> |
|
|
68
|
-
|
|
69
68
|
--------------------
|
|
70
69
|
|
|
70
|
+
## Validations
|
|
71
|
+
|
|
72
|
+
Validations include **Limit Submission Per User** and **Survey Throttling**.
|
|
73
|
+
|
|
74
|
+
To achieve this, the **`emailaddress`** of the user must be passed in the `params` object.
|
|
75
|
+
|
|
76
|
+
## Params
|
|
77
|
+
|
|
78
|
+
The `params` object allows passing **survey variables**, which can be accessed in the survey's end-user interface. Ensure that the spelling of survey variables matches the configured values. Additionally, make sure to include the **`emailaddress`** field for validations.
|
|
79
|
+
|
|
80
|
+
## Properties
|
|
81
|
+
|
|
82
|
+
The `properties` object includes the following parameters:
|
|
83
|
+
|
|
84
|
+
1. **`isCloseButtonEnabled`** (default: `true`)
|
|
85
|
+
- If set to `false`, the close button will be removed.
|
|
86
|
+
- **Note:** Disabling this option will also disable the survey validation.
|
|
87
|
+
|
|
88
|
+
2. **`langcode`** (default: `en`)
|
|
89
|
+
- To load the survey in a specific language, pass the corresponding language code.
|
|
90
|
+
- Ensure that the language is configured in the SurveySparrow app.
|
|
91
|
+
- A list of supported language codes can be found [here](https://docs.google.com/document/d/1cmmWJQba8B3UkV6g5m93DgpenVojclzeOB0mdn-rlrg/edit?usp=sharing).
|
|
92
|
+
|
|
93
|
+
|
|
71
94
|
## Support
|
|
72
95
|
For questions or issues, contact us at [support@surveysparrow.com](mailto:support@surveysparrow.com).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "surveysparrow-ionic-plugin",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "SurveySparrow SDK enables you to collect feedback from your mobile app. Embed the Classic, Chat & NPS surveys in your ionic application seamlessly with few lines of code.",
|
|
5
5
|
"main": "dist/plugin.cjs.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|