caliper uidocs
DemoSign inGet Pro

Knowledge base

Pro

A searchable set of articles with categories and an article view.

Installs components/ui/knowledge-base.tsxDepends on @radix-ui/react-slot, lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/knowledge-base

Reset your password

Updated Oct 8, 2025

You can reset your password from the sign-in page.

  1. Choose “Forgot password?”.
  2. Enter the email you signed up with.
  3. Open the link we send you. It works for 30 minutes.

If the email does not arrive, check spam, then ask for another one.

passwordsign in

Was this helpful?

Related

When to use #

Use it for

  • A help centre or internal wiki.
  • Search must work across titles and text.

Skip it when

  • Content is a single article.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/knowledge-base

Adds its 4 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 { KnowledgeBase } from "@/components/ui/knowledge-base"

The worked example comes with Pro

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

Checking your licence…

API reference #

KnowledgeBase

component
PropTypeDefault
articles *readonly KbArticle[]—
onFeedback((articleId: string, helpful: boolean, note?: string | undefined) => void)—
classNamestring—

Accessibility #

It exposes status semantics, with aria-label, aria-hidden, aria-current and aria-pressed 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.