> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/how-the-apps-work/screens/checklists/checklist.md).

# Checklist

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). Platforms: web, iOS and Android. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/checklists/checklist.md).
{% endhint %}

Fill in a checklist on a task, an asset or a planned task: tick each item, answer it (pass, flag, fail or NA; yes or no; or a rating from 1 to 5), add notes and photos, and sign off with a signature.

![Checklist](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-b8a99f93dd2ddceb98c91a917177d9202aabb69b%2Fchecklist.png?alt=media)

* **Where:** web: the checklist card in the right column of [Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md), the same card on [Asset detail](https://docs.snapfix.com/how-the-apps-work/screens/assets/asset-detail.md) and on a [planned task](https://docs.snapfix.com/how-the-apps-work/screens/planner/planned-task.md), and the "View Checklist" dialog that the card opens. iOS: the checklist row in the task header, which opens `NewCheckListVC`. Android: the same row, which opens `ViewCheckListActivity`.
* **Who:** anyone who can open the task sees its checklist. Ticking, answering, noting and photographing follow the task's own rules ([Who can do what](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#who-can-do-what)). Editing, adding, setting as a template and removing need the site's "manage checklist" permission. The API checks neither rule on the item routes \[[ASK-67](https://github.com/snapfix/docs/blob/main/ASK.md#ask-67-who-may-tick-answer-reset-and-photograph-checklist-items)].
* **Feature:** [Checklists](https://docs.snapfix.com/product/features/checklists/checklists.md); scores are in [Checklist scores](https://docs.snapfix.com/product/features/checklists/checklist-scores.md), templates in [Checklist templates](https://docs.snapfix.com/product/features/checklists/checklist-templates.md).

The sections and items are set in [Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md). The data comes from the [Checklists API](https://docs.snapfix.com/engineering-reference/api/checklists.md): the web reads the items with [`GET /v1/app/todos`](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1apptodos) and writes each change at once; the apps write their copy on the device and send it later with the php-apis save actions.

## Getting here

* **From a task.** Web: the checklist card in [Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md). iOS and Android: the checklist row in the task header ([Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#layout)).
* **From an asset.** The same card and screens. On the web, an asset's empty card reads "Checklist Template", with an info text "If you update this checklist template, it will be included when you create a task or a planned task."
* **From a planned task.** Web: the card on a [planned task](https://docs.snapfix.com/how-the-apps-work/screens/planner/planned-task.md) shows the checklist the planned task will use. It has no percentage ring, and nothing can be ticked or photographed there.
* **From Housekeeping.** Web: the task preview drawer shows the card read-only, without its menu or "+".
* **Empty checklist.** A task with no checklist shows a "Checklist" header with a "+" (web), or "Add Checklist" (iOS and Android). On iOS and Android the editor opens by itself the first time a person who can manage checklists opens an empty checklist ([Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md)).

## Layout

### Web

1. **Checklist card.** A percentage ring (not on planned tasks), the checklist name (translated when the site has translation on), its description and the time of the last change. Clicking the card opens [View checklist](#view-checklist). The three-dot icon opens the [checklist menu](#checklist-menu); it shows when the task can be changed (not locked, archived or outside its time range) and not in the housekeeping drawer.
2. **Checklist summary.** Under the card, once an answer exists ([Summary](#summary)).
3. **Signature box.** Under the summary, only when the checklist needs a signature: "Sign off checklist", or "Checklist signed off" with the signature and the signer's name. The box is styled as disabled for the people who may sign, and enabled for the others. The view dialog itself has no signature box.

The summary and the signature box are hidden on planned tasks and in the housekeeping drawer.

**View checklist dialog.** The title is the checklist name with the percentage in brackets, such as "Room 101 checks (63%)". Then one card per section, in order: the section name, its percentage (or "NA" when the section is marked NA), and an arrow that opens it. A checklist with a single section opens it at once. A section whose checklist allows NA has a switch on its row, with no label. Items without a section are listed under a section named "Default". Each item row has:

* a checkbox and the item name, with a "\*" when the item is mandatory, and an NFC icon on Smart Tag items (marked when scanned);
* the answer control of its type ([Inputs](#inputs));
* when the item has notes on: a note field with a send button, and a camera button ("Add Media");
* "Show Media" or "Hide Media" when it has photos, which opens the photo strip;
* its description, with "Show More" or "Show less" when it is longer than three lines or 200 characters.

### iOS

`NewCheckListVC` is a full screen with:

1. A title (the task name, or its translation) and a circular percentage.
2. The score card "Completed N (P%)" with the pass, flag, fail, yes and no counts ([Summary](#summary)).
3. A table of sections (header rows) and items, each item with its answer control, and a note field and photo strip when notes are on.
4. The signature area with "Sign off checklist" or "Checklist signed off", a drawing pad and "Submit", when the checklist needs a signature.
5. A bottom bar: an NFC button (on phones with NFC), "Edit Checklist" (only for people who can manage checklists) and "Clear All" (hidden when there are no items). The bar is dimmed and disabled when the task is archived or locked, when the user is inactive in the group, when the task is planned for a later day, or when its time range is closed.

### Android

`ViewCheckListActivity` is a full screen with:

1. A toolbar with a back button and the title.
2. An expandable list of sections and items, with the same answer controls as iOS.
3. A score footer headed "Checklist Scores", with "Pass", "Flag", "Fail", "Yes" and "No".
4. The signature box ("Signature", "Submit", and "Checklist signed off" once signed) and "Checklist Summary".
5. A bottom bar with "Edit Checklist" (only for people who can manage checklists, `fManageChecklist`) and "Clear All". The bar, the drawing and "Submit" are disabled when the task is archived, locked, future-dated, outside its time range, or the user is inactive.

## Inputs

| Field                  | Type                               | Required                           | Default    | Rules and messages                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ---------------------- | ---------------------------------- | ---------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Item tick              | Checkbox                           | No                                 | Unticked   | A tick is refused while the item's mandatory note or photo is missing: "A Note is mandatory for this checklist-item", "A Photo is mandatory for this checklist-item" or "Both a Note and a Photo are mandatory for this checklist-item" (same texts on all three platforms). The API does not check these. A Smart Tag item can't be ticked by hand unless the group allows it ([Rules](#rules)). Unticking has no checks.                                                   |
| Pass, flag, fail or NA | One of four                        | No                                 | None       | The web shows thumbs up (pass), a flag, thumbs down (fail) and the text "NA". Choosing the selected answer again clears it. Choosing one ticks the item when its mandatory note and photo are there; otherwise the answer is saved and the item stays unticked, with no message.                                                                                                                                                                                             |
| Yes or no              | Two buttons                        | No                                 | Unanswered | Web: "Yes" and "No". Choosing the selected answer again clears it. Ticks the item like the answers above.                                                                                                                                                                                                                                                                                                                                                                    |
| Rating                 | 1 to 5                             | No                                 | None       | Five numbered circles. Choosing the selected number again clears it to 0. A rating above 0 ticks the item like the answers above.                                                                                                                                                                                                                                                                                                                                            |
| Note                   | Text                               | When the item's note is mandatory  | Empty      | Placeholder "Add note or action taken" (empty for people who can't change the task). Trimmed, up to 1,000 characters on the web. The web saves it when the field loses focus; the send button only shows a spinner while it saves. A note that is not empty ticks the item like the answers above.                                                                                                                                                                           |
| Photo or video         | Image, video, sketch or typed text | When the item's photo is mandatory | None       | Only on items with notes on, on all three platforms. Up to 9 per item: iOS and Android check it on the device, and on the web the server refuses the tenth with "You can add up to 9 Images/Videos for this note." ([`POST /v1/app/todo-medias`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1apptodo-medias)). The web gallery opens only the first nine. On the web a typed text is saved as a photo, and a video gets a first-frame thumbnail. |
| Section NA             | Switch                             | No                                 | On         | Shown only when the section allows NA. Off marks the section NA: it closes, and its items leave the percentage, the mandatory check, the summary and (Android) Smart Tag scans.                                                                                                                                                                                                                                                                                              |
| Signature              | Drawing                            | When the checklist needs one       | Empty      | "Submit" stays disabled until something is drawn. It is refused while a mandatory item is unticked: "Signature can't be added" with "This checklist has mandatory items that are not yet checked. Complete them before adding your signature." (all three platforms).                                                                                                                                                                                                        |

## Actions

The API column shows the web's calls. The apps save each change on the device and send it later with the php-apis save actions: items with [`save_pri_job_todo`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-actionsave_pri_job_todo), notes with [`save_pri_job_todo_notes`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-actionsave_pri_job_todo_notes), photos with [`save_pri_job_todo_media`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-actionsave_pri_job_todo_media).

| Action                            | Who                                                                                                                                                                                                         | What happens                                                                                                                                                                                                                                                                                                                                                   | API                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tick or untick an item            | People who can change the task                                                                                                                                                                              | Changes the checkbox at once; if the server refuses, the web puts it back. A tick may move the task's status ([Rules](#rules)). On a signed checklist the web first asks to reset the signature ([Signature alerts](#signature-alerts)). Unticking keeps the item's completion time. A tick that brings the checklist to 100% sends the "Checklist 100%" push. | [`PUT /v1/app/todos/check/{uuid}`](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1apptodoscheckuuid), [`PUT /v1/app/todos/uncheck/{uuid}`](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1apptodosuncheckuuid)                                                                                                                                                                                                                                                                                           |
| Answer an item                    | People who can change the task                                                                                                                                                                              | Saves pass, flag, fail or NA, yes or no, or the rating, then ticks the item when it can ([Inputs](#inputs)). Choosing the same answer again clears it.                                                                                                                                                                                                         | [`PUT /v1/app/todos/{uuid}`](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1apptodosuuid), then the tick                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Write a note                      | People who can change the task                                                                                                                                                                              | Saves the note when the field loses focus, then ticks the item when it can.                                                                                                                                                                                                                                                                                    | [`PUT /v1/app/todos/{uuid}`](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1apptodosuuid)                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Mark a section NA                 | People who can change the task                                                                                                                                                                              | The section switch; see [Inputs](#inputs).                                                                                                                                                                                                                                                                                                                     | [`PUT /v1/app/todos/{uuid}`](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1apptodosuuid)                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Add a photo or video              | People who can change the task; not on planned tasks                                                                                                                                                        | Web: the camera button opens [Add a photo or video](#add-a-photo-or-video). Apps: the camera opens from the item.                                                                                                                                                                                                                                              | [`POST /v1/app/todo-medias`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1apptodo-medias)                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Show or hide photos               | Anyone who sees the item                                                                                                                                                                                    | "Show Media" opens the photo strip; "Hide Media" closes it. A photo opens in a full-screen gallery.                                                                                                                                                                                                                                                            | None                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Use a photo's menu                | Anyone who sees the photo; see [Photo menu](#photo-menu)                                                                                                                                                    | Download, copy the link, create a task from the photo, or delete it after a confirmation.                                                                                                                                                                                                                                                                      | [`DELETE /v1/app/todo-medias/{uuid}`](https://docs.snapfix.com/engineering-reference/api/checklists.md#delete-v1apptodo-mediasuuid); create a task: [Add a Task](https://docs.snapfix.com/how-the-apps-work/screens/tasks/add-task.md)                                                                                                                                                                                                                                                                                                                   |
| Create a task from an item (apps) | People who may create tasks; not on assets                                                                                                                                                                  | A long press on the item name or on an answer starts a new task named after the item and the answer, such as "Check the door seal - Fail". iOS needs a connection.                                                                                                                                                                                             | Task create flow                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Clear the checklist               | Web: anyone who sees the checklist menu, once the checklist has been started. iOS and Android: anyone who sees "Clear All". No platform checks the manage-checklist permission, and the API doesn't either. | Asks first ([Clear checklist](#clear-checklist)), then clears every tick, answer, note and photo, adds the chat line "unchecked all checklist items", and resets the signature. iOS also clears Smart Tag scans and section NA marks on the device.                                                                                                            | [`GET /v1/app/todos/reset`](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1apptodosreset)                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Sign off                          | People who can change the task, with every mandatory item ticked                                                                                                                                            | Draw, then "Submit"; "Clear" empties the pad and "Close" hides it (web). The box then shows "Checklist signed off" with the signature. iOS shows the toast "Signature added successfully." and adds a sign-off chat line with the percentage. Android asks for storage access first.                                                                           | [`POST /v1/app/tasks/{uuid}/signature`](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-v1apptasksuuidsignature)                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Reset the signature               | People who can change the task, on a signed checklist                                                                                                                                                       | See [Signature alerts](#signature-alerts).                                                                                                                                                                                                                                                                                                                     | [`POST ?action=webcust_reset_job_signature`](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-actionwebcust_reset_job_signature)                                                                                                                                                                                                                                                                                                                                                                                                         |
| Open the view dialog              | Web: anyone, while the task can be changed                                                                                                                                                                  | Opens [View checklist](#view-checklist). The first time a checklist that hasn't been started is opened by someone who can save, it is copied into the task first ([When the dialog opens](#when-the-dialog-opens)). A locked, archived or out-of-range task's checklist can't be opened at all.                                                                | First open only: [`PUT /v1/app/tasks/{uuid}/todo-name`](https://docs.snapfix.com/engineering-reference/api/tasks.md#put-v1apptasksuuidtodo-name), [`POST /v1/app/todos/multi`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1apptodosmulti), and [`PUT /v1/app/tasks/{uuid}/signature`](https://docs.snapfix.com/engineering-reference/api/tasks.md#put-v1apptasksuuidsignature) when the template needs a signature                                                                                                           |
| Open the editor                   | People who can manage checklists. On the web, a checklist made from a template only for site admins; planned tasks always.                                                                                  | Opens [Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md).                                                                                                                                                                                                                                                       | See [Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Add a checklist                   | Web: the "+" shows while the task can be changed; people without the manage-checklist permission get an alert ([States](#states)). Apps: "Add Checklist".                                                   | Opens [Add a checklist](#add-a-checklist).                                                                                                                                                                                                                                                                                                                     | [`POST /v1/app/checklists/{scope}/jobs`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobs)                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Set as template                   | Site admins, on a task whose checklist is not from a template                                                                                                                                               | Opens the "New Checklist" dialog, which saves the checklist as a template in a folder ([Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md#create-a-template)), then puts that template on the task.                                                                                                              | [`POST /v1/app/checklists/{scope}/templates`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplates), then [`POST /v1/app/checklists/{scope}/jobs`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobs)                                                                                                                                                                                                                                                        |
| Remove from task                  | People who can manage checklists                                                                                                                                                                            | Asks first ([Remove checklist](#remove-checklist)). Takes the template off the task. A started checklist also loses its items and its name. "Signature required" is switched off when it was on. On a planned task it only takes the template off the planned task, which is saved with it.                                                                    | [`POST /v1/app/checklists/{scope}/jobs/delete`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobsdelete); started: [`POST /v1/app/todos/multi`](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1apptodosmulti) and [`PUT /v1/app/tasks/{uuid}/todo-name`](https://docs.snapfix.com/engineering-reference/api/tasks.md#put-v1apptasksuuidtodo-name); [`PUT /v1/app/tasks/{uuid}/signature`](https://docs.snapfix.com/engineering-reference/api/tasks.md#put-v1apptasksuuidsignature) |
| Scan a Smart Tag                  | People who can change the task, on a phone with NFC, on a plan with NFC                                                                                                                                     | iOS: the NFC button starts a scan; without NFC in the plan: "Not included in this business account". Android: a tag read while the screen is open. A tag that matches an item ticks it and adds a "scanned" chat line.                                                                                                                                         | Sync queue                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

## Rules

* **Mandatory items.** A mandatory item must be ticked before the checklist can be signed; items in a section marked NA don't count. An item whose note or photo is mandatory can't be ticked until the note or photo is there ([Inputs](#inputs)). The server checks the mandatory items again at sign-off.
* **Automatic status.** The web asks for amber after a tick when the task has no green time and its chat has no automatic amber line yet, and for green when the checklist reaches 100% and the task has no green time. The move happens only when the group's "Auto set Task to Yellow when Checklist started" or "Auto set Task to Green when Checklist completed" switch is on; iOS and Android use the same two switches. The status lines are in [Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#task-chat). After the view dialog closes, the web reports the ticked count where the green check expects the item count, so a task with nothing ticked can move to green despite "Checklist must be 100% before set to Green".
* **Percentage.** The ticked items divided by all items, leaving out sections marked NA and sections without items, rounded to a whole number. Each section has its own percentage the same way.
* **Smart Tag.** An item with a Smart Tag check is ticked by scanning its tag. A tick by hand is refused unless the group's "Allow manual NFC checks" is on: web disables the checkbox with the hint "Please enable NFC manual check from group settings"; iOS and Android say "You must scan the correct NFC tag to check this item".
* **Time windows.** An item can carry a start and end time, but no screen sets one: Android's "Enable timed check" is in a dialog that only unused schedule screens open, and iOS switches windows off when it saves an item. iOS and Android check an existing window for Smart Tag scans only; ticks by hand ignore it, and the web neither shows nor checks it \[[ASK-68](https://github.com/snapfix/docs/blob/main/ASK.md#ask-68-are-checklist-time-windows-still-a-feature)].
* **Signature.** A tick or untick on a signed checklist, including the automatic tick after an answer, note or photo, asks to reset the signature first ([Signature alerts](#signature-alerts)).
* **Locked tasks.** On iOS and Android, a locked, archived, inactive, future-dated or time-locked task keeps its checklist on screen, with the bottom bar and the signature disabled and ticks refused. On the web its checklist can't be opened.

## Summary

The summary counts the answers: pass, flag and fail, and yes and no, each with its share. A share is the count divided by all items of that type, including unanswered ones and leaving out items answered NA \[[ASK-69](https://github.com/snapfix/docs/blob/main/ASK.md#ask-69-should-the-pass-flag-fail-yes-and-no-shares-count-unanswered-items)]. Shares show two decimals, except 100. Sections marked NA are left out.

* Web: "Checklist Summary", with "Completed" and the ticked count and percentage, then a row of pass, flag and fail counts and a row of "Yes" and "No" counts. It shows once at least one of these answers is given.
* iOS: "Completed N (P%)" and the same counts, shown when the checklist has pass, flag, fail or yes and no items, before any answer.
* Android: the "Checklist Scores" footer, shown on the same rule as iOS.

See [Checklist scores](https://docs.snapfix.com/product/features/checklists/checklist-scores.md).

## States

* **Loading:** web: the view dialog shows a spinner until its sections are ready, and the card's "+" shows a spinner while a checklist is being added. iOS and Android read the checklist from the device at once; "Refreshing..." (iOS) or "Refreshing…" (Android) can show while the app reloads it.
* **Empty:** a task with no checklist shows the "Checklist" header with a "+" (web, "Checklist Template" on assets) or "Add Checklist" (apps). A section with no items shows "No checklist items found" on the web (not translated). On the apps the editor opens instead for people who can manage checklists.
* **Error:** web: a tick the server refuses is put back. A failed load shows nothing: a task without a template then looks like it has no checklist, and a task with a template shows its card at 0%. On the apps, a change that can't be sent stays on the device until the sync sends it.
* **No permission:** web: when the task can't be changed, or the person isn't in the group, ticks, answers, section switches and notes are disabled, and the note has no placeholder. Without the manage-checklist permission the card's "+" shows "You either don’t have permission to add a new checklist template or no folder is enabled. Please contact your site administrator for assistance." The apps hide "Edit Checklist". The no-permission view was not seen live, because only one test account exists \[[ASK-49](https://github.com/snapfix/docs/blob/main/ASK.md#ask-49-can-the-live-passes-use-a-second-qa-test-user-on-the-qa-site)].
* **Offline (mobile):** ticks, answers, notes, photos, the signature and "Clear All" are saved on the device and sent when the phone is online. The sync actions act on the user named in the rows.
* **Signed off:** the box shows "Checklist signed off" and the signature. A tick or untick asks to reset it first.
* **Planned task (web):** the checklist can be viewed and set up, but not ticked, answered or photographed, and has no summary or signature, because the planned task is not saved yet.
* **Housekeeping drawer (web):** read-only.

## Dialogs and sheets

### View checklist

Web `TaskChecklistDialogComponent`, opened by the card and by the menu's "View Checklist". Its layout is in [Layout](#layout). It can't be closed by clicking outside it. When it closes, the card takes over its percentages and items. On iOS and Android the checklist is a screen, not a dialog.

### Checklist menu

Web: the three-dot icon on the card.

* "View Checklist".
* "Edit", with the info text "Create, edit, and manage checklists efficiently. You can add, remove, duplicate and reorder sections and items." For people who can manage checklists, when the task is planned, the person is a site admin, or the checklist is not from a template.
* "Clear Checklist", once the checklist has been started ([Clear checklist](#clear-checklist)).
* "Set as template", with the info text "Convert this checklist into a template usable in any task". Site admins, on a task without a template.
* "Remove From Task" ("Remove from Asset" on assets), with the info text "Remove checklist from this task." ("Remove checklist from this asset."). People who can manage checklists ([Remove checklist](#remove-checklist)).

iOS (`CLTemplateOptionsVC`, a sheet): "View Checklist", "Edit Checklist" and "Remove from Task" (the last two for people who can manage checklists), and "Set as Template" for site admins on a task without a template. Each row has an info text: "Edit checklists: You can add, remove, duplicate and reorder sections and items.", "Setting as a template will save this checklist as a template in your Checklist library so it can be used again in tasks across the enabled groups." and "Remove Checklist from this task".

Android (`BottomSheetCheckListActionMenu`, a sheet): "View Checklist", "Edit Checklist", "Set as Template" and "Remove from Task". "Edit Checklist" and "Remove from Task" need the manage-checklist permission. "Set as Template" shows for account admins only, and not for template checklists or planned tasks.

### Add a checklist

Web `TaskAddChecklistDialogComponent`, titled "Add Checklist to Task". It lists the site's checklist templates by folder. The person picks one, or chooses "Create New Checklist":

* a site admin with at least one folder gets the "New Checklist" dialog ([Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md#create-a-template)); the new template is then put on the task;
* anyone else gets the editor for a checklist made for this task only ([Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md)). After that save the card may not show the new checklist until the page reloads, when the task had a checklist removed before.

"Save" stays disabled until a template is picked, and puts it on the task. From the task list's bulk actions the same dialog puts the template on every selected task. On a planned task it returns the choice without saving it.

iOS `AddChecklistTemplate`, titled "Add Checklist", with "Create New Checklist", "Pick a Checklist from your Site templates OR create a new one.", a "Search Checklists" field and a folder choice. Android `AddChecklistBottomSheet`, titled "Add Checklist", with "Pick a Checklist from your Site templates OR create a new one.", a folder choice, "Search Checklists" and "Create New Checklist".

### Add a photo or video

Web `TaskChecklistMediaDialogComponent`, titled "Add a photo" or "Add a video". Icon buttons pick the kind: text (the typed text becomes a photo) and sketch, plus photo and video when the group doesn't block gallery photos ("Block Photos from Gallery"). The photo area has "Drag and drop an image here", "OR" and "Choose an image" (seen live, 2026-11-13). "Save" is disabled until there is a picture or some text. It uploads the file (and a thumbnail for a video), attaches it to the item, and closes after 1.5 seconds. The code would then show the photo and tick the item, but the server's answer has no photo list, so neither happens until the checklist loads again.

On iOS and Android the camera opens from the item; the photo is saved on the device and sent later.

### Photo menu

Web: each photo has a menu with "Download", "Copy" (copies the photo's link: "URL copied to clipboard"), "Create Task" (people who may create tasks, not on assets) and "Delete" (anyone who can change the task). "Delete" asks "Delete media item", "Are you sure you want do delete the media item?" with "Delete".

iOS: a long press on a photo saves it to the gallery or shares it ("This video has been saved to your photo Gallery." for a video).

### Clear checklist

Web: "Clear Checklist", "Are you sure you want to clear all checklist items?", with "Clear Checklist" and "Cancel". iOS: "Reset Checklist" with the same question. Android: "Reset checklist" with the same question, "Yes" and "No".

### Signature alerts

* "Signature can't be added" with "This checklist has mandatory items that are not yet checked. Complete them before adding your signature." when "Submit" is pressed too early (all three platforms).
* "Signature will be reset" with "Adjusting a checklist after it has been signed off will clear the signature." (web and Android) before a tick or untick on a signed checklist; on Android also before a Smart Tag scan. OK goes on and resets the signature. Cancel keeps the signature and undoes the tick. The web asks once per task until a new signature is saved. The server's reset changes nothing yet, so the signature is still shown after a reload (seen live, 2026-11-13) \[[ASK-17](https://github.com/snapfix/docs/blob/main/ASK.md#ask-17-should-reset-signature-on-the-web-remove-the-signature)].

### Remove checklist

Web: "Remove Checklist", "Removing this checklist cannot be undone. Do you want to continue ?" and "Remove".

### When the dialog opens

On the web, the first time someone who can save opens a checklist that hasn't been started, the checklist name, the template's items and the "signature required" setting are saved to the task, together, before the view dialog opens. The checklist is then started, so later template changes no longer reach this task. This copy is by design. Later opens send nothing.

## Platform differences

| Topic                      | Web                                                            | iOS                                      | Android                     |
| -------------------------- | -------------------------------------------------------------- | ---------------------------------------- | --------------------------- |
| Container                  | Card on the task page, items in a dialog                       | Full screen                              | Full screen                 |
| Saving                     | Each change calls the API at once                              | On the device, synced later              | On the device, synced later |
| Template on first open     | Copied into the task when opened                               | Copied into the task on the first change | Not traced                  |
| Locked or archived task    | Can't be opened                                                | Read-only                                | Read-only                   |
| Photo limit                | The server refuses the tenth; the gallery opens the first nine | 9, checked on the device                 | 9, checked on the device    |
| Smart Tag                  | No scanning                                                    | NFC button                               | Scans while open            |
| Summary                    | Card, after the first answer                                   | Card, before any answer                  | "Checklist Scores" footer   |
| Create a task from an item | Only from a photo's menu                                       | Long press                               | Long press                  |
| Clear                      | "Clear Checklist" in the menu                                  | "Clear All"                              | "Clear All"                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/how-the-apps-work/screens/checklists/checklist.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
