Skip to contentWolf-Rayet

Panel

A panel is a container that displays contextual content alongside the main page.

Install

One package and one stylesheet. The stylesheet carries the tokens every component reads.

pnpm add @wolf-rayet/react
import '@wolf-rayet/react/css/wolf-rayet.css';
import { Panel } from '@wolf-rayet/react';

Props

A required prop is marked with an asterisk.

PropTypeDefaultDescription
titlestring—Names what the panel holds. Leave it out only when the content names itself.
children *ReactNode—The contextual content.

Accessibility

What the component does for you, and what it needs from you.

  • The title is a real heading, so the panel can be reached by heading navigation.
  • A panel sits in the reading order after the main content it supports, which is usually the right place for it.