chrome.accessibilityFeatures

Description: Use the chrome.accessibilityFeatures API to manage Chrome's accessibility features. This API relies on the ChromeSetting prototype of the type API for getting and setting individual accessibility features. In order to get feature states the extension must request accessibilityFeatures.read permission. For modifying feature state, the extension needs accessibilityFeatures.modify permission. Note that accessibilityFeatures.modify does not imply accessibilityFeatures.read permission.
Availability: Since Chrome 37.
Permissions: "accessibilityFeatures.read"

Important: This API works only on Chrome OS.

Summary

Properties
spokenFeedback
largeCursor
stickyKeys
highContrast
screenMagnifier
autoclick
virtualKeyboard
caretHighlight
cursorHighlight
focusHighlight
selectToSpeak
switchAccess
animationPolicy

Properties

object chrome.accessibilityFeatures.spokenFeedback

ChromeOS only.

Spoken feedback (text-to-speech). The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

spokenFeedback.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

spokenFeedback.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

spokenFeedback.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.largeCursor

ChromeOS only.

Enlarged cursor. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

largeCursor.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

largeCursor.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

largeCursor.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.stickyKeys

ChromeOS only.

Sticky modifier keys (like shift or alt). The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

stickyKeys.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

stickyKeys.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

stickyKeys.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.highContrast

ChromeOS only.

High contrast rendering mode. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

highContrast.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

highContrast.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

highContrast.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.screenMagnifier

ChromeOS only.

Full screen magnification. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

screenMagnifier.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

screenMagnifier.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

screenMagnifier.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.autoclick

ChromeOS only.

Auto mouse click after mouse stops moving. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

autoclick.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

autoclick.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

autoclick.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.virtualKeyboard

ChromeOS only.

Virtual on-screen keyboard. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

virtualKeyboard.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

virtualKeyboard.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

virtualKeyboard.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.caretHighlight

Since Chrome 51.

ChromeOS only.

Caret highlighting. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

caretHighlight.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

caretHighlight.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

caretHighlight.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.cursorHighlight

Since Chrome 51.

ChromeOS only.

Cursor highlighting. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

cursorHighlight.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

cursorHighlight.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

cursorHighlight.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.focusHighlight

Since Chrome 51.

ChromeOS only.

Focus highlighting. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

focusHighlight.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

focusHighlight.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

focusHighlight.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.selectToSpeak

Since Chrome 51.

ChromeOS only.

Select-to-speak. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

selectToSpeak.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

selectToSpeak.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

selectToSpeak.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.switchAccess

Since Chrome 51.

ChromeOS only.

Switch Access. The value indicates whether the feature is enabled or not. get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.

Functions

get

switchAccess.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

switchAccess.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

switchAccess.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};
object chrome.accessibilityFeatures.animationPolicy

Since Chrome 42.

get() requires accessibilityFeatures.read permission. set() and clear() require accessibilityFeatures.modify permission.
Functions

get

animationPolicy.get(object details, function callback)

Gets the value of a setting.

Parameters
object details

Which setting to consider.

boolean (optional) incognito

Whether to return the value that applies to the incognito session (default false).

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details

Details of the currently effective value.

any value

The value of the setting.

enum of "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", or "controlled_by_this_extension" levelOfControl

The level of control of the setting.

boolean (optional) incognitoSpecific

Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.

set

animationPolicy.set(object details, function callback)

Sets the value of a setting.

Parameters
object details

Which setting to change.

any value

The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular).

function (optional) callback

Called at the completion of the set operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

clear

animationPolicy.clear(object details, function callback)

Clears the setting, restoring any default value.

Parameters
object details

Which setting to clear.

enum of "regular", "regular_only", "incognito_persistent", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular).

function (optional) callback

Called at the completion of the clear operation.

If you specify the callback parameter, it should be a function that looks like this:

function() {...};