# Duplicate guard

A React component in [Beamline](https://beamline.io/)'s [Data & tables](https://beamline.io/components/data) category. Live demo: 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 said in words (Number plate · same, Name · similar), strongest first. Use the existing record, merge what you typed into it (both fold into one column, agreements read once, every difference a choice with the existing value first, nothing lost) or say Not them; Create stays offered and becomes the main action when nothing matches.

## Use it for

- Creating a customer, contact, patient, member or vehicle where the same one may already exist under another spelling: garages, clinics, help desks, CRMs, school offices.
- The host passes the records to look in (or the ones its own search found) and owns what Use, Merge and Create do; the part compares, explains and builds the merged values.

## Not for

- Mapping columns of an imported file to fields → [import-mapping](https://beamline.io/components/import-mapping); fixing an imported file's rows → [import-lens](https://beamline.io/components/import-lens).
- Searching a list to pick one item → combobox or command-palette.

## Anatomy

- form: the label, one field per GuardField; a field that matches a shown card carries a lit mark; Create {name} (Create new while no name)
- matches: Possible matches; up to three cards, strongest first; a card: the record's name and detail, its reasons as chips (same filled, similar outlined), Use / Merge / Not them; and N more possible
- merge (inside its card): What {name} will have, one row per field: Same in both, kept, from what you typed, or a choice of two (the existing value first); Merge into {name} / Cancel
- done: Merged into / Created / Using {name}

## States

- empty
- typing (matches arrive)
- a match (same)
- a match (similar)
- more than three
- merging
- a card put aside
- no matches
- merged
- created
- used

## Keyboard

- The fields are ordinary inputs; each card is a region named by its record and Tab reaches Use, Merge and Not them
- In the merge, each difference is a radio group of two; Escape closes the merge and returns to the card's Merge
- Not them moves focus to the next card's first action, or to Create; arriving matches are said once (a polite status)

## Motion

A card slides in where it belongs, moves when it rises past another, and leaves as a ghost; the merge rows grow out of the reason chips they came from (the shared FLIP). A field's lit mark grows in. Nothing runs at rest; reduced motion places everything.

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `label` (required) | `string` | — | What is being created: "New customer". |
| `fields` (required) | `GuardField[]` | — |  |
| `records` (required) | `GuardRecord[]` | — | The records to look in (the host may pass the ones its own search found). |
| `value` | `Record<string, string>` | — | The draft, by field id. |
| `defaultValue` | `Record<string, string>` | — | Initial selection when uncontrolled; omitted by default. |
| `onValueChange` | `((draft: Record<string, string>) => void)` | — | Reports the selected value after a change; no callback by default. |
| `onUse` | `((record: GuardRecord) => void)` | — | Use an existing record instead of creating one (the host keeps the draft for it if it likes). |
| `onMerge` | `((record: GuardRecord, merged: Record<string, string>) => void \| Promise<unknown>)` | — | Merge what was typed into a record: the combined values, every difference chosen. |
| `onCreate` | `((draft: Record<string, string>) => void \| Promise<unknown>)` | — | Create the new record (always offered). |
| `match` | `((draft: Record<string, string>, record: GuardRecord) => GuardReason[])` | — | Replace the built-in comparison: the reasons a record matches the draft (none: not a match). |
| `limit` | `number` | — | How many cards at most; the rest are counted. Default 3. |
| `className` | `string` | — | Classes on the documented visual root; no override by default. |
| `classNames` | `Partial<Record<"root" \| "form" \| "card" \| "matches" \| "merge", string>>` | — | 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. |

## Built from

- [Avatar](https://beamline.io/components/avatar.md)
- [Button](https://beamline.io/components/button.md)
- [Input](https://beamline.io/components/input.md)
- [Label](https://beamline.io/components/label.md)
- [Spinner](https://beamline.io/components/spinner.md)

## Dependencies

`lucide-react`

## Import

```tsx
import { DuplicateGuard } from "@beamline/duplicate-guard";
```

## Get it

Duplicate guard 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…
- [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…
- [Provenance lens](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…
- [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).
