OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.
import { useCallback, useMemo, useRef, useState } from 'react';
import type { RouterOutputs } from '@/trpc/client';
export type IVisibleConversionSeries = ReturnType<
typeof useVisibleConversionSeries
>['series'];
export function useVisibleConversionSeries(
data: RouterOutputs['chart']['conversion'],
options?: {
limit?: number;
savedVisibleSeries?: string[] | null;
onVisibleSeriesChange?: (ids: string[]) => void;
}
) {
const max = options?.limit ?? 5;
const savedVisibleSeries = options?.savedVisibleSeries;
const onChangeRef = useRef(options?.onVisibleSeriesChange);
onChangeRef.current = options?.onVisibleSeriesChange;
const seriesKey = data?.current?.map((s) => s.id).join(',') ?? '';
const resolveIds = (
series: RouterOutputs['chart']['conversion']['current']
): string[] => {
if (savedVisibleSeries && savedVisibleSeries.length > 0) {
const valid = savedVisibleSeries.filter((id) =>
series.some((s) => s.id === id)
);
if (valid.length > 0) {
return valid;
}
}
return series.slice(0, max).map((s) => s.id);
};
const [visibleSeries, setVisibleSeries] = useState<string[]>(() =>
resolveIds(data?.current ?? [])
);
// What the chart first showed for this set of series; "Reset" goes back to it.
const defaultIdsRef = useRef(visibleSeries);
const prevKeyRef = useRef(seriesKey);
if (prevKeyRef.current !== seriesKey) {
prevKeyRef.current = seriesKey;
defaultIdsRef.current = resolveIds(data?.current ?? []);
setVisibleSeries(defaultIdsRef.current);
}
const handleSet = useCallback<React.Dispatch<React.SetStateAction<string[]>>>(
(action) => {
setVisibleSeries((prev) => {
const next = typeof action === 'function' ? action(prev) : action;
onChangeRef.current?.(next);
return next;
});
},
[]
);
const defaultIds = defaultIdsRef.current;
const isDefaultSelection =
defaultIds.length === visibleSeries.length &&
defaultIds.every((id) => visibleSeries.includes(id));
const resetRef = useRef<() => void>(() => undefined);
resetRef.current = () => handleSet(defaultIds);
const reset = useCallback(() => resetRef.current(), []);
return useMemo(
() => ({
isDefaultSelection,
reset,
series: data.current
.map((serie, index) => ({ ...serie, index }))
.filter((serie) => visibleSeries.includes(serie.id)),
setVisibleSeries: handleSet,
}),
[visibleSeries, data.current, handleSet, isDefaultSelection, reset]
);
}