@inspectorhub/field-ui 0.3.0 → 0.4.0

package/README.md

@@ -24,7 +24,7 @@ The root entry exports:
 
 | Group | Exports |
 |---|---|
-| The editor | `FieldEditor` (props: `{ data: EditorData }`) |
+| The editor | `FieldEditor` (props: `{ data: EditorData; readOnly?: boolean }`) |
 | Host contract | `FieldDataSourceProvider`, `useFieldDataSource`, `useFieldCommand`, `useFieldEnsureHuman`, `useFieldSlots`, `isIgnored`, `setFieldLocale`, `bindFieldLocaleSource`, and the TypeScript types of the contract (`FieldDataSource`, `FieldHostSlots`, `FieldUrls`, `FieldResources`, `EditorData`, `SessionInfo`, and so on) |
 | Finding keys | `findingKey`, `findingsForUnit`, `isMetaKey` (the same functions the server uses to address a result) |
 | Photo decoding | `DecodeImageError`, `isDecodeImageError` (matches by error name, so it works across two copies of the package), and the types `DecodeImage`, `DecodeImageOptions`, `DecodedImage` (see `media` below) |
@@ -46,6 +46,13 @@ setFieldLocale(session.locale); // and keep it in step with the host's own local
 </FieldDataSourceProvider>
 ```
 
+Pass `readOnly` to show an inspection for reading only. Nothing in a read-only editor can write: the results document is
+never handed to a write helper, every write on the data source (commands, uploads, the media store, the resource writes)
+is refused with "This inspection is read-only.", and the controls that write (rating row, notes input, add-photo tile,
+publish, sign, finish, structure and template editing, settings, units, cost items, batch and Speed mode) are not
+rendered. Navigation, the section and item lists, the rating as an indicator, notes as text, photos and their viewer, the
+preview and updates from other people keep working. Without `readOnly` nothing changes.
+
 What the host has to provide:
 
 - A `FieldDataSource` (next section). `editorData` is what its `load()` returns.

package/dist/index.d.ts

@@ -126,13 +126,10 @@ interface FieldCommandRunner {
  */
 declare function useFieldCommand(inspectionId: string): FieldCommandRunner;
 
-/**
- * The inspection editor page. It reads everything from its `data` prop, the field data source and the host
- * slots, so any host (web route, native shell) mounts it the same way. `data` must follow the host's
- * revalidation: units, publish state and the rest are read from it on every render.
- */
-declare function FieldEditor({ data }: {
+/** The inspection editor page. `readOnly` shows it for reading only: nothing in it can write, and the write controls are not offered. */
+declare function FieldEditor({ data, readOnly }: {
     data: EditorData;
+    readOnly?: boolean;
 }): React.JSX.Element;
 
 declare function findingKey(unitId: string | null | undefined, sectionId: string, itemId: string): string;