Format

Plays a signal - sound (audio cue) and/or announcement (alert) - when a file or notebook is formatted.

{
  "accessibility.signals.format": {
    "sound": "never",
    "announcement": "never"
  } // default
}

Type

object

Default

{
  "sound": "never",
  "announcement": "never"
}

Object Properties

Description

Controls if sound and announcement signals are played when a file (or Notebook) is formatted.

When sound is set to always, the sound signal will play whenever a file is formatted, whether by executing the Format Document command, saving a file with "editor.formatOnSave": true, pasting with "editor.formatOnPaste": true, or when the document is formatted by any other means whatsoever. When set to never, the sound signal will never play even when a screen reader is detected or when "editor.accessibilitySupport": "on". When set to userGesture, the sound signal will only play when the user explicitly formats the document by executing the Format Document command and a screen reader is detected or "editor.accessibilitySupport": "on".

When announcement is set to always, the screen reader will make the announcement whenever a file is formatted, whether by executing the Format Document command, saving a file with "editor.formatOnSave": true, pasting with "editor.formatOnPaste": true, or when the document is formatted by any other means whatsoever and a screen reader is detected. When set to never, the screen reader will never make the announcement. When set to userGesture, the detected screen reader will only make the announcement when the user explicity formats the document by executing the Format Document command.