Skip to main content
WebGPUnot applicable

MarkdownPanel

from v9.3

MarkdownPanel renders a small built-in Markdown subset inside a panel.

Usage​

Use MarkdownPanel when panel content is mostly descriptive text or links.

import {MarkdownPanel, type MarkdownPanelProps} from '@deck.gl-community/panels';

Props​

type MarkdownPanelProps = PanelProps & {
  id?: string;
  title: string;
  markdown: string;
  disabled?: boolean;
  keepMounted?: boolean;
  className?: string;
  theme?: PanelTheme;
};

Remarks​

  • Converts Markdown source into built-in rendered panel content without pulling in an external parser.
  • Supports standard panel flags such as disabled, keepMounted, and theme overrides.
  • Works well for lightweight help, status text, and example descriptions.

PanelTheme is shared across panels; see Panel Themes for presets and custom definitions.