SettingsPanel

SettingsPanel embeds the settings-schema UI inside the panel composition model.

Usage

Use SettingsPanel when a settings form should live inside a panel layout or panel container.

import {
  SettingsPanel,
  type SettingsPanelProps,
  type SettingDescriptor,
  type SettingsSchema,
  type SettingsState
} from '@deck.gl-community/panels';

Props

type SettingsPanelProps = {
  id?: string;
  label?: string;
  schema?: SettingsSchema;
  settings?: SettingsState;
  onSettingsChange?: (
    settings: SettingsState,
    changedSettings?: Array<{
      name: string;
      previousValue: unknown;
      nextValue: unknown;
      descriptor?: SettingDescriptor;
    }>
  ) => void;
  theme?: 'inherit' | 'light' | 'dark' | 'invert';
};

See Also

• Using Panels

Remarks

• Reuses the shared schema-driven controls as a panel.
• Tracks section collapse state while the panel stays mounted.
• Supports nested dot-path setting names and change descriptors in onSettingsChange.