--- title: "Widgets" generated: true --- **Status: Developer Preview** Defines a dashboard widget that can be added to the dashboard. ```ts title="Signature" type DashboardWidgetDefinition = { id: string; name: string; component: React.ComponentType; defaultSize: { w: number; h: number; x?: number; y?: number }; minSize?: { w: number; h: number }; maxSize?: { w: number; h: number }; requiresPermissions?: string[]; defaultConfig?: Record; allowMultipleInstances?: boolean; } ```

### id A unique identifier for the widget. ### name The display name of the widget. ### component DashboardBaseWidgetProps>`} /> The React component that renders the widget. ### defaultSize The default size and position of the widget. ### minSize The minimum size constraints for the widget. ### maxSize The maximum size constraints for the widget. ### requiresPermissions If set, the widget will only be displayed if the current user has at least one of the specified permissions in the active channel. If not set, the widget will be visible to all users. ### defaultConfig `} since="3.8.0" /> Default configuration values for the widget. The effective config seen by the widget is this object merged with any per-instance overrides that the user has persisted. Widgets read and write their config via the [useWidgetConfig](/reference/dashboard/hooks/use-widget-config#usewidgetconfig) hook. ### allowMultipleInstances If set to `true`, the widget can be added to the Insights page multiple times. Each instance keeps its own independent layout and [useWidgetConfig](/reference/dashboard/hooks/use-widget-config#usewidgetconfig) state, and the "Add widget" picker offers the widget even when an instance is already on the page. When `false` (the default), the widget can appear at most once and removing it simply hides it until re-added.