mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-30 18:24:35 +01:00
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
This commit is contained in:
parent
9b98c77725
commit
fc685e3a95
@ -274,18 +274,39 @@ generated by users interacting with the feedback widget with the help of some
|
|||||||
|
|
||||||
``` js
|
``` js
|
||||||
var feedback = document.forms.feedback
|
var feedback = document.forms.feedback
|
||||||
|
feedback.hidden = false // (1)!
|
||||||
|
|
||||||
feedback.addEventListener("submit", function(ev) {
|
feedback.addEventListener("submit", function(ev) {
|
||||||
ev.preventDefault()
|
ev.preventDefault()
|
||||||
|
|
||||||
/* Retrieve page and feedback value */
|
var page = document.location.pathname // (2)!
|
||||||
var page = document.location.pathname
|
|
||||||
var data = ev.submitter.getAttribute("data-md-value")
|
var data = ev.submitter.getAttribute("data-md-value")
|
||||||
|
|
||||||
/* Send feedback value */
|
console.log(page, data) // (3)!
|
||||||
console.log(page, data)
|
|
||||||
|
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`"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
|
Loading…
Reference in New Issue
Block a user