# Provenance lens

A React component in [Beamline](https://beamline.io/)'s [Data & tables](https://beamline.io/components/data) category. Live demo: https://beamline.io/components/provenance-lens

Hold Alt (or press Lens) over any number on the page and see what makes it: hairline threads draw from the number to the rows, cards and documents on screen that make it, the formula sits beside it in words, sources out of view gather as a counted stack at their panel's edge, unknown and locked sources say so, and a click goes one level deeper to the sources' own sources with how fresh each is, while a trail across the top reads the chain. Every number is also a button that lists its sources.

## Use it for

- A page of numbers people have to defend or don't trust: an owner's dashboard, a stock count, a team's cost, an audit view.
- The host already renders the rows and documents; it adds data-ref to them and a graph of what makes each number.

## Not for

- One total explained step by step with levers → [explainable-total](https://beamline.io/components/explainable-total).
- A record's history over time → a timeline or the replay bar.

## Anatomy

- region: the bar (the Lens button, the hint with the Alt key, or the trail while showing), the host's page, the lens's layer over it
- value (a button) inside the host's page: the number as the host writes it
- layer while showing: threads (hairlines from the number to each visible source, role marks + and − where they land), the formula chip beside the number (formula in words, mismatch, estimate, freshness, unknown and locked chips, the deeper hint), stacks at a panel's bottom edge for sources out of view, freshness tags on deeper sources
- list (Enter on a number): the number, the formula, each part with its amount, its sources on the page with Show, the count not on this page, unknown, no access, freshness

## States

- rest
- lens on (held or kept)
- showing a number (level 1)
- deeper (level 2 and on)
- unknown source
- no access
- stale source
- estimate
- mismatch
- list open

## Keyboard

- Tab reaches each number; Enter (or Alt+Enter) opens its list of sources; Escape closes it and returns to the number
- In the list, Show scrolls to that source on the page and marks it
- The Lens button keeps the lens on: Tab to a number to draw its threads, Enter on it to go one level deeper; Escape (outside a source list) turns the lens off; Alt does nothing while typing in a field
- Holding Alt while focus is in the region turns the lens on while held
- The formula and the chain are read out as a polite status; the threads are decoration

## Motion

Threads draw in from the number on the line stagger, chips and stacks fade in; everything happens only while the lens is on and nothing runs at rest. Reduced motion places them.

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `graph` (required) | `ProvenanceGraph` | — | Every number and source the lens can explain, by ref. |
| `children` (required) | `ReactNode` | — | The page or dashboard: values (`ProvenanceValue`) and sources (`data-ref`) anywhere inside. |
| `currency` | `string` | — | ISO code for the lens's own amounts (its list of parts); the page's numbers stay as the host wrote them. |
| `format` | `((amount: number) => string)` | — | The lens's own amounts in the host's format; it wins over `currency` and never touches the children. |
| `now` | `Date` | — | "Now" for freshness; default the time of drawing. |
| `active` | `boolean` | — | The lens kept on (the Lens button); Alt held turns it on while held. |
| `defaultActive` | `boolean` | — |  |
| `onActiveChange` | `((active: boolean) => void)` | — |  |
| `className` | `string` | — | Classes on the documented visual root; no override by default. |
| `classNames` | `Partial<Record<"root" \| "list" \| "value" \| "bar" \| "stack" \| "chip" \| "lensButton" \| "t…` | — | Classes for the named visual parts; no overrides by default. |
| `style` | `CSSProperties` | — | Inline styles on the documented visual root; no overrides by default. |
| `ref` | `Ref<HTMLDivElement>` | — | Receives the documented native target or imperative handle; omitted by default. |
| `ProvenanceValue.of` (required) | `string` | — | On ProvenanceValue: Its ref in the lens's graph (and its own `data-ref`, so other numbers can point at it). |
| `defaultTarget` | `string` | — | The number the lens opens on, by ref (with the lens on): its threads drawn at once, as if pointed at. |

## Built from

- [Bottom sheet](https://beamline.io/components/bottom-sheet.md)
- [Button](https://beamline.io/components/button.md)
- [Kbd](https://beamline.io/components/kbd.md)
- [Popover](https://beamline.io/components/popover.md)
- [Spinner](https://beamline.io/components/spinner.md)

## Dependencies

`lucide-react`

## Import

```tsx
import { ProvenanceLens, ProvenanceValue } from "@beamline/provenance-lens";
```

## Get it

Provenance lens is part of Beamline UI. Install the parts you need in your React app as compiled packages or editable source. [Get Beamline](https://beamline.io/checkout?pack=complete) · [Connect your agent](https://beamline.io/connect)

## More in Data & tables

- [Living table](https://beamline.io/components/living-table): A table that shows as much as fits on both axes: width decides which columns show (the rest ride in the name line, moving there rather than vanishing)…
- [Availability layers](https://beamline.io/components/availability-layers): A week of bookable start times whose closed times explain themselves: every availability rule (hours, time off, bookings, buffers, rooms, lead time…
- [Capacity terrain](https://beamline.io/components/capacity-terrain): A schedule that stands on a terrain of capacity: under each station's lane of jobs, every day's load rises to its capacity line and an overload is a…
- [Domino move](https://beamline.io/components/domino-move): A room board where one move shows its chain: drag a booking (or pick it and aim it with the keys) onto a taken room and the bookings it would push appear…
- [Match board](https://beamline.io/components/match-board): Month-end matching as one picture: bank lines and books entries side by side with threads between them — solid for matched, dashed with the host's reason…
- [Split anything](https://beamline.io/components/split-anything): One splitter for money, quantities and time: a bar of the whole shows every target's part and what is not split yet; items are dragged onto targets…
- [Approval route](https://beamline.io/components/approval-route): A policy you can read by trying it: an amount on a log scale with the thresholds as marks (the arrows stop just under, at and just over each), the…
- [Proposal twin](https://beamline.io/components/proposal-twin): A proposal edited beside the client's exact page, the two linked both ways: a field in focus lights its twin on the page, scrolls it into view and joins…
- [Quantity river](https://beamline.io/components/quantity-river): The life of one order line's quantity: at rest a bar of its real split ("5 delivered · 1 back in stock · 1 damaged · 5 cancelled"), unfolding into a…
- [Stock horizon](https://beamline.io/components/stock-horizon): Projected stock per item over the coming weeks: a strip of weeks with the safety line, weeks under safety in warn and short in danger, every dip said in…
- [Ageing queue](https://beamline.io/components/ageing-queue): Tickets that visibly age: each ticket's ring fills toward its own service target and steps from on time to late to very late, the words say when it is…
- [Import lens](https://beamline.io/components/import-lens): A messy import made fixable by kind: rows stream through the checks once with live counts; problems gather into groups that say what is wrong in words…
- [Duplicate guard](https://beamline.io/components/duplicate-guard): A new record that watches for the one that already exists: as you type, the likely duplicates slide in beside the form with the fields that match lit and…
- [Scan flow](https://beamline.io/components/scan-flow): A pick list that takes scans: each scan flies from the scan field into its row and fills that row's quantity ring, and the prompt moves to the next bin…
- [Pack planner](https://beamline.io/components/pack-planner): The packing bench: the order's items sit in box outlines drawn to scale, each box filling to its padding line, weighing against its limit and naming the…
- [Record time machine](https://beamline.io/components/record-time-machine): The record itself, rewound in place: a slim track of every change (a tick per change in its person's colour, hollow for automation, named moments as…
- [Tension timeline](https://beamline.io/components/tension-timeline): A plan where slack is something you see: every dependency is a string from one task's end to the next one's start, sagging with the days it has to spare…
- [Replay bar](https://beamline.io/components/replay-bar): Rewind for anything live: pause a stream, scrub back to the moment you missed (markers for the ones that matter), step one update at a time, replay at a…
- [Event calendar](https://beamline.io/components/event-calendar): A schedule of events by day, week or month: events that overlap sit side by side, drag one to another time or day or pull its bottom edge to change its…
- [Kanban board](https://beamline.io/components/kanban-board): Work as cards in columns by stage: drag a card (or lift it with Space and walk it with the arrows) to another column or place, the cards around it make…
- [Data grid](https://beamline.io/components/data-grid): Virtualised local or server-driven grid: stable row IDs, manual sort and filters, pages or infinite loading, retry without losing rows, inline editing…
- [Pivot table](https://beamline.io/components/pivot-table): Records summed up by the fields people choose: rows grouped by one or more fields that fold open level by level, columns split by another, one or more…
- [Query builder](https://beamline.io/components/query-builder): Conditions people build by hand to pick out records: each rule is a field, an operator that fits the field (contains, between, in the last N days, is any…
- [Sort order](https://beamline.io/components/sort-order): Several sort keys in order. Each key says its rank in words ("Sort by Plan, A to Z", "then by Size, largest first") with its order named for the field's…
- [Metric rules](https://beamline.io/components/metric-rules): Ordered rules that colour a dashboard number. Each rule has a name for what its colour means ("At risk", not just red) and a tone (good, watch, act…
- [Log viewer](https://beamline.io/components/log-viewer): Log lines as they stream: it follows the newest line until you scroll up, then counts what arrived and brings you back in one click; filter by level with…
- [JSON viewer](https://beamline.io/components/json-viewer): A JSON value as a tree you can read and walk: branches open and close (one level, or all at once), closed ones preview what they hold, every value reads…
- [JSON diff viewer](https://beamline.io/components/json-diff-viewer): Two versions of a JSON value compared as one tree: added keys marked +, removed ones struck through with −, changed values read old → new, unchanged keys…
- [Import mapping](https://beamline.io/components/import-mapping): Map the columns of a file to the fields of one record type, see what every value becomes, then run the import and get an outcome for each row…
- [Diff table](https://beamline.io/components/diff-table): Proposed edits to a table before they happen: new rows green, removals struck through, changed cells old → new; each change can be left out and Apply…
- [Filter toolbar](https://beamline.io/components/filter-toolbar): The filters on a list kept in view: chips that remove themselves, Add filter with fields and their values, Clear all, and room for search or view controls.
- [Table](https://beamline.io/components/table): A native HTML table for small datasets, composed with children or driven by records; shared server paging, sorting, filters, search, stable-ID selection…

Part of [Beamline UI: polished, editable React components and complete screens for custom applications](https://beamline.io/). [Build your own style from any look; tokens, fonts, radii, motion; not only colours](https://beamline.io/docs/customize).
