LineHasError
Plays a signal - sound (audio cue) and/or announcement (alert) - when the active line has an error.
{
"accessibility.signals.lineHasError": {
"sound": "auto",
"announcement": "auto"
} // default
}
Type
object
Default
{
"sound": "auto",
"announcement": "auto"
}
Object Properties
Key | Type | Default | Range | Description |
---|---|---|---|---|
"sound" | string | "auto" , "off" , "on" | Plays a sound when the active line has an error. | |
"announcement" | string | "auto" , "off" | Announces when the active line has an error. |
Description
Controls if sound and announcement signals are played whenever a line that has an error is focused.
When "sound"
is set to "auto"
, the sound signal will play whenever a line that has an error is focused and a screen reader is detected or when "editor.accessibilitySupport": "on"
. When set to "off"
, the sound signal will never play even when a screen reader is detected or when "editor.accessibilitySupport": "on"
. When set to "on"
, the sound signal will always play even when no screen reader is detected and "editor.accessibilitySupport": "on"
.
When "announcement"
is set to "auto"
, the screen reader will make an announcement whenever a line that has an error is focused and a screen reader is detected. When set to "off"
, the screen reader will never make the announcement even when a screen reader is detected.