From 373b8e8201cc2e823c6178ed84acce2d97bbfc0b Mon Sep 17 00:00:00 2001 From: RobertJoonas <56999674+RobertJoonas@users.noreply.github.com> Date: Thu, 3 Aug 2023 19:12:38 +0100 Subject: [PATCH] UI tweaks to Properties and Conversions (#3226) * fix conversions fetchData limit to the right number * make Goal Conversions metric column width match Properties * add more top-margin to Details links in ListReport * add special handling for url prop in Conversions * change 'Details' button to 'More' when no additional details * fix CI * breakdown by 'path' prop instead for 404 pages * change the 'MORE' button back to 'DETAILS' But keep the option of not showing the button when there are less than 9 list entries. * capture special props in an object instead (review suggestion) * Add cloaked link to special goals list --------- Co-authored-by: Vinicius Brasil --- .../dashboard/stats/behaviours/conversions.js | 4 +- .../stats/behaviours/goal-conversions.js | 56 +++++++++++++++++++ assets/js/dashboard/stats/behaviours/index.js | 26 ++++++--- assets/js/dashboard/stats/behaviours/props.js | 1 + assets/js/dashboard/stats/modals/props.js | 3 +- assets/js/dashboard/stats/more-link.js | 34 ++++++----- assets/js/dashboard/stats/reports/list.js | 17 ++++-- 7 files changed, 112 insertions(+), 29 deletions(-) create mode 100644 assets/js/dashboard/stats/behaviours/goal-conversions.js diff --git a/assets/js/dashboard/stats/behaviours/conversions.js b/assets/js/dashboard/stats/behaviours/conversions.js index 4013da31e..d11a256ac 100644 --- a/assets/js/dashboard/stats/behaviours/conversions.js +++ b/assets/js/dashboard/stats/behaviours/conversions.js @@ -10,7 +10,7 @@ export default function Conversions(props) { const {site, query} = props function fetchConversions() { - return api.get(url.apiPath(site, '/conversions'), query, {limit: 20}) + return api.get(url.apiPath(site, '/conversions'), query, {limit: 9}) } function getFilterFor(listItem) { @@ -30,8 +30,10 @@ export default function Conversions(props) { {name: 'average_revenue', label: 'Average', hiddenOnMobile: true} ]} detailsLink={url.sitePath(site, '/conversions')} + maybeHideDetails={true} query={query} color="bg-red-50" + colMinWidth={90} /> ) } diff --git a/assets/js/dashboard/stats/behaviours/goal-conversions.js b/assets/js/dashboard/stats/behaviours/goal-conversions.js new file mode 100644 index 000000000..6d18821c2 --- /dev/null +++ b/assets/js/dashboard/stats/behaviours/goal-conversions.js @@ -0,0 +1,56 @@ +import React from "react" +import Conversions from './conversions' +import ListReport from "../reports/list" +import { CR_METRIC } from "../reports/metrics" +import * as url from "../../util/url" +import * as api from "../../api" + +const SPECIAL_GOALS = { + '404': {title: '404 Pages', prop: 'path'}, + 'Outbound Link: Click': {title: 'Outbound Links', prop: 'url'}, + 'Cloaked Link: Click': {title: 'Cloaked Links', prop: 'url'}, + 'File Download': {title: 'File Downloads', prop: 'url'} +} + +export function specialTitleWhenGoalFilter(query, defaultTitle) { + return SPECIAL_GOALS[query.filters.goal]?.title || defaultTitle +} + +function SpecialPropBreakdown(props) { + const { site, query } = props + const prop = SPECIAL_GOALS[query.filters.goal].prop + + function fetchData() { + return api.get(url.apiPath(site, `/custom-prop-values/${prop}`), query) + } + + const getFilterFor = (listItem) => { return {'props': JSON.stringify({[prop]: listItem['name']})} } + + return ( + + ) +} + +export default function GoalConversions(props) { + const {site, query} = props + + if (SPECIAL_GOALS[query.filters.goal]) { + return + } else { + return + } +} diff --git a/assets/js/dashboard/stats/behaviours/index.js b/assets/js/dashboard/stats/behaviours/index.js index 85e913602..913a39743 100644 --- a/assets/js/dashboard/stats/behaviours/index.js +++ b/assets/js/dashboard/stats/behaviours/index.js @@ -4,7 +4,7 @@ import { ChevronDownIcon } from '@heroicons/react/20/solid' import classNames from 'classnames' import * as storage from '../../util/storage' -import Conversions from './conversions' +import GoalConversions, { specialTitleWhenGoalFilter } from './goal-conversions' import DeprecatedConversions from './deprecated-conversions' import Properties from './props' import Funnel from './funnel' @@ -24,8 +24,8 @@ export const sectionTitles = { } export default function Behaviours(props) { - const site = props.site - const adminAccess = ['owner', 'admin', 'super_admin'].includes(props.currentUserRole) + const {site, query, currentUserRole} = props + const adminAccess = ['owner', 'admin', 'super_admin'].includes(currentUserRole) const tabKey = `behavioursTab__${site.domain}` const funnelKey = `behavioursTabFunnel__${site.domain}` const [enabledModes, setEnabledModes] = useState(getEnabledModes()) @@ -126,9 +126,9 @@ export default function Behaviours(props) { function renderConversions() { if (site.hasGoals) { if (site.flags.props) { - return + return } else { - return + return } } else if (adminAccess) { @@ -148,7 +148,7 @@ export default function Behaviours(props) { } function renderFunnels() { - if (selectedFunnel) { return } + if (selectedFunnel) { return } else if (adminAccess) { return ( 0) { - return + return } else if (adminAccess) { return (

- {sectionTitles[mode] + (isRealtime() ? ' (last 30min)' : '')} + {sectionTitle() + (isRealtime() ? ' (last 30min)' : '')}

{tabs()}
diff --git a/assets/js/dashboard/stats/behaviours/props.js b/assets/js/dashboard/stats/behaviours/props.js index 6463a65ac..d6e654ef8 100644 --- a/assets/js/dashboard/stats/behaviours/props.js +++ b/assets/js/dashboard/stats/behaviours/props.js @@ -50,6 +50,7 @@ export default function Properties(props) { {name: 'average_revenue', label: 'Average', hiddenOnMobile: true} ]} detailsLink={url.sitePath(site, `/custom-prop-values/${propKey}`)} + maybeHideDetails={true} query={query} color="bg-red-50" colMinWidth={90} diff --git a/assets/js/dashboard/stats/modals/props.js b/assets/js/dashboard/stats/modals/props.js index 9b3fe85be..7a2c08fa4 100644 --- a/assets/js/dashboard/stats/modals/props.js +++ b/assets/js/dashboard/stats/modals/props.js @@ -8,6 +8,7 @@ import * as api from '../../api' import * as url from "../../util/url"; import numberFormatter from '../../util/number-formatter' import { parseQuery } from '../../query' +import { specialTitleWhenGoalFilter } from "../behaviours/goal-conversions"; function PropsModal(props) { const site = props.site @@ -83,7 +84,7 @@ function PropsModal(props) { return ( <> -

Custom Property breakdown

+

{ specialTitleWhenGoalFilter(query, 'Custom Property Breakdown') }

diff --git a/assets/js/dashboard/stats/more-link.js b/assets/js/dashboard/stats/more-link.js index ac40bb253..ff6e45c6b 100644 --- a/assets/js/dashboard/stats/more-link.js +++ b/assets/js/dashboard/stats/more-link.js @@ -1,6 +1,25 @@ import React from 'react'; import { Link } from 'react-router-dom' +function detailsIcon() { + return ( + + {/* eslint-disable-next-line max-len */} + + + ) +} + export default function MoreLink({url, site, list, endpoint, className}) { if (list.length > 0) { return ( @@ -10,20 +29,7 @@ export default function MoreLink({url, site, list, endpoint, className}) { // eslint-disable-next-line max-len className="leading-snug font-bold text-sm text-gray-500 dark:text-gray-400 hover:text-red-500 dark:hover:text-red-400 transition tracking-wide" > - - {/* eslint-disable-next-line max-len */} - - + { detailsIcon() } DETAILS diff --git a/assets/js/dashboard/stats/reports/list.js b/assets/js/dashboard/stats/reports/list.js index 5e116fd3e..501cc9de4 100644 --- a/assets/js/dashboard/stats/reports/list.js +++ b/assets/js/dashboard/stats/reports/list.js @@ -91,7 +91,12 @@ function ExternalLink({ item, externalLinkDest }) { // * `onClick` - function with additional action to be taken when a list entry is clicked. // * `detailsLink` - the pathname to the detailed view of this report. E.g.: -// `/dummy.site/pages` +// `/dummy.site/pages`. If this is given as input to the ListReport, the Details button +// will always be rendered. + +// * `maybeHideDetails` - set this to `true` if the details button should be hidden on +// the condition that there are less than MAX_ITEMS entries in the list. (i.e . nothing +// more to show) // * `externalLinkDest` - a function that takes a list item and returns an external url // to navigate to. If this prop is given, an additional icon is rendered upon hovering @@ -168,7 +173,7 @@ export default function ListReport(props) { {renderReportBody()} - {maybeRenderMoreLink()} + {maybeRenderDetailsLink()} ) } @@ -297,8 +302,12 @@ export default function ListReport(props) { ) } - function maybeRenderMoreLink() { - return props.detailsLink && !state.loading && + function maybeRenderDetailsLink() { + const moreResultsAvailable = state.list.length >= MAX_ITEMS + const hideDetails = props.maybeHideDetails && !moreResultsAvailable + + const showDetails = props.detailsLink && !state.loading && !hideDetails + return showDetails && } return (