From fc685e3a9587a48ff4a48043e470bf1d3e64c1b1 Mon Sep 17 00:00:00 2001 From: Alexander Voss Date: Thu, 14 Dec 2023 03:23:29 -0500 Subject: [PATCH] Documentation (#6506) * added code and tooltips to custom site feedback - clarifying that the feedback widget needs to be turned on - showing how to disable the form and - show the notes that are configured * undoing a minor change that we unnecessary - I changed a colon to a full stop at some point because I thought I would add another sentence, decided not to and then the unneeded change ended up in the previous commit. * turned a comment I deleted into a tooltip --- docs/setup/setting-up-site-analytics.md | 29 +++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/docs/setup/setting-up-site-analytics.md b/docs/setup/setting-up-site-analytics.md index 0f5a1da37..d1dc08656 100644 --- a/docs/setup/setting-up-site-analytics.md +++ b/docs/setup/setting-up-site-analytics.md @@ -274,18 +274,39 @@ generated by users interacting with the feedback widget with the help of some ``` js var feedback = document.forms.feedback + feedback.hidden = false // (1)! + feedback.addEventListener("submit", function(ev) { ev.preventDefault() - /* Retrieve page and feedback value */ - var page = document.location.pathname + var page = document.location.pathname // (2)! var data = ev.submitter.getAttribute("data-md-value") - /* Send feedback value */ - console.log(page, data) + console.log(page, data) // (3)! + + feedback.firstElementChild.disabled = true // (4)! + + var note = feedback.querySelector( + ".md-feedback__note [data-md-value='" + data + "']" + ) + if (note) + note.hidden = false // (5)! }) ``` + 1. The feedback widget is hidden by default so that it does not appear when + people have JavaScript turned off. So, it needs to be turned on here. + + 2. Retrieve page and feedback value. + + 3. Replace this with the code that sends the data off to your analytics + provider. + + 4. Disable the form after submission. + + 5. Show the configured notes. Which one is shown depends on the user + feedback. + === ":octicons-file-code-16: `mkdocs.yml`" ``` yaml