@mopinion/deploy
v2.2.4
Published
Deploy your Mopinion feedback forms with ease
Downloads
1,613
Readme
Mopinion Deploy
Mopinion Deploy allows you to easily install Mopinion deployments into your application and collect feedback without using external JavaScript. Usually you'll want to use Mopinion Deploy together with Mopinion Survey so you don't have any dependencies for external JavaScript.
Installation
Install Mopinion Deploy and Mopinion Survey via npm:
npm install @mopinion/deploy @mopinion/survey --save
Or install with yarn:
yarn add @mopinion/deploy @mopinion/survey
Support
If you need help, want to report an issue or have a question you can reach out to our Support Team via [email protected]. Please make sure to include your Mopinion account when contacting our Support Team.
Usage
Build your surveys and deployment(s) inside the Mopinion application and use the following code to run the deployment on your website.
Example
import mopinionDeploy from '@mopinion/deploy';
import mopinionSurvey from '@mopinion/survey';
const deploymentId: string = 'exampledeploymentid';
type surveyAdapter = {
open: function,
isOpen: function,
clearForm: function
} => void;
interface surveyOptions {
adapter?: surveyAdapter
}
const options: {
survey?: surveyOptions
} = {
survey: {
adapter: mopinionSurvey
}
}
mopinionDeploy.load(deploymentId, options);
Options
deploymentId
- required
Get the deployment id from the Mopinion application in the 'Deployments' section.
survey.adapter
- optional
Specifies the adapter to use to trigger surveys. If no adapter is passed @mopinion/survey
is loaded from the Mopinion CDN.
Options for proxying requests
You may optionally opt to proxy all requests done by Mopinion Deploy and Mopinion Survey to prevent any direct requests to third party servers. Note that support on this solution is only provided with additional licensing. Contact [email protected] for more information.