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

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()

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

Sets restrictions on features provided by the virtual keyboard.

Parameters

  • the preferences to enabled/disabled virtual keyboard features.

  • callback

    function optional

    The callback parameter looks like:

    (update: FeatureRestrictions) => void

Returns

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-07 UTC.