import { type JumpToDashboardConfigForPivot as JumpToDashboardConfigForPivotPreact, type JumpToDashboardConfig as JumpToDashboardConfigPreact, type WidgetProps } from '@sisense/sdk-ui-preact'; import { type Ref } from 'vue'; import type { DashboardConfig } from '../components/dashboard'; import type { MaybeRef, MaybeRefOrWithRefs } from '../types'; /** * Configuration for Jump To Dashboard functionality. * Allows users to navigate from a widget to another dashboard with contextual filtering. */ export interface JumpToDashboardConfig extends Omit { /** * {@inheritDoc @sisense/sdk-ui!JumpToDashboardConfig.targetDashboardConfig} * * @default {} */ targetDashboardConfig?: DashboardConfig; } /** * Configuration for Jump To Dashboard functionality for pivot widgets. * Used for pivot widgets, allowing to configure jumping to different dashboard from different dimensions * * @see {@link JumpToDashboardConfig} */ export interface JumpToDashboardConfigForPivot extends Omit { /** * {@inheritDoc @sisense/sdk-ui!JumpToDashboardConfig.targetDashboardConfig} * * @default {} */ targetDashboardConfig?: DashboardConfig; } /** * Composable to add Jump To Dashboard (JTD) functionality to individual Widget components. * * Jump To Dashboard (JTD) allows users to navigate from one dashboard to another when interacting with widgets, * such as clicking on chart data points or using context menus. This composable is particularly useful when rendering * Widget components directly (not through a Dashboard component), but you still want JTD navigation functionality. * * For widgets that are part of a dashboard, consider using `applyJtdConfig` or `applyJtdConfigs` instead, * as they apply JTD configuration at the dashboard level rather than individual widget level. * * Note: dashboard-only 'includeDashboardFilters' is not supported and would just be ignored, since we do not have a dashboard in the current context. * * @example * Basic JTD configuration with right-click navigation. * ```vue * * * * ``` * * @example * JTD configuration with multiple targets and custom styling. * ```vue * * * * ``` * * @param widgetProps - Widget properties to enhance with JTD functionality (can be a ref or plain object) * @param config - Jump To Dashboard configuration * @returns Computed ref containing enhanced widget props with JTD navigation capabilities * @group Dashboards */ export declare const useJtdWidget: (widgetProps: MaybeRef, config: MaybeRefOrWithRefs) => Ref;