Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Introduce customisable DimensionElement (#6401)
Artur Pata7bb9b00471a2
diff --git a/assets/js/dashboard/stats/breakdowns.tsx b/assets/js/dashboard/stats/breakdowns.tsxindex 79bb3bd520..377abdf125 100644--- a/assets/js/dashboard/stats/breakdowns.tsx+++ b/assets/js/dashboard/stats/breakdowns.tsx@@ -14,7 +14,6 @@ import {} from '../stats-query'import { Filter } from '../dashboard-state'import { MetricsByContext } from './reports/reports-config'-import { PlausibleSite } from '../site-context'export type SharedBreakdownReportProps = {dimensionLabel: string@@ -24,10 +23,6 @@ export type SharedBreakdownReportProps = {dimension: NonTimeDimension,row: QueryResultRow) => FilterInfo | null- getExternalLinkUrl?: (- site: PlausibleSite,- row: QueryResultRow- ) => string | null}export type ColumnConfiguration<T> = {diff --git a/assets/js/dashboard/stats/modals/details-breakdown.tsx b/assets/js/dashboard/stats/modals/details-breakdown.tsxindex e8f4022ad1..9ee84bf551 100644--- a/assets/js/dashboard/stats/modals/details-breakdown.tsx+++ b/assets/js/dashboard/stats/modals/details-breakdown.tsx@@ -11,7 +11,6 @@ import {StatsReportQueryKey,useSearchAndPaginateQueryAPI} from '../../hooks/use-query-api'-import { rootRoute } from '../../router'import {getStoredOrderBy,MetricOrderBy,@@ -26,7 +25,6 @@ import { useSiteContext } from '../../site-context'import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'import {ColumnConfiguration,- ExternalLinkIcon,MetricValueTooltipContent,SharedBreakdownReportProps,formatDateRangeLabel,@@ -52,6 +50,7 @@ import {isRealTimeDashboard} from '../../util/filters'import { SortButton } from '../../components/sort-button'+import { rootRoute } from '../../router'type PaginatedData = { pages: QueryApiResponse[] }@@ -60,6 +59,7 @@ type DetailsBreakdownProps = SharedBreakdownReportProps & {defaultOrderBy?: MetricOrderBysearchEnabled?: booleanonDataReady?: (data: PaginatedData) => void+ DimensionElement: (props: DimensionCellProps) => ReactNode}const getMetricCellWidthClass = (@@ -88,7 +88,7 @@ export function DetailsBreakdown({metrics,defaultOrderBy = [] as MetricOrderBy,getFilterInfo = defaultGetFilterInfo,- getExternalLinkUrl,+ DimensionElement,searchEnabled = true,onDataReady}: DetailsBreakdownProps) {@@ -165,22 +165,16 @@ export function DetailsBreakdown({const isVisitorsWithPercentageCell = (m: Metric) =>hasPercentage && m === 'visitors'- const externalLinkForRow =- typeof getExternalLinkUrl === 'function'- ? (row: QueryResultRow) => getExternalLinkUrl(site, row)- : undefined-return [{key: 'dimension',renderLabel: () => dimensionLabel,renderCell: (row, isActive) => (- <DimensionCell+ <DimensionElementrow={row}getFilterInfo={(row: QueryResultRow) =>getFilterInfo(filterDimension, row)}- externalLinkForRow={externalLinkForRow}isActive={isActive}/>),@@ -235,12 +229,11 @@ export function DetailsBreakdown({)]}, [- site,+ DimensionElement,dimensionLabel,query,meta,getFilterInfo,- getExternalLinkUrl,orderByDictionary,toggleSortByMetric,metricLabelFor@@ -476,48 +469,28 @@ function MetricLabel({}}-function DimensionCell({- row,- getFilterInfo,- externalLinkForRow,- isActive-}: {+export type DimensionCellProps = {row: QueryResultRowgetFilterInfo: (row: QueryResultRow) => FilterInfo | null- externalLinkForRow?: (row: QueryResultRow) => string | nullisActive?: boolean-}) {- return (- <div className="break-all flex items-center gap-x-1">- <DrilldownLink path={rootRoute.path} filterInfo={getFilterInfo(row)}>- {row.dimensions[0]}- </DrilldownLink>- {typeof externalLinkForRow === 'function' && (- <ExternalLink href={externalLinkForRow(row)} isActive={isActive} />- )}- </div>- )}-function ExternalLink({- href,- isActive+export const DimensionCell = ({+ text,+ icon,+ externalLink,+ getFilterInfo,+ row}: {- href: string | null- isActive?: boolean-}) {- return (- <div className="w-4 min-w-4 self-stretch flex flex-col justify-center">- {href && (- <a- target="_blank"- rel="noreferrer"- href={href}- className={isActive ? 'block' : 'hidden'}- >- <ExternalLinkIcon />- </a>- )}- </div>- )-}+ text: string+ icon?: ReactNode+ externalLink?: ReactNode+} & DimensionCellProps) => (+ <div className="break-all flex items-center gap-x-1">+ <DrilldownLink path={rootRoute.path} filterInfo={getFilterInfo(row)}>+ {icon}+ {text}+ </DrilldownLink>+ {externalLink}+ </div>+)diff --git a/assets/js/dashboard/stats/pages/details.tsx b/assets/js/dashboard/stats/pages/details.tsxindex 05920d80f4..1eec093666 100644--- a/assets/js/dashboard/stats/pages/details.tsx+++ b/assets/js/dashboard/stats/pages/details.tsx@@ -12,8 +12,14 @@ import {BREAKDOWN_REPORTS,BreakdownReportKey} from '../reports/reports-config'-import { DetailsBreakdown } from '../modals/details-breakdown'+import {+ DetailsBreakdown,+ DimensionCell,+ DimensionCellProps+} from '../modals/details-breakdown'import Modal from '../modals/modal'+import { DetailsExternalLink } from './external-link'+import { externalLinkForPage } from '../../util/url'export function PagesDetails({breakdownReportKey@@ -48,8 +54,24 @@ export function PagesDetails({dimensions={reportConfig.dimensions}metrics={metrics}defaultOrderBy={[['visitors', 'desc']]}- getExternalLinkUrl={reportConfig.getExternalLinkUrl}+ DimensionElement={PagesDimensionElement}/></Modal>)}++const PagesDimensionElement = (props: DimensionCellProps) => {+ const site = useSiteContext()+ return (+ <DimensionCell+ text={props.row.dimensions[0]}+ externalLink={+ <DetailsExternalLink+ href={externalLinkForPage(site, props.row.dimensions[0])}+ isActive={props.isActive}+ />+ }+ {...props}+ />+ )+}diff --git a/assets/js/dashboard/stats/pages/external-link.tsx b/assets/js/dashboard/stats/pages/external-link.tsxnew file mode 100644index 0000000000..594a3b7869--- /dev/null+++ b/assets/js/dashboard/stats/pages/external-link.tsx@@ -0,0 +1,48 @@+import React from 'react'+import { ExternalLinkIcon } from '../breakdowns'++export function DetailsExternalLink({+ href,+ isActive+}: {+ href: string | null+ isActive?: boolean+}) {+ return (+ <div className="w-4 min-w-4 self-stretch flex flex-col justify-center">+ {href && (+ <a+ target="_blank"+ rel="noreferrer"+ href={href}+ className={isActive ? 'block' : 'hidden'}+ >+ <ExternalLinkIcon />+ </a>+ )}+ </div>+ )+}++export function IndexExternalLink({+ href,+ isActive+}: {+ href: string+ isActive?: boolean+}) {+ return (+ <a+ target="_blank"+ rel="noreferrer"+ href={href}+ className={+ isActive+ ? 'visible md:invisible md:group-hover/row:visible'+ : 'invisible md:group-hover/row:visible'+ }+ >+ <ExternalLinkIcon />+ </a>+ )+}diff --git a/assets/js/dashboard/stats/pages/index.tsx b/assets/js/dashboard/stats/pages/index.tsxindex 7964905775..5c88ddfdb6 100644--- a/assets/js/dashboard/stats/pages/index.tsx+++ b/assets/js/dashboard/stats/pages/index.tsx@@ -18,8 +18,14 @@ import {BREAKDOWN_REPORTS,BreakdownReportKey} from '../reports/reports-config'-import { IndexBreakdown } from '../reports/index-breakdown'+import {+ DimensionCellWithBar,+ IndexBreakdown,+ DimensionCellWithBarProps+} from '../reports/index-breakdown'import { chooseBreakdownMetricsByContext } from '../breakdowns'+import { externalLinkForPage, trimURL } from '../../util/url'+import { IndexExternalLink } from './external-link'type Mode = Extract<BreakdownReportKey, 'pages' | 'entryPages' | 'exitPages'>@@ -34,6 +40,7 @@ const initMode = (storedMode: string): Mode => {}const BAR_COLOR = 'bg-orange-50 group-hover/row:bg-orange-100'+const MAX_DIMENSION_LENGTH = 70export default function Pages() {const { dashboardState } = useDashboardStateContext()@@ -73,8 +80,7 @@ export default function Pages() {metrics={currentModeMetrics}dimensions={currentModeReportConfig.dimensions}dimensionLabel={currentModeReportConfig.dimensionLabel}- color={BAR_COLOR}- getExternalLinkUrl={currentModeReportConfig.getExternalLinkUrl}+ DimensionElement={PagesDimensionCell}onDataReady={setCurrentData}/>)@@ -120,3 +126,21 @@ export default function Pages() {</ReportLayout>)}++function PagesDimensionCell(props: DimensionCellWithBarProps) {+ const site = useSiteContext()+ const externalUrl = externalLinkForPage(site, props.row.dimensions[0])+ const displayValue = trimURL(props.row.dimensions[0], MAX_DIMENSION_LENGTH)+ return (+ <DimensionCellWithBar+ text={displayValue}+ barClassName={BAR_COLOR}+ externalLink={+ externalUrl && (+ <IndexExternalLink href={externalUrl} isActive={props.isActive} />+ )+ }+ {...props}+ />+ )+}diff --git a/assets/js/dashboard/stats/reports/index-breakdown.tsx b/assets/js/dashboard/stats/reports/index-breakdown.tsxindex 6769d5d7b0..1ca270d819 100644--- a/assets/js/dashboard/stats/reports/index-breakdown.tsx+++ b/assets/js/dashboard/stats/reports/index-breakdown.tsx@@ -1,14 +1,18 @@-import React, { useCallback, useMemo, useState, useEffect } from 'react'+import React, {+ useCallback,+ useMemo,+ useState,+ useEffect,+ ReactNode+} from 'react'import FlipMove from 'react-flip-move'import LazyLoader from '../../components/lazy-loader'-import { trimURL } from '../../util/url'import { useDashboardStateContext } from '../../dashboard-state-context'import { useSiteContext } from '../../site-context'import { NonTimeDimension, OrderByEntry } from '../../stats-query'import { Metric, getBreakdownMetricLabel } from '../metrics'import {ColumnConfiguration,- ExternalLinkIcon,MetricValueTooltipContent,SharedBreakdownReportProps,formatDateRangeLabel,@@ -39,25 +43,22 @@ const ROW_GAP_HEIGHT = 4const DATA_CONTAINER_HEIGHT =(ROW_HEIGHT + ROW_GAP_HEIGHT) * (MAX_ITEMS - 1) + ROW_HEIGHT-const MAX_DIMENSION_LENGTH = 70-const DEFAULT_METRIC_COLUMN_WIDTH = 'w-16 min-w-16'const VISITORS_WITH_PERCENTAGE_COLUMN_WIDTH = 'w-32 min-w-32'const BAR_METRIC = 'visitors'type IndexBreakdownProps = SharedBreakdownReportProps & {- color: stringmetricColumnWidth?: string+ DimensionElement: (props: DimensionCellWithBarProps) => ReactNodeonDataReady?: (data: QueryApiResponse) => void}export function IndexBreakdown({metrics,dimensions,- color,+ DimensionElement,getFilterInfo = defaultGetFilterInfo,- getExternalLinkUrl,dimensionLabel,onDataReady,metricColumnWidth = DEFAULT_METRIC_COLUMN_WIDTH@@ -131,26 +132,19 @@ export function IndexBreakdown({const isVisitorsWithPercentageCell = (m: Metric) =>hasPercentage && m === 'visitors'- const externalLinkForRow =- typeof getExternalLinkUrl === 'function'- ? (row: QueryResultRow) => getExternalLinkUrl(site, row)- : undefined-return [{key: 'dimension',renderLabel: () => dimensionLabel,renderCell: (row, isActive) => (- <DimensionCell+ <DimensionElementrow={row}- color={color}barWidthPercent={((row.metrics[barMetricIndex] as number) / barMaxValue) * 100}getFilterInfo={(row: QueryResultRow) =>getFilterInfo(filterDimension, row)}- externalLinkForRow={externalLinkForRow}isActive={isActive}/>),@@ -188,15 +182,13 @@ export function IndexBreakdown({)]}, [- site,dimensionLabel,- color,+ DimensionElement,barMetricIndex,metricLabelFor,barMaxValue,query,getFilterInfo,- getExternalLinkUrl,metricColumnWidth])@@ -211,43 +203,42 @@ export function IndexBreakdown({)}-function DimensionCell({- row,- color,- barWidthPercent,- getFilterInfo,- externalLinkForRow,- isActive-}: {+export type DimensionCellWithBarProps = {row: QueryResultRow- color: stringbarWidthPercent: number- getFilterInfo: (row: QueryResultRow) => FilterInfo | null- externalLinkForRow?: (row: QueryResultRow) => string | nullisActive?: boolean-}) {- const externalUrl = externalLinkForRow?.(row)- return (- <div className="w-full h-full relative">- <div- className={`absolute top-0 left-0 h-full rounded-sm ${color} dark:bg-gray-500/15 dark:group-hover/row:bg-gray-500/30`}- style={{ width: `${barWidthPercent}%` }}- />- <div className="flex justify-start items-center gap-x-1.5 px-2 py-1.5 text-sm dark:text-gray-300 relative z-9 break-all w-full">- <DrilldownLink- filterInfo={getFilterInfo(row)}- extraClass="max-w-max w-full flex items-center md:overflow-hidden"- >- <span className="w-full md:truncate">- {trimURL(row.dimensions[0], MAX_DIMENSION_LENGTH)}- </span>- </DrilldownLink>- {externalUrl && <ExternalLink href={externalUrl} isActive={isActive} />}- </div>- </div>- )+ getFilterInfo: (row: QueryResultRow) => FilterInfo | null}+export const DimensionCellWithBar = ({+ text,+ icon,+ externalLink,+ getFilterInfo,+ barWidthPercent,+ barClassName,+ row+}: {+ text: string+ icon?: ReactNode+ externalLink?: ReactNode+ barClassName: string+} & DimensionCellWithBarProps) => (+ <div className="w-full h-full relative">+ <Bar barWidthPercent={barWidthPercent} className={barClassName}></Bar>+ <div className="flex justify-start items-center gap-x-1.5 px-2 py-1.5 text-sm dark:text-gray-300 relative z-9 break-all w-full">+ <DrilldownLink+ filterInfo={getFilterInfo(row)}+ extraClass="max-w-max w-full flex items-center md:overflow-hidden"+ >+ {icon}+ <span className="w-full md:truncate">{text}</span>+ </DrilldownLink>+ {externalLink}+ </div>+ </div>+)+function VisitorsWithPercentageCell({row,query,@@ -551,25 +542,18 @@ export function IndexBreakdownRenderer({)}-function ExternalLink({- href,- isActive+const Bar = ({+ barWidthPercent,+ className}: {- href: string- isActive?: boolean-}) {- return (- <a- target="_blank"- rel="noreferrer"- href={href}- className={- isActive- ? 'visible md:invisible md:group-hover/row:visible'- : 'invisible md:group-hover/row:visible'- }- >- <ExternalLinkIcon />- </a>- )-}+ barWidthPercent: number+ className: string+}) => (+ <div+ className={classNames(+ `absolute top-0 left-0 h-full rounded-sm dark:bg-gray-500/15 dark:group-hover/row:bg-gray-500/30`,+ className+ )}+ style={{ width: `${barWidthPercent}%` }}+ />+)diff --git a/assets/js/dashboard/stats/reports/reports-config.ts b/assets/js/dashboard/stats/reports/reports-config.tsindex afe960edf4..ef1c7a8c6a 100644--- a/assets/js/dashboard/stats/reports/reports-config.ts+++ b/assets/js/dashboard/stats/reports/reports-config.ts@@ -1,8 +1,5 @@-import { PlausibleSite } from '../../site-context'import { NonTimeDimension } from '../../stats-query'import { Metric } from '../metrics'-import * as url from '../../util/url'-import { QueryResultRow } from '../../api'export type MetricsByContext = {realtimeMetrics: Metric[]@@ -12,16 +9,12 @@ export type MetricsByContext = {goalFilterDetailedMetrics: Metric[]}-type BreakdownReportConfig = {+export type BreakdownReportConfig = {dimensions: [NonTimeDimension] | [NonTimeDimension, NonTimeDimension]metricsByContext: MetricsByContextdetailsTitle: stringdetailsPath: stringdimensionLabel: string- getExternalLinkUrl?: (- site: PlausibleSite,- row: QueryResultRow- ) => string | null}const COMMON_METRICS_BY_CONTEXT: MetricsByContext = {@@ -30,7 +23,6 @@ const COMMON_METRICS_BY_CONTEXT: MetricsByContext = {defaultDetailedMetrics: ['visitors','percentage',- 'visits','bounce_rate','visit_duration'],@@ -42,13 +34,6 @@ const COMMON_METRICS_BY_CONTEXT: MetricsByContext = {]}-function getExternalLinkUrlForPage(- site: PlausibleSite,- row: QueryResultRow-): string | null {- return url.externalLinkForPage(site, row.dimensions[0])-}-export enum BreakdownReportKey {'pages' = 'pages','entryPages' = 'entryPages',@@ -74,16 +59,23 @@ export const BREAKDOWN_REPORTS: Record<},detailsTitle: 'Top pages',detailsPath: 'pages',- dimensionLabel: 'Page',- getExternalLinkUrl: getExternalLinkUrlForPage+ dimensionLabel: 'Page'},[BreakdownReportKey.entryPages]: {dimensions: ['visit:entry_page'],- metricsByContext: COMMON_METRICS_BY_CONTEXT,+ metricsByContext: {+ ...COMMON_METRICS_BY_CONTEXT,+ defaultDetailedMetrics: [+ 'visitors',+ 'percentage',+ 'visits',+ 'bounce_rate',+ 'visit_duration'+ ]+ },detailsTitle: 'Entry pages',detailsPath: 'entry-pages',- dimensionLabel: 'Entry page',- getExternalLinkUrl: getExternalLinkUrlForPage+ dimensionLabel: 'Entry page'},[BreakdownReportKey.exitPages]: {dimensions: ['visit:exit_page'],@@ -93,7 +85,6 @@ export const BREAKDOWN_REPORTS: Record<},detailsTitle: 'Exit pages',detailsPath: 'exit-pages',- dimensionLabel: 'Exit page',- getExternalLinkUrl: getExternalLinkUrlForPage+ dimensionLabel: 'Exit page'}}