sisense.com
✅ You are viewing documentation for the latest version of Compose SDK.
Version:

Interface DesignPanelProps Beta<StyleOptions>

Defines props passed to a custom design panel component.

Example

import { DesignPanel, DesignPanelProps } from '@sisense/sdk-ui';

interface MyStyleOptions extends CustomVisualizationStyleOptions {
  color?: string;
}

const MyDesignPanel: DesignPanel<MyStyleOptions> = ({ styleOptions, onChange }) => (
  <input
    type="color"
    value={styleOptions.color ?? '#000000'}
    onChange={(e) => onChange({ ...styleOptions, color: e.target.value })}
  />
);

Type parameters

ParameterDefaultDescription
StyleOptionsCustomVisualizationStyleOptionsThe shape of style options managed by this design panel, extending CustomVisualizationStyleOptions.

Properties

onChange

onChange: (styleOptions) => void

Callback invoked when the user changes a style option.

Parameters

ParameterType
styleOptionsStyleOptions

Returns

void


styleOptions

styleOptions: StyleOptions

Current style options managed by the design panel.

Last Updated: