caliper uidocs

Minimap

Pro

A long canvas with a small map of the whole of it: the frame follows as you scroll, and dragging it or clicking the map jumps there.

Installs components/ui/minimap.tsxDepends on none beyond ReactMotion none in component source
pnpm dlx shadcn@latest add @caliper/minimap

1. Definitions

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

2. Services

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

3. Fees

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

4. Payment terms

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

5. Data protection

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

6. Security

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

7. Support

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

8. Term

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

9. Termination

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

10. Liability

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

11. Confidentiality

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

12. Governing law

The supplier provides the services described in the order form, with the support levels in schedule 2. Fees are invoiced monthly in advance and are due within 30 days. Either party may end this agreement with 60 days written notice.

When to use #

Use it for

  • Long documents, code, diagrams and boards.
  • Anything people navigate by shape.

Skip it when

  • Short pages; a scroll bar is enough.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/minimap

Adds its 2 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 { Minimap } from "@/components/ui/minimap"

The worked example comes with Pro

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

Checking your licence…

API reference #

Minimap

component
PropTypeDefault
label *string—
heightnumber360
mapWidthnumber120
classNamestring—
children *ReactNode—

Accessibility #

It exposes region semantics, with aria-label and aria-hidden kept in step with state.

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.