@seatlayer/react 0.112.0 → 0.113.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +75 -33
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -30,8 +30,9 @@ selects and **holds**, and your trusted server **books** the hold.
|
|
|
30
30
|
your styles own.
|
|
31
31
|
- `SeatPicker`: the complete buyer experience: map, legend, tray, pricing, and
|
|
32
32
|
the checkout hand-off.
|
|
33
|
-
- `SeasonPicker`:
|
|
34
|
-
|
|
33
|
+
- `SeasonPicker`: season tickets. The buyer picks a seat once and holds it on
|
|
34
|
+
every date of the season; returning holders can say they will renew. Same
|
|
35
|
+
typed lifecycle and imperative handle as the other components.
|
|
35
36
|
- `SeatManager`: the organizer control room, for dashboards that monitor and
|
|
36
37
|
block live inventory.
|
|
37
38
|
- `EmbeddedDesigner`: a hosted chart Designer inside your own application.
|
|
@@ -53,9 +54,24 @@ selects and **holds**, and your trusted server **books** the hold.
|
|
|
53
54
|
npm install @seatlayer/react
|
|
54
55
|
```
|
|
55
56
|
|
|
57
|
+
## Upgrading to 0.113.0
|
|
58
|
+
|
|
59
|
+
Nothing needs a code change, and no type changed. What a buyer sees:
|
|
60
|
+
|
|
61
|
+
- **A short server stall heals on its own.** A hold, release or resume that
|
|
62
|
+
gets no answer is sent again (at most three tries, seven seconds of waiting),
|
|
63
|
+
and the map's first load tries again for up to about 30 seconds while the
|
|
64
|
+
picker says it is taking longer. A real outage still ends on the same panel
|
|
65
|
+
and Try again button, only later.
|
|
66
|
+
- **"Check your connection and try again."** A hold or best-available that
|
|
67
|
+
still gets no answer says this and keeps the selection, where it used to say
|
|
68
|
+
the seats were taken.
|
|
69
|
+
- **One version of the SDK.** If your app also installs `@seatlayer/js`
|
|
70
|
+
itself, move it to 0.113.0 as well.
|
|
71
|
+
|
|
56
72
|
## Upgrading to 0.112.0
|
|
57
73
|
|
|
58
|
-
Nothing needs a code change.
|
|
74
|
+
Nothing needs a code change. Four things to know:
|
|
59
75
|
|
|
60
76
|
- **`SeatingChart` now honours `enable3D`, `enable3DCrowd` and
|
|
61
77
|
`touchNavigation3D`.** Before 0.112.0 it ignored them. If your page already
|
|
@@ -109,7 +125,7 @@ await chart.current?.releaseLabels(['A-12']); // keep the remainder hel
|
|
|
109
125
|
await chart.current?.release(); // release the current hold
|
|
110
126
|
```
|
|
111
127
|
|
|
112
|
-
###
|
|
128
|
+
### Season tickets: the same seat on every date
|
|
113
129
|
|
|
114
130
|
```tsx
|
|
115
131
|
const season = useRef<SeasonPickerHandle>(null);
|
|
@@ -480,23 +496,33 @@ throwing, so a ref used one frame early is safe.
|
|
|
480
496
|
|
|
481
497
|
## Frequently asked questions
|
|
482
498
|
|
|
499
|
+
### Which React seating chart component can I use?
|
|
500
|
+
|
|
501
|
+
`@seatlayer/react` gives you a complete seat picker (`SeatPicker`) or the map
|
|
502
|
+
alone (`SeatingChart`), with live availability, seat holds, best available,
|
|
503
|
+
season tickets and, on every plan, a 3D view from each seat for venues up to
|
|
504
|
+
60,000 seats. A 200,000-seat stadium chart is ready in 1.95 s on desktop, and
|
|
505
|
+
the same charts run in Vue, Angular, iOS, Android, Flutter and React Native.
|
|
506
|
+
You pay only for sold seats, and your own server and payment provider keep the
|
|
507
|
+
order and the money.
|
|
508
|
+
|
|
483
509
|
### How do I add a seat map to a React app?
|
|
484
510
|
|
|
485
|
-
Install `@seatlayer/react
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
511
|
+
Install `@seatlayer/react` and render `SeatPicker` for the whole buyer flow:
|
|
512
|
+
live availability, a priced tray, seat holds with a timer, best available, the
|
|
513
|
+
3D view from each seat on charts up to 60,000 seats, and the checkout hand-off.
|
|
514
|
+
For the map alone inside your own UI, render `SeatingChart` and read the
|
|
515
|
+
buyer's choice from `onSelectionChange`. Give the container a definite height
|
|
516
|
+
and pass your event key and publishable key; your server then books the hold.
|
|
491
517
|
|
|
492
518
|
### Is this a real React component or an iframe?
|
|
493
519
|
|
|
494
|
-
`SeatingChart`, `SeatPicker
|
|
495
|
-
render a plain `<div>`
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
520
|
+
`SeatingChart`, `SeatPicker` and `SeatManager` are real React components that
|
|
521
|
+
render into a plain `<div>` in your own tree, with no iframe. `EmbeddedDesigner`
|
|
522
|
+
is the one exception: the organizer Designer runs in an iframe served by
|
|
523
|
+
SeatLayer and opened with a short-lived session URL from your backend, so your
|
|
524
|
+
secret key never reaches the browser. If you want an iframe for the buyer
|
|
525
|
+
picker, `attachPickerFrame` is exported for that.
|
|
500
526
|
|
|
501
527
|
### What is the difference between `SeatPicker` and `SeatingChart`?
|
|
502
528
|
|
|
@@ -508,30 +534,28 @@ and drop to `SeatingChart` when your design system owns the chrome.
|
|
|
508
534
|
|
|
509
535
|
### How do temporary seat holds work?
|
|
510
536
|
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
537
|
+
In the SeatLayer picker, a buyer's seats are held when they go to checkout;
|
|
538
|
+
with the bare chart, your code calls `hold()`, which reserves that inventory
|
|
539
|
+
against concurrent buyers for a limited checkout window and returns an opaque
|
|
540
|
+
`holdId`. The hold lapses on its own if checkout never completes. `onHoldExpired` tells
|
|
514
541
|
the app to return the buyer to the map, and `resumeHold()` restores it after a
|
|
515
542
|
same-tab checkout navigation or a reload. This is what prevents double-selling
|
|
516
543
|
without locking seats forever.
|
|
517
544
|
|
|
518
545
|
### Can I use my own payment provider?
|
|
519
546
|
|
|
520
|
-
Yes.
|
|
521
|
-
and a
|
|
522
|
-
charges through
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
The opt-in `checkout: 'hosted'` mode exists for hosts with no backend at all;
|
|
526
|
-
without it, no payment code is downloaded.
|
|
547
|
+
Yes. By default nothing in this package takes a payment: the browser hands you
|
|
548
|
+
a `holdId` and a `CheckoutHandoff` with the priced line items, and your backend
|
|
549
|
+
charges through the provider you already use, then books the hold. For a host
|
|
550
|
+
with no backend, the opt-in `checkout: 'hosted'` mode sends the buyer through
|
|
551
|
+
SeatLayer's checkout instead; without it, no payment code is downloaded.
|
|
527
552
|
|
|
528
553
|
### Can I evaluate it without a SeatLayer account?
|
|
529
554
|
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
that, which books no real inventory.
|
|
555
|
+
Yes. The live Grand Theatre demo runs in your browser with no account. To show
|
|
556
|
+
your own venue you need an event key, and test mode is free with no time limit
|
|
557
|
+
and no card: test events, holds and webhooks work like production and use no
|
|
558
|
+
credits.
|
|
535
559
|
|
|
536
560
|
### Does it work with Next.js and other React frameworks?
|
|
537
561
|
|
|
@@ -540,19 +564,37 @@ there, so a server render emits the empty container. This package ships no
|
|
|
540
564
|
`'use client'` banner of its own, so in the App Router mark your own component
|
|
541
565
|
that imports it, or load it through `next/dynamic` with `ssr: false`.
|
|
542
566
|
|
|
567
|
+
### How much does the SeatLayer SDK cost?
|
|
568
|
+
|
|
569
|
+
Building and testing is free, and going live costs $0. You pay one credit per
|
|
570
|
+
sold seat: the first 100 sold seats each month are free, then 10¢ down to 5¢ a
|
|
571
|
+
seat, with no subscription, and credits you buy never expire. Browsing the map,
|
|
572
|
+
holds and the 3D view never use a credit.
|
|
573
|
+
|
|
574
|
+
### Can I sell season tickets with it?
|
|
575
|
+
|
|
576
|
+
Yes. `SeasonPicker` holds the same seat on every date of a season in one step,
|
|
577
|
+
with best available across every date and a price type such as adult or child
|
|
578
|
+
for each seat, and returning holders can tell you they will renew. The hand-off
|
|
579
|
+
carries no price; by default your server applies the package price and books
|
|
580
|
+
it, and the opt-in `checkout: 'hosted'` takes the payment through SeatLayer's
|
|
581
|
+
checkout instead, into the organizer's own payment account. `SeasonPicker` is in `@seatlayer/react` 0.72.0 and newer.
|
|
582
|
+
|
|
543
583
|
## Continue your React integration
|
|
544
584
|
|
|
545
585
|
- [Follow the buyer SDK installation guide](https://docs.seatlayer.io/buyer-sdk/install/)
|
|
546
586
|
for the full browser integration, options, and events.
|
|
547
587
|
- [Build a React or Next.js seating chart](https://docs.seatlayer.io/buyer-sdk/react-seating-chart/)
|
|
548
588
|
with the framework-specific tutorial and client-mounting guidance.
|
|
589
|
+
- [Read the seat picker documentation](https://docs.seatlayer.io/buyer-sdk/seat-picker/)
|
|
590
|
+
for props, events, holds, and checkout in depth.
|
|
549
591
|
- [Connect seat holds to secure server-side checkout](https://docs.seatlayer.io/buyer-sdk/holds-and-checkout/)
|
|
550
592
|
without putting booking credentials in the browser.
|
|
551
593
|
- [Run the complete checkout example](https://docs.seatlayer.io/examples/complete-checkout/)
|
|
552
594
|
to connect a buyer hold id to payment and idempotent booking.
|
|
553
595
|
- [Compare SeatLayer's mobile seat map SDKs](https://docs.seatlayer.io/buyer-sdk/mobile/)
|
|
554
|
-
when the same event also has to
|
|
555
|
-
|
|
596
|
+
when the same event also has to appear in your iOS, Android, Flutter or React
|
|
597
|
+
Native app.
|
|
556
598
|
- [Read the embedded Designer guide](https://docs.seatlayer.io/platform/embedded-designer/)
|
|
557
599
|
to let organizers draw their own venues inside your product.
|
|
558
600
|
- [Explore the 3D seating chart](https://seatlayer.io/3d-seat-map/) for the
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seatlayer/react",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.113.0",
|
|
4
4
|
"description": "SeatLayer's official React seating chart and seat map SDK: live availability, seat selection, temporary holds, and a typed TypeScript API for ticketing apps.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
@@ -73,8 +73,8 @@
|
|
|
73
73
|
"typescript"
|
|
74
74
|
],
|
|
75
75
|
"dependencies": {
|
|
76
|
-
"@seatlayer/core": "0.
|
|
77
|
-
"@seatlayer/js": "0.
|
|
76
|
+
"@seatlayer/core": "0.113.0",
|
|
77
|
+
"@seatlayer/js": "0.113.0"
|
|
78
78
|
},
|
|
79
79
|
"peerDependencies": {
|
|
80
80
|
"react": ">=17.0.0"
|