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
- AvailabilityChrome 58+ ChromeOS only
Summary
- Types
- Methods
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,
)
Sets restrictions on features provided by the virtual keyboard.
Parameters
- restrictions
the preferences to enabled/disabled virtual keyboard features.
- callback
function optional
The
callback
parameter looks like:(update: FeatureRestrictions) => void
- updateChrome 63+
Returns
Promise<FeatureRestrictions>
Chrome 96+Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility. You cannot use both on the same function call. The promise resolves with the same type that is passed to the callback.