chrome.virtualKeyboard

This API is part of the deprecated Chrome Apps platform. Learn more about migrating your app.

Important: This API works only on ChromeOS

Description
The chrome.virtualKeyboard API is a kiosk only API used to configure virtual keyboard layout and behavior in kiosk sessions.
Permissions
virtualKeyboard
Availability
Chrome 58+ ChromeOS only

Summary

autoCompleteEnabled
boolean optional
Whether virtual keyboards can provide auto-complete.
autoCorrectEnabled
boolean optional
Whether virtual keyboards can provide auto-correct.
handwritingEnabled
boolean optional
Whether virtual keyboards can provide input via handwriting recognition.
spellCheckEnabled
boolean optional
Whether virtual keyboards can provide spell-check.
voiceInputEnabled
boolean optional
Whether virtual keyboards can provide voice input.

chrome.virtualKeyboard.restrictFeatures(
  restrictions: FeatureRestrictions,
  callback?: function,
)

Promise

Sets restrictions on features provided by the virtual keyboard.

restrictions
FeatureRestrictions
the preferences to enabled/disabled virtual keyboard features.
callback
function optional
The callback parameter looks like: (update: FeatureRestrictions) => void
- update
  FeatureRestrictions
  Chrome 63+

Promise<FeatureRestrictions>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Table of contents