The Checkpoint component records when an end-user reaches a specific point in a module. Checkpoint data is stored in submission metadata and can be used to track progress, enforce prerequisites, or control conditional navigation.
Checkpoint data is accessible through
data.getMetadata.checkpoints.
How to read settings tables
The tables below describe each configurable option as it displays in the Unqork IDE. Values are formatted as follows:
inline code— a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked
General Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Property ID | key |
Text input | cp |
The unique identifier for this component instance. |
Display Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Label Text | label |
Text input | — | Identifies the component on the Module Builder canvas. This label does not display. |
Data Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Allow Checkpoint to be Set Multiple Times | allowupdate |
Toggle | OFF | When ON, the checkpoint records every time the end-user reaches this point (including if they navigate backward and return). When OFF, the checkpoint records only the first visit. |
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |