What is the widget API?
Userpace's widget API will allow you to manipulate the widget directly from your code.
Example: you can collect feedback on a specific feature in your web-app.
You can build your own button in your interface which will trigger the widget and open the feedback form.
Usage
Simply call our pre-built Javascript functions:
userpace.open()
Opens the widget on the home screen. If the widget has been used before on the same page, the last screen will be shown.
userpace.open(string action, object options)
Opens the widget and loads a screen based on a list of available actions & options.
Actions
- home: home screen
- newNps: NPS form
- newFeedback: feedback form
- listFeedbacks: feedback list
- listIdeas: ideas list
Options
- header: show / hide the header inside the widget (boolean)
Example
userpace.open('newNps', { header: false })
userpace.close()
Closes the widget.
