3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-31 01:47:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(analytics): allow query/hash changes to be sent to GA (#7545)

Browse source 
Co-authored-by: Lane Goolsby <lanegoolsby@rocketmortgage.com>
This commit is contained in:
Lane Goolsby 2022-06-02 03:47:52 -07:00 • committed by GitHub
parent f25ee0cbf5
commit 1efcfc4671
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

13
packages/docusaurus-plugin-google-analytics/src/analytics.ts
View file

@ -9,10 +9,19 @@ import type {ClientModule} from '@docusaurus/types';
const clientModule: ClientModule = { const clientModule: ClientModule = {
onRouteDidUpdate({location, previousLocation}) { onRouteDidUpdate({location, previousLocation}) {
if (previousLocation && location.pathname !== previousLocation.pathname) { if (
previousLocation &&
(location.pathname !== previousLocation.pathname ||
location.search !== previousLocation.search ||
location.hash !== previousLocation.hash)
) {
// Set page so that subsequent hits on this page are attributed // Set page so that subsequent hits on this page are attributed
// to this page. This is recommended for Single-page Applications. // to this page. This is recommended for Single-page Applications.
window.ga('set', 'page', location.pathname); window.ga(
'set',
'page',
location.pathname + location.search + location.hash,
);
// Always refer to the variable on window in-case it gets // Always refer to the variable on window in-case it gets
// overridden elsewhere. // overridden elsewhere.
window.ga('send', 'pageview'); window.ga('send', 'pageview');

18
packages/docusaurus-plugin-google-gtag/src/gtag.ts
View file

@ -5,16 +5,16 @@
* LICENSE file in the root directory of this source tree. * LICENSE file in the root directory of this source tree.
*/ */
import globalData from '@generated/globalData';
import type {PluginOptions} from './options';
import type {ClientModule} from '@docusaurus/types'; import type {ClientModule} from '@docusaurus/types';
const {trackingID} = globalData['docusaurus-plugin-google-gtag']!
.default as PluginOptions;
const clientModule: ClientModule = { const clientModule: ClientModule = {
onRouteDidUpdate({location, previousLocation}) { onRouteDidUpdate({location, previousLocation}) {
if (previousLocation && location.pathname !== previousLocation.pathname) { if (
previousLocation &&
(location.pathname !== previousLocation.pathname ||
location.search !== previousLocation.search ||
location.hash !== previousLocation.hash)
) {
// Normally, the document title is updated in the next tick due to how // Normally, the document title is updated in the next tick due to how
// `react-helmet-async` updates it. We want to send the current document's // `react-helmet-async` updates it. We want to send the current document's
// title to gtag instead of the old one's, so we use `setTimeout` to defer // title to gtag instead of the old one's, so we use `setTimeout` to defer
@ -23,14 +23,10 @@ const clientModule: ClientModule = {
setTimeout(() => { setTimeout(() => {
// Always refer to the variable on window in case it gets overridden // Always refer to the variable on window in case it gets overridden
// elsewhere. // elsewhere.
window.gtag('config', trackingID, {
page_path: location.pathname,
page_title: document.title,
});
window.gtag('event', 'page_view', { window.gtag('event', 'page_view', {
page_title: document.title, page_title: document.title,
page_location: window.location.href, page_location: window.location.href,
page_path: location.pathname, page_path: location.pathname + location.search + location.hash,
}); });
}); });
} }