PositionHasWarning

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

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

Type

object

Default

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

Object Properties

Description

Controls if sound and announcement signals are played when an Editor column that has a warning, or either of its adjacent columns, gains focus.

When "sound" is set to "auto", the sound signal will play whenever an Editor column that has a warning, or either of its adjacent columns, gains focus and a screen reader is detected or "editor.accessibilitySupport": "on". When set to "off", the sound signal will never play even when a screen reader is detected or "editor.accessibilitySuport": "on". When set to "on", the sound signal will always play even when a screen reader is not detected or "editor.accessibiltySupport": "off".

When "announcement" is set to "auto", the screen reader will make the announcement whenever an Editor column that has a warning, or either of its adjacent columns, gains focus and a screen reader is detected. When set to "off", the screen reader will never make an announcement even when a screen reader is detected.

BUGS

1. Intellisense says default is "on". Should say "auto".
2. "on" is not a valid value for announcements since it suggests that a screen reader would make announcements even if one is not detected.