Skip to main content

Function: useSiteDetailsUiStore()

useSiteDetailsUiStore(): { activeSiteDetailsTab: SiteDetailsTab; 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:49

Reads the UI store slice used by useSiteDetails.

Returns​

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

activeSiteDetailsTab​

readonly activeSiteDetailsTab: SiteDetailsTab

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