Skip to content
weftGitHub

TransportPicker

A sandbox for developers to test how live updates behave on a bad network.

SourcePackage @weft-js/warp

Preview

tsx
import { TransportPicker } from '@weft-js/warp'export function Sandbox() {  return (    <TransportPicker />  )}

Installation

npm install @weft-js/warp

Usage

tsx
import { TransportPicker } from '@weft-js/warp'<TransportPicker />

When to use

Use it for

  • Trying out a realtime setup while you build. It is never for end users.

Accessibility

  • This has no shortcuts of its own: controls inside it use Tab, Enter and Space as usual, and warp's parts keep their roles and labels.

API Reference

PropTypeDefaultDescription
lanesPartial<Record<LaneId, Status>>—Real statuses to show in place of the simulated ones.
busTransportBus'postgres'The server bus to start on.
wireTransportWire'default'The wire under test.
presetTransportPreset'multi'The deploy preset.
networkTransportNetwork'good'The simulated network.
titlestring'Realtime sandbox'The heading.
EventTypeDefaultDescription
onConfigChange((c: TransportConfig) => void)—The setup changed.

Parts

Every element carries a stable name, so you can style it from your own CSS: [data-scope="transport"] [data-part="head"]

headconfigchoicessweep-basesweeplabelmetahintrowmessagebuild-errortitledescriptionlaneslog

RelatedConnection pill