Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Help for facets #756

Merged
merged 8 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions tools/oversight/elements/list-facet.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ export default class ListFacet extends HTMLElement {
const fieldSet = this.querySelector('fieldset') || document.createElement('fieldset');
fieldSet.classList.add(`facet-${facetName}`);
const legendText = this.querySelector('legend')?.textContent || facetName;
const extraElements = Array.from(this.querySelectorAll(':scope > a, legend > a.icon') || []);

fieldSet.textContent = '';

Expand Down Expand Up @@ -165,6 +166,8 @@ export default class ListFacet extends HTMLElement {
});

legend.append(clipboard, clipboardPaste);
extraElements.forEach((el) => el.classList.add('icon'));
legend.append(...extraElements);
if (drilldownAtt && url.searchParams.get('drilldown') !== facetName) {
const drilldown = document.createElement('a');
drilldown.className = 'drilldown';
Expand Down
21 changes: 20 additions & 1 deletion tools/oversight/explorer.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<html>

<head>
<title>Real Use Monitoring (RUM) Explorer | AEM Live</title>
<script type="importmap">{"imports": {
Expand Down Expand Up @@ -125,6 +124,8 @@ <h2>TTFB</h2>
</list-facet>
<list-facet facet="userAgent" drilldown="share.html">
<legend>Device Type and Operating System</legend>
<a href="/docs/rum-explorer#device-share" class="help"
target="_blank" title="What devices and operating systems have accessed your site?"></a>
<dl>
<dt>desktop</dt>
<dd>All Desktop</dd>
Expand Down Expand Up @@ -158,9 +159,13 @@ <h2>TTFB</h2>
</list-facet>
<link-facet facet="url" drilldown="list.html" thumbnail="true" highlight="filter">
<legend>URL</legend>
<a href="/docs/rum-explorer#url" class="help"
target="_blank" title="What different pages make up your site?"></a>
</link-facet>
<list-facet facet="checkpoint" drilldown="flow.html" highlight="filter">
<legend>Checkpoints</legend>
<a href="/docs/rum-explorer#checkpoints" class="help"
target="_blank" title="What type of activity data is collected?"></a>
<dl>
<dt>enter</dt>
<dd>Visit Entry</dd>
Expand Down Expand Up @@ -190,28 +195,42 @@ <h2>TTFB</h2>
</list-facet>
<literal-facet facet="click.source" drilldown="list.html">
<legend>Click Source (CSS Selector)</legend>
<a href="/docs/rum-explorer#facet-click" class="help"
target="_blank" title="What page visitors clicked"></a>
</literal-facet>
<link-facet facet="click.target" drilldown="list.html">
<legend>Click Target (URL)</legend>
<a href="/docs/rum-explorer#facet-click" class="help"
target="_blank" title="What page visitors clicked"></a>
</link-facet>
<literal-facet facet="viewmedia.source" drilldown="list.html">
<legend>Media Source (CSS Selector)</legend>
<a href="/docs/rum-explorer#facet-viewmedia" class="help"
target="_blank" title="What image/video visitors have seen?"></a>
</literal-facet>
<thumbnail-facet facet="viewmedia.target" drilldown="list.html">
<legend>Media Target</legend>
<a href="/docs/rum-explorer#facet-viewmedia" class="help"
target="_blank" title="What image/video visitors have seen?"></a>
</thumbnail-facet>
<literal-facet facet="viewblock.source" drilldown="list.html">
<legend>Block (CSS Selector)</legend>
<a href="/docs/rum-explorer#facet-viewblock" class="help"
target="_blank" title="What blocks visitors have seen?"></a>
</literal-facet>
<link-facet facet="enter.source" drilldown="list.html" thumbnail="true" favicon="true">
<legend>External Referrer</legend>
<a href="/docs/rum-explorer#facet-enter" class="help"
target="_blank" title="How the users entered into the site?"></a>
<dl>
<dt>(direct)</dt>
<dd>Direct Entry (or via App)</dd>
</dl>
</link-facet>
<link-facet facet="navigate.source" thumbnail="true" drilldown="list.html">
<legend>Internal Referrer</legend>
<a href="/docs/rum-explorer#facet-navigate" class="help"
target="_blank" title="Internal navigation paths on the site"></a>
</link-facet>

<list-facet facet="consent.source">
Expand Down
10 changes: 10 additions & 0 deletions tools/oversight/flow.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ <h2>TTFB</h2>
<facet-sidebar>
<list-facet facet="userAgent" drilldown="share.html">
<legend>Device Type and Operating System</legend>
<a href="/docs/rum-explorer#device-share" class="help"
target="_blank" title="What devices and operating systems have accessed your site?"></a>
<dl>
<dt>desktop</dt>
<dd>All Desktop</dd>
Expand Down Expand Up @@ -147,9 +149,13 @@ <h2>TTFB</h2>
</list-facet>
<link-facet facet="url" drilldown="list.html" thumbnail="true" highlight="filter">
<legend>URL</legend>
<a href="/docs/rum-explorer#url" class="help"
target="_blank" title="What different pages make up your site?"></a>
</link-facet>
<list-facet facet="checkpoint" drilldown="flow.html" highlight="filter">
<legend>Checkpoints</legend>
<a href="/docs/rum-explorer#checkpoints" class="help"
target="_blank" title="What type of activity data is collected?"></a>
<dl>
<dt>enter</dt>
<dd>Visit Entry</dd>
Expand Down Expand Up @@ -196,6 +202,8 @@ <h2>TTFB</h2>
</list-facet>
<list-facet facet="clicktarget">
<legend>Click Target Type</legend>
<a href="/docs/rum-explorer#facet-click" class="help"
target="_blank" title="Where on the page (including links) visitors clicked?"></a>
</list-facet>
<list-facet facet="exit">
<legend>Exit Link</legend>
Expand All @@ -205,6 +213,8 @@ <h2>TTFB</h2>
</vitals-facet>
<thumbnail-facet facet="lcp.target">
<legend>LCP Image</legend>
<a href="/docs/rum-explorer#facet-lcp" class="help"
target="_blank" title="Identify elements of page that are slowing down page loading"></a>
</thunbnail-facet>
<literal-facet facet="lcp.source">
<legend>LCP Element</legend>
Expand Down
20 changes: 20 additions & 0 deletions tools/oversight/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ <h2>TTFB</h2>
<facet-sidebar>
<list-facet facet="userAgent" drilldown="share.html">
<legend>Device Type and Operating System</legend>
<a href="/docs/rum-explorer#device-share" class="help"
target="_blank" title="What devices and operating systems have accessed your site?"></a>
<dl>
<dt>desktop</dt>
<dd>All Desktop</dd>
Expand Down Expand Up @@ -142,9 +144,13 @@ <h2>TTFB</h2>
</list-facet>
<link-facet facet="url" drilldown="list.html" thumbnail="true" highlight="filter">
<legend>URL</legend>
<a href="/docs/rum-explorer#url" class="help"
target="_blank" title="What different pages make up your site?"></a>
</link-facet>
<list-facet facet="checkpoint" drilldown="flow.html" highlight="filter">
<legend>Checkpoints</legend>
<a href="/docs/rum-explorer#checkpoints" class="help"
target="_blank" title="What type of activity data is collected?"></a>
<dl>
<dt>enter</dt>
<dd>Visit Entry</dd>
Expand All @@ -170,28 +176,42 @@ <h2>TTFB</h2>
</list-facet>
<literal-facet facet="click.source" drilldown="list.html">
<legend>Click Source (CSS Selector)</legend>
<a href="/docs/rum-explorer#facet-click" class="help"
target="_blank" title="What page visitors clicked"></a>
</literal-facet>
<link-facet facet="click.target" drilldown="list.html">
<legend>Click Target (URL)</legend>
<a href="/docs/rum-explorer#facet-click" class="help"
target="_blank" title="What page visitors clicked"></a>
</link-facet>
<literal-facet facet="viewmedia.source" drilldown="list.html">
<legend>Media Source (CSS Selector)</legend>
<a href="/docs/rum-explorer#facet-viewmedia" class="help"
target="_blank" title="What image/video visitors have seen?"></a>
</literal-facet>
<thumbnail-facet facet="viewmedia.target" drilldown="list.html">
<legend>Media Target</legend>
<a href="/docs/rum-explorer#facet-viewmedia" class="help"
target="_blank" title="What image/video visitors have seen?"></a>
</thumbnail-facet>
<literal-facet facet="viewblock.source" drilldown="list.html">
<legend>Block (CSS Selector)</legend>
<a href="/docs/rum-explorer#facet-viewblock" class="help"
target="_blank" title="What blocks visitors have seen?"></a>
</literal-facet>
<link-facet facet="enter.source" drilldown="list.html" thumbnail="false">
<legend>External Referrer</legend>
<a href="/docs/rum-explorer#facet-enter" class="help"
target="_blank" title="How the users entered into the site?"></a>
<dl>
<dt>(direct)</dt>
<dd>Direct Entry (or via App)</dd>
</dl>
</link-facet>
<link-facet facet="navigate.source" thumbnail="true" drilldown="list.html">
<legend>Internal Referrer</legend>
<a href="/docs/rum-explorer#facet-navigate" class="help"
target="_blank" title="Internal navigation paths on the site"></a>
</link-facet>

<list-facet facet="consent.source">
Expand Down
Loading
Loading