Documentation for the VirtualKeyboard API

[captainbrosset]

Description

This PR adds the necessary documentation for the VirtualKeyboard API.

Motivation

The VirtualKeyboard API shipped in chromium-based browsers over a year ago (here is the CL where it got enabled).

It then was documented on BCD (here) which means that it's available on caniuse (here). And it was documented by Thomas Steiner on developer.chrome.com (here).

Although this is still only in Chromium-based browsers (mozilla position, webkit position), it's very useful on mobile devices and can be used as a progressive enhancement on supporting browsers. I think this API should absolutely be documented on MDN.

[captainbrosset]

In talking to @tomayac, I learned that @chrisdavidmills was maybe planning on working on this. Chris, would you mind giving this a review then?

[github-actions]

Preview URLs (12 pages)

• /en-US/docs/Web/API/Navigator/virtualKeyboard
• /en-US/docs/Web/API/Navigator
• /en-US/docs/Web/API/VirtualKeyboard/boundingRect
• /en-US/docs/Web/API/VirtualKeyboard/geometrychange_event
• /en-US/docs/Web/API/VirtualKeyboard/hide
• /en-US/docs/Web/API/VirtualKeyboard/overlaysContent
• /en-US/docs/Web/API/VirtualKeyboard/show
• /en-US/docs/Web/API/VirtualKeyboard
• /en-US/docs/Web/API/VirtualKeyboard_API
• /en-US/docs/Web/CSS/env
• /en-US/docs/Web/HTML/Global_attributes/virtualkeyboardpolicy
• /en-US/docs/Web/HTML/Global_attributes

Flaws (15)

Note! 9 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/Navigator
Title: Navigator
Flaw count: 5

• macros:
  • /en-US/docs/Web/API/Navigator/securitypolicy does not exist
  • /en-US/docs/Web/API/Navigator/standalone does not exist
• bad_bcd_links:
  • no explanation!
  • no explanation!
  • no explanation!

---

URL: /en-US/docs/Web/CSS/env
Title: env()
Flaw count: 9

• bad_bcd_links:
  • no explanation!
  • no explanation!
  • no explanation!
  • no explanation!
  • no explanation!
  • and 4 more flaws omitted

---

URL: /en-US/docs/Web/HTML/Global_attributes/virtualkeyboardpolicy
Title: virtualkeyboardpolicy
Flaw count: 1

• bad_bcd_queries:
  • No BCD data for query: html.global_attributes.virtualkeyboardpolicy

External URLs (7)

URL: /en-US/docs/Web/API/VirtualKeyboard
Title: VirtualKeyboard

• https://developer.chrome.com/docs/web-platform/virtual-keyboard/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/VirtualKeyboard/hide
Title: VirtualKeyboard.hide()

• https://developer.chrome.com/docs/web-platform/virtual-keyboard/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/VirtualKeyboard/show
Title: VirtualKeyboard.show()

• https://developer.chrome.com/docs/web-platform/virtual-keyboard/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/VirtualKeyboard/geometrychange_event
Title: VirtualKeyboard: geometrychange event

• https://developer.chrome.com/docs/web-platform/virtual-keyboard/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/VirtualKeyboard/boundingRect
Title: VirtualKeyboard.boundingRect

• https://developer.chrome.com/docs/web-platform/virtual-keyboard/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/VirtualKeyboard/overlaysContent
Title: VirtualKeyboard.overlaysContent

• https://developer.chrome.com/docs/web-platform/virtual-keyboard/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/VirtualKeyboard_API
Title: VirtualKeyboard API

• https://developer.chrome.com/docs/web-platform/virtual-keyboard/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2023-01-02 10:37:10)

[chrisdavidmills]

@captainbrosset Yup, more than happy to. I'll get my review done probably before the end of today.

[captainbrosset]

I see that images need to be compressed. I tried running the following suggested commands but the files didn't get changed on disk:

yarn filecheck 'files/en-us/web/api/virtualkeyboard_api/dual-screen.png' --save-compression
yarn filecheck 'files/en-us/web/api/virtualkeyboard_api/viewport-height.png' --save-compression

[chrisdavidmills]

@caugner , any thoughts on why the file compression commands don't appear to be working for @captainbrosset ?

[chrisdavidmills]

Hi @captainbrosset ! I've left a bunch of suggestions and comments here, but they are mostly language nitpicks and a few tips on macro usage, etc. These docs are interesting and informative, and I enjoyed reading them. Nice job!

[captainbrosset]

Thank you @chrisdavidmills for the thorough review. I'm pushing a new commit which addresses your comments in a second.

[chrisdavidmills]

@captainbrosset Much improved, thank you ! I've left a few more comments to point out some more bits I noticed, but not nearly as many this time.

Since I don't have permission to approve this PR, I'm handing it over to @Elchi3 to do the honours ;-)

[captainbrosset]

The latest comments from @chrisdavidmills should be addressed now.

[Elchi3]

Not sure if this helps, but I ran the compression locally and maybe you could use these files instead:

[captainbrosset]

Thank you @Elchi3! I just pushed a commit with your screenshots. Let's see if that worked ...

[Elchi3]

Seems to have worked 🎉
I scrolled through the pages briefly and looks good to me. Chris already provided a more in-depth review. Thanks for writing this up, Patrick! 👍

[chrisdavidmills]

Nice work @captainbrosset !