Mkdocs-material: Search shortcut breaks forms

[markeganfuller]

Search shortcut breaks forms

We have a number of forms in our mkdocs site which are broken by the search shortcut (s / f).

Expected behavior

Search only opens when not focused on a form element.

Actual behavior

When typing in a form field (e.g. input / text area) an s or f will open the search.

Steps to reproduce the bug

1. Add the following to a test page

<form>
<input></input>
<textarea></textarea>                                                                                                
</form>

1. Attempt to write sausages in the input / text area

Package versions

• Python: Python 2.7.13
• MkDocs: 0.16.3
• Material: 1.7.4

Potential fix

I think the code to fix this would be a change to: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/javascripts/application.js#L340

Something like this to check if the current focused element is part of a form:

if (document.activeElement.form === undefined) {
  if (ev.keyCode === 70 || ev.keyCode === 83) {
    query.focus()
    ev.preventDefault()
  }
}

That seems to work in testing but doesn't pass the 'flow' check and I'm not quite familiar enough with js to quickly make this work.

[squidfunk]

That's indeed a bug, thanks for reporting and the potential fix!

[squidfunk]

Fixed in #407, will be released shortly with 1.7.5.

[Kobzol]

This is still a problem with Chrome even in 3.0.5. document.activeElement.form returns null for <input> tags, therefore the search gets focused everytime I try to write s or f into an input.

[squidfunk]

Please provide a reproducible scenario (with configuration + Markdown, or even better, a repo), then we can fix it.

[Kobzol]

Can I send you the website directly? Try this: https://docs.it4i.cz/modules-matrix/ focus the Module Filter input box and type "s". The repository for the website can be found here: https://code.it4i.cz/sccs/docs.it4i.cz.

[squidfunk]

I've inspected your code - for your purposes: you can wrap the input in a form and the error should be gone. I may improve the detection of active form fields so it doesn't trigger for input fields that are not wrapped inside forms when I find the time at some point in the future.

[Kobzol]

OK. That's an easy workaround, you're right. Thanks!