For the complete documentation index, see llms.txt. This page is also available as Markdown.

Javascript API

Want to create some custom behavior for your Zigpoll?

Single Page Web Apps

If you have a single page website you can still use Zigpoll. All you need to do is run the following code immediately after you change a page within your app.

window.Zigpoll.refresh();

Programmatically Toggle The Poll

If you want to toggle your Zigpoll programmatically (like when a user clicks a button) use the following function.

window.Zigpoll.toggle();

This will toggle your Zigpoll open and closed.

Alternatively you can use:

window.Zigpoll.open();
window.Zigpoll.close();

To open and close the Zigpoll respectively.

Trigger Event Once Zigpoll Is Loaded

To trigger some behavior once the Zigpoll has loaded, use the onload parameter of the Zigpoll object. For example:

window.Zigpoll.onload = function () { console.log('Zigpoll loaded') }

This will run once immediately after the Zigpoll has been loaded on your page.

Trigger Event When Zigpoll Is Closed

To run some behavior when a respondent closes the Zigpoll — for example after they finish a survey — set the onClose parameter of the Zigpoll object:

onClose is called with the respondent's submitted answers: an array with one entry per answered slide. Each entry contains the slide (the question) and the response (the submitted answer); multi-select questions also include a responses array.

Last updated