API REFERENCE · GENERATED FROM THE TYPES · FREE · MIT
Every component, hook, function and type the seven @openseat/* packages export, read straight from their TypeScript declarations and JSDoc, so this page cannot drift from the code. Plus the REST contract your backend implements.
1,200 exports in 8 entry points · press / or Ctrl K to search
npm i @openseat/react @openseat/core @openseat/adapter-rest konva react react-domInstall commands show the public npm names. The first npm release is pending; the packages are free and MIT licensed.
ROW A · MOST USED
The handful of exports most integrations touch: the two maps, the designer, the data hooks, the REST adapter and the layout generators.
useCanvasInteractions; this component composes the chrome around it.@openseat/editorlayout (start anchor at its first seat, aisle gaps, seat rotation "row", labeling from the numbering).@openseat/coreseatSpacing is given. Each row gets a parametric layout whose signed radius reproduces the generated seats.@openseat/coreARENA_PRESET_TITLES title.@openseat/corepadding. Hidden objects are skipped, and so is everything inside a hidden row, table or section and the contents of zone sections (showSeats: false), which draw as one zone; sections with outline "none" draw only their title, as in view mode.@openseat/renderer-konvaROW B · HOW THEY FIT
A layout is one JSON document from @openseat/core. The engines read it, the React bindings draw it, and the editor writes it. Nothing in the SDK talks to a server except through the adapter you pass in.
T4App
T3Bindings
T2Engines
T1Foundation
react and core; the designer adds editor.ROW C · PACKAGES
Each page lists every public export with its signature, props or parameters, defaults and examples.
React bindings for OpenSeat: SeatMap, BookingMap and hooks.
Start with BookingMap, SeatMap, useInventory
npm i @openseat/react @openseat/core konva react react-domFramework-independent layout schema, validation, geometry and generators for OpenSeat.
Start with validateLayout, generateStraightRows, generateCurvedRows
npm i @openseat/coreVenue templates: contracts, vocabulary, manifest and taxonomy, registry, search, params, capacity fitting, the TemplateKit, build/summary, placement, schematics, shared builders and the ten venue groups.
Start with buildTemplate, searchTemplates, listVenues
Ships inside @openseat/core: import … from "@openseat/core/templates"
Visual layout designer for OpenSeat: tools, inspector, layers, undo/redo, import/export and save with conflict handling.
Start with LayoutEditor, useEditor, createEditorStore
npm i @openseat/editor @openseat/core konva react react-domSeat status, selection rules, hold lifecycle and adapter contracts for OpenSeat. No payment processing; inventory truth stays on your backend.
Start with BookingAdapter, createHoldController, validateSelection
npm i @openseat/bookingOptional REST adapter connecting OpenSeat to your own inventory, hold and layout endpoints.
Start with createRestAdapter, RestAdapterConfig, RestPaths
npm i @openseat/adapter-restKonva canvas renderer for OpenSeat layouts: drawing, hit testing, pan/zoom, selection and transforms.
Start with layoutToSvg, SeatMapRenderer, SeatMapViewRenderer
npm i @openseat/renderer-konva konvaDefault design tokens and seat state styles for OpenSeat.
Start with createTheme, defaultTheme, resolveSeatStyle
npm i @openseat/theme-default