# Kit builder

A React block (a whole screen) in [Beamline](https://beamline.io/)'s [Inventory](https://beamline.io/components/apps/inventory) app. Live demo: https://beamline.io/components/kit-builder

A kit (bundle) made of standalone products, and how many its parts' stock can make. Sell as a kit; the parts in one kit with units per kit, removable, added by search (another kit refused: a kit can't hold a kit, nor itself); the packing slip shows the kit or each part, pick lists always the parts. Unsaved changes said; saving changes orders imported from then on while orders already in keep their parts and revision (recent orders listed with the revision they used). Beside it, following the draft: kits the parts can make on its tone, the part or parts that limit it named, or Unknown with the parts whose stock isn't known (never zero); stock as of when, said when stale; a kit has no stock of its own; per part, units per kit, on hand, allocated, available and the kits it allows, the limiting row marked.

## Use it for

- A product sold as a set of other products, whose availability comes from its parts' stock.
- Where an unknown count must stay unknown and the limiting part should be named.

## Not for

- A product's own stock levels (an inventory list).
- Building a purchase order ([purchase-orders](https://beamline.io/components/purchase-orders)).

## Anatomy

- header: the tool's mark, kit name and SKU, Sell as a kit
- parts: each part led by its units per kit as a figure that edits in place, remove on attention; Add a part opening the search; the refusal; packing slip (The kit · Each part, pick lists a hint); the save bar (what saving changes a hint)
- availability: the total (no stock of its own a hint), what limits it or why it's unknown, as of, the parts' stock table (on a phone: per kit, available, makes), recent orders

## States

- no parts, editing (unsaved), saved, save refused, a kit refused as a part
- kits available, none, unknown; stale stock; the limiting part
- phone: one column, the stock table scrolls sideways
- right to left: mirrored
- reduced motion: through the tokens

## Keyboard

- Tab through Sell as a kit, each part's units (arrows step) and remove, Add a part, the slip choice, Save

## Motion

Nothing runs at rest.

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `kit` (required) | `{ sku: string; name: string; }` | — |  |
| `definition` | `KitDefinition` | — | The saved definition (controlled). |
| `defaultDefinition` | `KitDefinition` | — |  |
| `onDefinitionChange` | `((definition: KitDefinition) => void)` | — |  |
| `defaultDraft` | `KitDefinition \| null` | — | A draft at first (a kit reopened mid-edit). |
| `products` (required) | `KitProduct[]` | — |  |
| `stock` (required) | `Record<string, PartStock \| null>` | — | Stock by SKU; a missing SKU is unknown. |
| `asOf` (required) | `string` | — | When the stock was read. |
| `staleAfter` | `number` | — | Older than this many minutes is said as stale. |
| `now` | `string` | — |  |
| `orders` | `KitOrder[]` | — |  |
| `onSave` (required) | `(draft: KitDefinition) => Promise<KitDefinition>` | — | Saves; resolve with the saved definition (its new revision), reject with why not. |
| `product` | `string` | — |  |
| `className` | `string` | — | Classes on the documented visual root; no override 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

- [Alert](https://beamline.io/components/alert.md)
- [Avatar](https://beamline.io/components/avatar.md)
- [Bottom sheet](https://beamline.io/components/bottom-sheet.md)
- [Button](https://beamline.io/components/button.md)
- [Combobox](https://beamline.io/components/combobox.md)
- [Inline edit](https://beamline.io/components/inline-edit.md)
- [Label](https://beamline.io/components/label.md)
- [Segmented control](https://beamline.io/components/segmented-control.md)
- [Select](https://beamline.io/components/select.md)
- [Spinner](https://beamline.io/components/spinner.md)
- [Switch](https://beamline.io/components/switch.md)
- [Text morph](https://beamline.io/components/text-morph.md)
- [Tooltip](https://beamline.io/components/tooltip.md)

## Dependencies

`lucide-react`

## Import

```tsx
import { KitBuilder } from "@beamline/kit-builder";
```

## Get it

Kit builder 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 Inventory

- [Stock count](https://beamline.io/components/stock-count): A shelf counted. Count: the products on it with counted units, not counted (an empty field that changes nothing) kept apart from a counted zero, expected…
- [Inventory counts](https://beamline.io/components/inventory-counts): Recurring stock counts from plan to shelf: a phone-first count of one occurrence where an untouched part reads not counted and a zero reads counted, none…
- [Goods receiving](https://beamline.io/components/goods-receiving): Goods received against purchase orders and invoices. Cards grouped by purchase order or invoice, each line once whichever way (a line keeps both sources…
- [Purchase order desk](https://beamline.io/components/purchase-order-desk): Purchase orders for stock from draft to closed. The list of orders with status (ready for review on warning, approved, ordered and partly received on…
- [Restock desk](https://beamline.io/components/restock-desk): Restocking from suppliers' own shops. Items low on stock (below the minimum on danger, at it on warning, unknown said) beside the chosen item with how…
- [Stock alerts](https://beamline.io/components/stock-alerts): Alerts on stock counts and expiry dates. Counts of alerts gone off (danger) and close (warning) in the header. A table: item and type, the rule in words…
- [Inventory finder](https://beamline.io/components/inventory-finder): Find stock and act on what's found. A rail of filters: name or SKU; folders with or without their subfolders (folders the person can't see said as not…
- [Item setup](https://beamline.io/components/item-setup): Setting items up for scanning and records. Barcodes: scanned codes waiting to be linked, each with its symbology, when and who; Look it up brings a…
- [Bulk item edit](https://beamline.io/components/bulk-item-edit): Many items corrected at once. Pick a folder, with its subfolders or not (fixed once anything is edited), up to a limit said. The items in a grid: name…
- [Serial allocation](https://beamline.io/components/serial-allocation): A receipt line's serial numbers. Serials generated from a first serial and how many (its digits counted up, padding kept; a first serial without digits…
- [Stock moves](https://beamline.io/components/stock-moves): Where stock went, and moving it. The ledger lists movements newest first: moves on info, stock added on success, stock taken out on warning; each with…
- [Scan station](https://beamline.io/components/scan-station): A warehouse scanner, phone-first. Home: one scan field that also takes typing (and says so when the scanner isn't connected), each code named as what it…
- [Pack station](https://beamline.io/components/pack-station): A packing bench. Scanner, scale and printer each said, on the warning tone when away. Find the shipment by scanning or typing its number (none found…
- [Shipment split](https://beamline.io/components/shipment-split): An order's lines split across shipments. A table of lines with what was ordered and a column per shipment (new ones marked); a line already shipped can't…
- [Route plan](https://beamline.io/components/route-plan): A day's delivery routes in the service's zone. The day at a glance: routes, routes without a driver (warning), stops running late (danger), stops done…
- [Job materials](https://beamline.io/components/job-materials): Materials sent out to jobs and pick lists. Jobs: the list (draft, active on info, completed on success) beside the chosen job with its site, dates (the…
- [Service tasks](https://beamline.io/components/service-tasks): A fleet shop's maintenance setup. Tasks: active and archived, searchable, main tasks and their subtasks told apart in words, archiving refused while…
- [Owner records](https://beamline.io/components/owner-records): Who a customer is and what they own, at the front desk. New customer: name, phone and email checked as typed against existing customers; each likely…
- [Sample storage](https://beamline.io/components/sample-storage): Where physical items are kept (rooms, freezers, shelves, racks, boxes) and acting on several at once. The storage tree is browsed apart from moving: Move…
- [Sample ledger](https://beamline.io/components/sample-ledger): Materials used in a record and the containers they came from, plus pooling. Subtracting a used amount writes a stock movement with its unit and the…

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).
