Skip to main content

CustomPanel

from v9.3

CustomPanel hosts imperative DOM content inside the panel composition model.

Usage​

Use CustomPanel when panel content must be rendered imperatively instead of as a static JSX subtree.

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

Props​

type CustomPanelProps = {
  id: string;
  title: string;
  onRenderHTML: (rootElement: HTMLElement) => void | (() => void);
  disabled?: boolean;
  keepMounted?: boolean;
  className?: string;
  theme?: 'inherit' | 'light' | 'dark' | 'invert';
};

Remarks​

  • Mounts a managed host element and calls onRenderHTML after that host is available.
  • Accepts an optional cleanup callback so callers can tear down manual DOM work.
  • Supports disabled and keepMounted like other panels.