Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

Native 'Go back' support for period

Blue Mousee30d07712e87
diff --git a/web/app/lib/constants/index.ts b/web/app/lib/constants/index.ts
index 55084283e..107577671 100644
--- a/web/app/lib/constants/index.ts
+++ b/web/app/lib/constants/index.ts
@@ -36,13 +36,32 @@ export const ALL_PERIODS = ['minute', 'hour', 'day', 'month', 'year']
export interface TBPeriodPairsProps {
label: string
- period: string
+ period: Period
tbs: string[]
countDays?: number
dropdownLabel?: string
isCustomDate?: boolean
}
+export const VALID_PERIODS = [
+ '1h',
+ 'today',
+ 'yesterday',
+ '1d',
+ '7d',
+ '4w',
+ '3M',
+ '12M',
+ '24M',
+ 'all',
+
+ // Extended periods
+ 'custom',
+ 'compare',
+] as const
+
+export type Period = (typeof VALID_PERIODS)[number]
+
export const tbPeriodPairs = (
t: typeof i18nextT,
tbs?: string[] | null,
diff --git a/web/app/pages/Project/View/ViewProject.tsx b/web/app/pages/Project/View/ViewProject.tsx
index 5100771ae..45f0c669a 100644
--- a/web/app/pages/Project/View/ViewProject.tsx
+++ b/web/app/pages/Project/View/ViewProject.tsx
@@ -109,6 +109,8 @@ import {
ERROR_PANELS_ORDER,
ERROR_PERIOD_PAIRS,
FUNNELS_PERIOD_PAIRS,
+ Period,
+ VALID_PERIODS,
} from '~/lib/constants'
import { CountryEntry } from '~/lib/models/Entry'
import { Funnel, AnalyticsFunnel, OverallObject, OverallPerformanceObject } from '~/lib/models/Project'
@@ -224,7 +226,7 @@ interface ViewProjectContextType {
// Functions
setDateRange: Dispatch<SetStateAction<Date[] | null>>
- updatePeriod: (newPeriod: { period: string; label?: string }) => void
+ updatePeriod: (newPeriod: { period: Period; label?: string }) => void
updateTimebucket: (newTimebucket: string) => void
setPeriodPairs: Dispatch<SetStateAction<TBPeriodPairsProps[]>>
@@ -294,9 +296,7 @@ const ViewProject = () => {
const [isNewFunnelOpened, setIsNewFunnelOpened] = useState(false)
const [isAddAViewOpened, setIsAddAViewOpened] = useState(false)
const [analyticsLoading, setAnalyticsLoading] = useState(true)
- const [period, setPeriod] = useState(preferences.period || periodPairs[4].period)
const [timeBucket, setTimebucket] = useState(preferences.timeBucket || periodPairs[4].tbs[1])
- const activePeriod = useMemo(() => _find(periodPairs, (p) => p.period === period), [period, periodPairs])
const [chartData, setChartData] = useState<any>({})
const [mainChart, setMainChart] = useState<any>(null)
const [dataLoading, setDataLoading] = useState(false)
@@ -344,6 +344,17 @@ const ViewProject = () => {
return PROJECT_TABS.traffic
}, [searchParams])
+ const period = useMemo<Period>(() => {
+ const urlPeriod = searchParams.get('period') as Period
+
+ if (VALID_PERIODS.includes(urlPeriod)) {
+ return urlPeriod
+ }
+
+ return preferences.period || periodPairs[4].period
+ }, [searchParams, preferences.period, periodPairs])
+
+ const activePeriod = useMemo(() => _find(periodPairs, (p) => p.period === period), [period, periodPairs])
const [isHotkeysHelpOpened, setIsHotkeysHelpOpened] = useState(false)
@@ -2011,7 +2022,7 @@ const ViewProject = () => {
const parsePeriodFilters = () => {
try {
- const initialPeriod = searchParams.get('period') || preferences.period || '7d'
+ const initialPeriod = (searchParams.get('period') as Period) || preferences.period || '7d'
if (!_includes(validPeriods, initialPeriod)) {
return
@@ -2393,26 +2404,20 @@ const ViewProject = () => {
for (const index in timeBucketToDays) {
if (timeBucketToDays[index].lt >= days) {
let eventEmitTimeBucket = timeBucket
+ const newSearchParams = new URLSearchParams(searchParams.toString())
if (!onRender && !_includes(timeBucketToDays[index].tb, timeBucket)) {
eventEmitTimeBucket = timeBucketToDays[index].tb[0]
- const newSearchParams = new URLSearchParams(searchParams.toString())
newSearchParams.set('timeBucket', eventEmitTimeBucket)
- newSearchParams.set('period', 'custom')
- newSearchParams.set('from', dates[0].toISOString())
- newSearchParams.set('to', dates[1].toISOString())
- setSearchParams(newSearchParams)
setTimebucket(eventEmitTimeBucket)
- } else {
- const newSearchParams = new URLSearchParams(searchParams.toString())
- newSearchParams.set('period', 'custom')
- newSearchParams.set('from', dates[0].toISOString())
- newSearchParams.set('to', dates[1].toISOString())
- setSearchParams(newSearchParams)
}
+ newSearchParams.set('from', dates[0].toISOString())
+ newSearchParams.set('to', dates[1].toISOString())
+ newSearchParams.set('period', 'custom')
+ setSearchParams(newSearchParams)
+
setPeriodPairs(tbPeriodPairs(t, timeBucketToDays[index].tb, dates, language))
- setPeriod('custom')
updatePreferences({
period: 'custom',
@@ -2468,7 +2473,7 @@ const ViewProject = () => {
return () => clearInterval(interval)
}, [project, projectPassword])
- const updatePeriod = (newPeriod: { period: string; label?: string }) => {
+ const updatePeriod = (newPeriod: { period: Period; label?: string }) => {
if (period === newPeriod.period) {
return
}
@@ -2495,7 +2500,6 @@ const ViewProject = () => {
timeBucket: tb,
rangeDate: undefined,
})
- setPeriod(newPeriod.period)
setCanLoadMoreSessions(false)
resetSessions()
diff --git a/web/app/providers/CurrentProjectProvider.tsx b/web/app/providers/CurrentProjectProvider.tsx
index dd038fbed..6cb6e07a4 100644
--- a/web/app/providers/CurrentProjectProvider.tsx
+++ b/web/app/providers/CurrentProjectProvider.tsx
@@ -5,7 +5,7 @@ import { useNavigate, useSearchParams } from 'react-router'
import { toast } from 'sonner'
import { checkPassword, getInstalledExtensions, getProject } from '~/api'
-import { isSelfhosted, LS_PROJECTS_PROTECTED_KEY } from '~/lib/constants'
+import { isSelfhosted, LS_PROJECTS_PROTECTED_KEY, Period } from '~/lib/constants'
import { Extension, type Project } from '~/lib/models/Project'
import { getItemJSON, removeItem } from '~/utils/localstorage'
import routes from '~/utils/routes'
@@ -133,7 +133,7 @@ const useProject = (id: string) => {
}
export type ProjectPreferences = {
- period?: string
+ period?: Period
timeBucket?: string
rangeDate?: Date[]
customEvents?: any