Skip to content

feat(platform): Capture plausible event for expandables #13818

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
11 changes: 10 additions & 1 deletion src/components/expandable/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import {ReactNode, useCallback, useEffect, useRef, useState} from 'react';
import {ChevronDownIcon, ChevronRightIcon} from '@radix-ui/react-icons';
import * as Sentry from '@sentry/nextjs';

import {usePlausibleEvent} from 'sentry-docs/hooks/usePlausibleEvent';

// explicitly not usig CSS modules here
// because there's some prerendered content that depends on these exact class names
import '../callout/styles.scss';
Expand Down Expand Up @@ -39,6 +41,7 @@ export function Expandable({
const [isExpanded, setIsExpanded] = useState(false);
const [copied, setCopied] = useState(false);
const contentRef = useRef<HTMLDivElement>(null);
const {emit} = usePlausibleEvent();

// Ensure we scroll to the element if the URL hash matches
useEffect(() => {
Expand Down Expand Up @@ -75,6 +78,8 @@ export function Expandable({
return;
}

emit('Copy Expandable Content', {props: {page: window.location.pathname, title}});

// Attempt to get text from markdown code blocks if they exist
const codeBlocks = contentRef.current.querySelectorAll('code');
let contentToCopy = '';
Expand Down Expand Up @@ -110,13 +115,17 @@ export function Expandable({
setCopied(false);
}
},
[]
[emit, title]
);

function toggleIsExpanded(event: React.MouseEvent<HTMLDetailsElement>) {
const newVal = event.currentTarget.open;
setIsExpanded(newVal);

if (newVal) {
emit('Open Expandable', {props: {page: window.location.pathname, title}});
}

if (id) {
if (newVal) {
window.history.pushState({}, '', `#${id}`);
Expand Down
8 changes: 8 additions & 0 deletions src/hooks/usePlausibleEvent.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,18 @@ import {ReadProgressMilestone} from 'sentry-docs/types/plausible';

// Adding custom events here will make them available via the hook
type PlausibleEventProps = {
['Copy Expandable Content']: {
page: string;
title: string;
};
['Doc Feedback']: {
helpful: boolean;
page: string;
};
['Open Expandable']: {
page: string;
title: string;
};
['Read Progress']: {
page: string;
readProgress: ReadProgressMilestone;
Expand Down
Loading