caliper uidocs

Vector search diagram

Pro

A diagram of text becoming embeddings and matching nearest neighbours.

Installs components/ui/vector-search-diagram.tsxDepends on @radix-ui/react-slot, lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/vector-search-diagram
1234
  • Billing
  • Account
  • Developers
  • Accessibility
  1. 1Refund policy0.94
  2. 2Cancel a subscription0.91
  3. 3Invoice and receipts0.88
  4. 4Update payment method0.83

When to use #

Use it for

  • Explaining semantic search to a general audience.

Skip it when

  • You need to show real search results.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/vector-search-diagram

Adds its 3 files to components/ui/, each with its own stylesheet, and installs their packages. Pro installs with your access token, set up once per project. See Pro access. The first part also adds Caliper UI’s tokens; import them once as in Installation.

Usage #

Import it from your copy of the source. The example behind the preview comes with the source.

example.tsx
import { VectorSearchDiagram } from "@/components/ui/vector-search-diagram"

The worked example comes with Pro

The 37-line example behind the preview opens here with a Pro or Team licence.

Checking your licence…

API reference #

VectorSearchDiagram

component
PropTypeDefaultDescription
points *readonly VectorPoint[]—
groupsreadonly string[][]Names for the colour groups.
presetsreadonly { label: string; x: number; y: number; }[][]
defaultQuery{ x: number; y: number; }{ x: 50, y: 50 }
defaultKnumber4
classNamestring—

Accessibility #

It exposes group semantics, with aria-label, aria-valuetext, aria-hidden and aria-live kept in step with state. Changes that matter are announced through a live region.

No custom key handling; Tab and the native activation keys do the work.

Motion #

It declares no animation in its component source. Any transition comes from its stylesheet, which uses the duration tokens that collapse to instant under prefers-reduced-motion.