This page is part of the documentation for the Chrome Apps platform, which was deprecated in 2020. It remains supported for Enterprise and Education customers on ChromeOS until at least Jan 2025. Learn more about migrating your app.

chrome.virtualKeyboard

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

Types

FeatureRestrictions

Properties

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.

Methods

restrictFeatures()

Promise

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

Sets restrictions on features provided by the virtual keyboard.

Parameters

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+

Returns

Promise<FeatureRestrictions>

Chrome 96+

Promises are only supported for Manifest V3 and later, other platforms need to use callbacks.