Skip to main content

Dashboard SDK

@carverauto/serviceradar-dashboard-sdk is the customer-facing surface for building browser-module dashboards that ServiceRadar imports, verifies, and renders. Dashboards ship from a customer repository as a signed renderer.js artifact plus a manifest; ServiceRadar handles the host shell, SRQL execution, frame transport, theme, navigation, and Mapbox/deck.gl injection.

Canonical reference​

The canonical Dashboard SDK reference — including the React hook surface (useDashboardQueryState, useFrameRows, useFilterState, useIndexedRows, useMapboxMap, useDeckMap, useDeckLayers, useMapPopup), composed map patterns, the Arrow IPC and SRQL primitives, the WASM render-model path, and the local harness — lives on the ServiceRadar developer portal:

Dashboard SDK on developer.serviceradar.cloud

The developer portal is the source of truth for SDK documentation. This page exists so that operators reading the main ServiceRadar docs can discover where dashboards are authored. SDK usage examples, hook signatures, and pattern guidance update on the developer portal as the SDK evolves; the main docs focus on operating ServiceRadar deployments rather than building plugins against them.

  • WiFi Map (local Compose) — running the reference customer dashboard against a local stack.
  • SRQL Reference — the query language that dashboards use to drive their data frames.
  • Wasm Plugins — the WASM extension surface used by dashboard render-model packages.

Repositories​