Turn off character key short

[emalstm]

Hi,
Thank you so much for creating Material, I feel like my life has became a lot easier since we implemented it a week ago ❤️

I see you have a lot of hidden a11y-features, which is great! Single character key shortcuts are very useful, but ideally the user should be able to turn them off. Is there a way to do that? I don't find it in the documentation.

https://www.wuhcag.com/character-key-shortcuts/

[squidfunk]

Thanks for your kind words. There's currently no flag to turn it off, so the way to go would be to patch the theme and recompile it, removing the keys you don't want to bind. Note that keyboard navigation in search is something I definitely wouldn't recommend disabling, as users are used to how search engines like Google operate. For this reason, I'd consider it rather bad UX, which means that it's not a good fit for the project, as we try to provide the best possible standard UX.

[squidfunk]

If you want to patch the theme – you just need to comment out or delete the following lines, and build it:

mkdocs-material/src/assets/javascripts/bundle.ts

Lines 139 to 163 in acd154d

	/* Set up global keyboard handlers */
	keyboard$
	.pipe(
	filter(({ mode }) => mode === "global")
	)
	.subscribe(key => {
	switch (key.type) {
	/* Go to previous page */
	case "p":
	case ",":
	const prev = getOptionalElement("[href][rel=prev]")
	if (typeof prev !== "undefined")
	prev.click()
	break
	/* Go to next page */
	case "n":
	case ".":
	const next = getOptionalElement("[href][rel=next]")
	if (typeof next !== "undefined")
	next.click()
	break
	}
	})

[humitos]

Hi! I found my question already answered here (basically, "there is no flag to turn this off"), however, since it's a 1 year old answer I wanted to know if this has changed. I would love to disable only the global hotkeys, I'm fine with search ones since they only work when there is focus on the search input. Thanks!

[squidfunk]

Nope, it did not change. We may evaluate in the future how and if we can make this configurable, but it is not a priority.

[Kiiv]

Hi,

interested in this too.
My documentation include some views from likec4 tool (https://playground.likec4.dev/w/tutorial/index/).
Those views contains a search box to find elements in diagrams but mkdocs does not detect that the focus is on a text area.
For exemple, when I hit 'p', I'm redirected to the previous page in documentation.

[kamilkrzyskow]

Without a theme rebuild, this functionality can be cut out from the final bundle.js with a hook and proper replacement pattern similar to this hacky solution here:

• Disabling media pause when switching content tabs. #6844 (reply in thread)

More recently, I've also used such hack on the mkdocs-nype reference page with slight alterations:

• https://github.com/nypesap/mkdocs-nype/blob/main/docs_overrides/hooks/scope_currentcolor_css.py