A SharePoint Framework (SPFx) web part that lets people confirm, with one click, that they've read a site page — process descriptions, policies, anything you use SharePoint pages for in a quality-management or governance context. Confirmations are tracked per page version in a backing SharePoint list, so re-publishing a page can require a fresh confirmation.
The ReadReceipts list — one row per page/version/assignee. This is what the web part reads from and writes back to.
On the page, before confirming:
On the page, after confirming:
- Something outside this web part (a Power Automate flow, a script, etc.) creates one
ReadReceiptslist item per page/version/assigned person whenever a page is published — withStatusset toOpen. - The web part, placed on that page, looks up the current viewer's item for the page's current major version and shows:
- Open — an explanatory line plus a "Mark as read" button.
- Done — a checkmark and the confirmation timestamp, formatted for the resolved language.
- Not required — shown when no matching item exists for this viewer/page/version, with a refresh action in case provisioning is still catching up.
- Error — a non-alarming inline message with a retry action, for both load and save failures.
- Clicking "Mark as read" updates that item's
StatustoDoneand stampsConfirmedDate.
The web part never creates or provisions receipt items itself — it only reads and updates existing ones.
- Localization (English, German, French, Spanish), resolved in priority order: the page's own translated-language folder (SharePoint's page-translation feature) → the web's configured language → the site collection's language → English fallback.
- Theme-aware — colors are computed from SPFx's live section theme (
ThemeProvider), so the web part reads correctly in light, dark, and strong section backgrounds. - List picker in the property pane (async dropdown over the site's lists) instead of typing a list name, stored by list ID so renaming the list doesn't break the configuration.
- Hide when not required — optional toggle to hide the web part entirely for readers when no open receipt is found for them.
- Demo mode — adds a "Reset" action on the confirmed state, to replay a confirmation during a walkthrough without touching the list directly.
- Debug mode — shows the configured list (with a link), the resolved item ID (with a link), and the raw language-resolution signals, for troubleshooting on-page.
- About page in the property pane — web part ID, instance ID, and version at a glance.
- Query pattern designed to stay within the SharePoint list view threshold on large lists (see Scaling, below).
Create a list named (by default) ReadReceipts with these columns:
| Display name | Internal name | Type | Notes |
|---|---|---|---|
| Page Id | PageId |
Number | Indexed — required for the web part's queries to scale (see below) |
| Page Title | PageTitle |
Single line text | Informational |
| Page Version | PageVersion |
Single line text | Major version string the receipt was created for, e.g. "3.0" |
| Assigned To | AssignedTo |
Person | Single value |
| Status | Status |
Choice | Open, Done |
| Confirmed Date | ConfirmedDate |
Date and Time | Set by the web part on confirmation |
Reads filter by PageId eq X and AssignedToId eq Y, with PageId leading. SharePoint's 5,000-item list view threshold doesn't apply to queries filtering on an indexed column, so as long as PageId is marked as indexed (List Settings → Indexed columns), each query is bounded by "how many receipt rows exist for one page" rather than the list's total size. Writes go directly by item ID and never scan the list. This hasn't been load-tested against an actual multi-thousand-item list — if you're provisioning at that scale, verify the index is in place and consider a compound index over PageId + AssignedTo.
Grab the latest packaged .sppkg from this repo's Releases page, or build it yourself:
npm install
npm run buildThis produces sharepoint/solution/read-receipts.sppkg (the build script also auto-bumps the solution version, so re-running it produces a new, distinguishable version each time).
Upload the .sppkg to your tenant or site App Catalog. The solution is set to skipFeatureDeployment: true, so once uploaded it's available on every site without per-site activation. Add the "Read Receipts for Pages" web part to a page and pick your ReadReceipts list in the web part settings.
npm run startNote that the local/hosted workbench doesn't populate pageContext.list/pageContext.listItem, so the web part will show nothing there by design — real testing needs an actual SharePoint page with the web part added to it.
- SharePoint Framework
- A Microsoft 365 tenant with a modern SharePoint site
- Node.js
>=22.14.0 <23.0.0 - A
ReadReceiptslist (or similarly-schemed list) already provisioned on the target site, per the schema above
Communardo Smart Work is responsible for this solution.


