✅ You are viewing documentation for the latest version of Compose SDK.

Version:

# Function useCustomWidgets

useCustomWidgets(): UseCustomWidgetsResult

Hook that provides API for configuring custom widgets.

# Returns

UseCustomWidgetsResult

# Example

Example of registering a custom widget in a dashboard:

import { useCustomWidgets, DashboardById } from '@sisense/sdk-ui';
import CustomHistogramWidget from './custom-histogram-widget';

const Example = () => {
  const { registerCustomWidget } = useCustomWidgets();
  registerCustomWidget('histogramwidget', CustomHistogramWidget);

  return <DashboardById dashboardOid="your-dashboard-oid" />;
}