LineHasWarning

Plays a signal - sound (audio cue) and/or announcement (alert) - when the active line has a warning.

{
  "accessibility.signals.lineHasWarning": {
    "sound": "auto",
    "announcement": "auto"
  } // default
}

Type

object

Default

{
  "sound": "auto",
  "announcement": "auto"
}

Object Properties

KeyTypeDefaultRangeDescription
"sound"string"auto""auto", "off", "on"Plays a sound when the active line has a warning.
"announcement"string"auto""auto", "off"Announces when the active line has a warning.

BUG: Intellisense says default is off but is actually auto for announcement.

Description

Controls if sound and announcement signals are played when an Editor line that has an error gains focus.

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 "editor.accessibilitySettings": "on". When set to "off", the sound signal will never play even when a screen reader is detected or "editor.accessibiltySupport": "on". When set to "on", the sound signal will always play even when a screen reader is not detected or "editor.accessibilitySupport": "off".

When "announcement" is set to "auto", the screen reader will make the 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.