Skip to main content

PanelSidebar

from v9.3

PanelSidebar renders panel content in a slide-over sidebar attached to the left or right edge.

Use it when controls or reference content should stay reachable while the user continues interacting with the surrounding standalone UI.

Usage​

import {
  ColumnPanel,
  MarkdownPanel,
  PanelManager,
  PanelSidebar,
  type PanelSidebarProps
} from '@deck.gl-community/panels';

const inspectorPanel = new ColumnPanel({
  id: 'inspector',
  title: 'Inspector',
  panels: [
    new MarkdownPanel({
      id: 'details',
      title: 'Details',
      markdown: 'Persistent standalone controls and context.'
    })
  ]
});

const panelSidebar = new PanelSidebar({
  id: 'inspector-sidebar',
  panel: inspectorPanel,
  side: 'right',
  title: 'Inspector'
});

const panelManager = new PanelManager({
  parentElement: document.getElementById('app') as HTMLElement
});

panelManager.setProps({
  components: [panelSidebar]
});

Props​

type PanelSidebarProps = PanelContainerProps & {
  panel?: Panel;
  side?: 'left' | 'right';
  widthPx?: number;
  placement?: PanelPlacement;
  title?: string;
  defaultOpen?: boolean;
  open?: boolean;
  onOpenChange?: (open: boolean) => void;
  triggerLabel?: string;
  triggerIcon?: string;
  showTitleBar?: boolean;
  hideTrigger?: boolean;
  button?: boolean;
  openShortcuts?: KeyboardShortcut[];
  shortcuts?: KeyboardShortcut[];
  viewportMarginPx?: number;
  dockTriggerWhenOpen?: boolean;
  showBackdrop?: boolean;
};

Remarks​

  • Accepts one reusable panel definition.
  • Slides open from the selected edge while keeping the shell mounted for smooth transitions.
  • Supports controlled and uncontrolled open state.
  • Supports Escape close, optional backdrop close, and focus restoration to deck.canvas after close.
  • openShortcuts and shortcuts are registered through structural deck.eventManager access when available.
  • viewportMarginPx controls the docked panel margin, and dockTriggerWhenOpen keeps the trigger aligned beside the open panel.
  • Use SidebarPanelWidget from @deck.gl-community/widgets when the same UI should be mounted through deck.gl.