Skip to main content

Checklist​

The checklist methods allow you to open checklists, close them, and mark individual items as complete. All methods are available on window.USETIFUL.checklist.

start(checklistId)​

Opens a checklist by its ID. The checklist ID is defined in the Guides and Surveys dashboard when creating or editing a checklist.

ParameterTypeRequired
checklistIdstringYes
window.USETIFUL.checklist.start(checklistId)

Example​

window.USETIFUL.checklist.start('checklist-1');

close()​

Closes the currently displayed checklist. If no checklist is open, this method has no effect.

window.USETIFUL.checklist.close()

Example​

window.USETIFUL.checklist.close();

done(rowNumbers, checklistId?)​

Marks one or more checklist items as complete. Row numbers are 1-indexed, corresponding to the item positions defined in the checklist.

When checklistId is provided, the specified items are marked complete on that checklist. When omitted, the items are marked on the currently displayed checklist.

ParameterTypeRequired
rowNumbersnumber[]Yes
checklistIdstringNo
window.USETIFUL.checklist.done(rowNumbers, checklistId?)

Example​

// Mark items 1 and 3 on the active checklist
window.USETIFUL.checklist.done([1, 3]);

// Mark item 2 on a specific checklist
window.USETIFUL.checklist.done([2], 'checklist-1');