Skip to main content

Function: useSiteDetailsUiStore()

function useSiteDetailsUiStore(): {
    activeSiteDetailsTab: SiteDetailsTab;
    closeSiteDetailsForSite: (siteIdentifier: string) => void;
    setActiveSiteDetailsTab: (tab: SiteDetailsTab) => void;
    setShowAdvancedMetrics: (show: boolean) => void;
    setSiteDetailsChartTimeRange: (range: ChartTimeRange) => void;
    showAdvancedMetrics: boolean;
    siteDetailsChartTimeRange: ChartTimeRange;
    syncActiveSiteDetailsTab: (siteIdentifier: string) => void;
};

Defined in: src/hooks/site/useSiteDetails.uiStore.ts:52

Reads the UI store slice used by src/hooks/site/useSiteDetails!useSiteDetails.

Returns​

{
  activeSiteDetailsTab: SiteDetailsTab;
  closeSiteDetailsForSite: (siteIdentifier: string) => void;
  setActiveSiteDetailsTab: (tab: SiteDetailsTab) => void;
  setShowAdvancedMetrics: (show: boolean) => void;
  setSiteDetailsChartTimeRange: (range: ChartTimeRange) => void;
  showAdvancedMetrics: boolean;
  siteDetailsChartTimeRange: ChartTimeRange;
  syncActiveSiteDetailsTab: (siteIdentifier: string) => void;
}

activeSiteDetailsTab​

readonly activeSiteDetailsTab: SiteDetailsTab;

closeSiteDetailsForSite​

readonly closeSiteDetailsForSite: (siteIdentifier: string) => void;

Parameters​

siteIdentifier​

string

Returns​

void

setActiveSiteDetailsTab​

readonly setActiveSiteDetailsTab: (tab: SiteDetailsTab) => void;

Parameters​

tab​

SiteDetailsTab

Returns​

void

setShowAdvancedMetrics​

readonly setShowAdvancedMetrics: (show: boolean) => void;

Parameters​

show​

boolean

Returns​

void

setSiteDetailsChartTimeRange​

readonly setSiteDetailsChartTimeRange: (range: ChartTimeRange) => void;

Parameters​

range​

ChartTimeRange

Returns​

void

showAdvancedMetrics​

readonly showAdvancedMetrics: boolean;

siteDetailsChartTimeRange​

readonly siteDetailsChartTimeRange: ChartTimeRange;

syncActiveSiteDetailsTab​

readonly syncActiveSiteDetailsTab: (siteIdentifier: string) => void;

Parameters​

siteIdentifier​

string

Returns​

void