@grafana/runtime/dist/types/utils/useFavoriteDatasources.d.ts

Grafana Runtime Library

import { DataSourceInstanceSettings } from '@grafana/data';
export type FavoriteDatasources = {
    enabled: boolean;
    isLoading: boolean;
    favoriteDatasources: string[];
    initialFavoriteDataSources: string[];
    addFavoriteDatasource: (ds: DataSourceInstanceSettings) => void;
    removeFavoriteDatasource: (ds: DataSourceInstanceSettings) => void;
    isFavoriteDatasource: (dsUid: string) => boolean;
};
/**
 * A hook for managing favorite data sources using user storage.
 * This hook provides functionality to store and retrieve a list of favorite data source UIDs
 * using the backend user storage (with localStorage fallback).
 *
 * @returns An object containing:
 * - A boolean indicating if the feature is enabled
 * - An array of favorite data source UIDs
 * - An array of favorite data source UIDs that were initially loaded from storage
 * - A function to add a data source to favorites
 * - A function to remove a data source from favorites
 * - A function to check if a data source is favorited
 * @public
 */
export declare function useFavoriteDatasources(): FavoriteDatasources;