SettingsState​

Properties​

addQueryDepthLimit​

addQueryDepthLimit:number

Specifies how deep the 'Add query' functionality should go. You can specify any valid positive integer.

alert.disableUpdateNotification?​

optionalalert.disableUpdateNotification:boolean

Disable update notification

alert.disableWarnings?​

optionalalert.disableWarnings:boolean

Disable warning alerts

banners.disable?​

optionalbanners.disable:boolean

Disable banners

beta.disable.newEditor?​

optionalbeta.disable.newEditor:boolean

Disable new editor beta

beta.disable.newScript?​

optionalbeta.disable.newScript:boolean

Disable new script beta

disableLineNumbers?​

optionaldisableLineNumbers:boolean

Disable line numbers

disablePushNotification?​

optionaldisablePushNotification:boolean

Specifies if native push notifications should be disabled

Default​

false

doc.hideDeprecatedItems?​

optionaldoc.hideDeprecatedItems:boolean

Hides deprecated Doc items

editor.shortcuts?​

optionaleditor.shortcuts:Record<string,string>

Contains shortcut to action mapping

enableExperimental?​

optionalenableExperimental:boolean

Enable experimental features. Note: The features might be unstable

Default​

false

enableTablistScrollbar?​

optionalenableTablistScrollbar:boolean

Enable the scrollbar in the tab list

historyDepth?​

optionalhistoryDepth:number

Number of items allowed in history pane

introspection.options.description?​

optionalintrospection.options.description:boolean

Whether to include descriptions in the introspection result

introspection.options.directiveIsRepeatable?​

optionalintrospection.options.directiveIsRepeatable:boolean

Whether to includeisRepeatable flag on directives

introspection.options.inputValueDeprecation?​

optionalintrospection.options.inputValueDeprecation:boolean

Whether target GraphQL server supports deprecation of input values

introspection.options.schemaDescription?​

optionalintrospection.options.schemaDescription:boolean

Whether to includedescription field on schema

introspection.options.specifiedByUrl?​

optionalintrospection.options.specifiedByUrl:boolean

Whether to includespecifiedByUrl in the introspection result

language​

language:"en-US" |"fr-FR" |"es-ES" |"cs-CZ" |"de-DE" |"pt-BR" |"ru-RU" |"uk-UA" |"zh-CN" |"ja-JP" |"sr-SP" |"it-IT" |"pl-PL" |"ko-KR" |"ro-RO" |"vi-VN"

Specifies the language

plugin.list?​

optionalplugin.list:string[]

Specifies a list of enabled plugins.

Plugins are specified in a string format<plugin-source>:<plugin-name>@<version>::[<opt>]->[<opt-value>]:

• <plugin-source>: The source of the plugin. Can be 'npm', 'url' or 'github'
• <plugin-name> (required): The name of the plugin. Plugin names must begin withaltair-graphql-plugin-
• <version>: The version of the plugin. If not specified, the latest version will be used
• [<opt>]->[<opt-value>]: Additional configuration for the plugin. This is used when you specify the source as 'url'. In this case, you can specify the URL where the plugin is hosted.

Example​

['altair-graphql-plugin-some-plugin','npm:altair-graphql-plugin-some-plugin','npm:[email protected]','url:[email protected]::[url]->[http://example.com/some-plugin]']

Default​

[]

request.withCredentials?​

optionalrequest.withCredentials:boolean

Send requests with credentials (cookies)

response.hideExtensions?​

optionalresponse.hideExtensions:boolean

Hides extensions object

response.stream.strategy?​

optionalresponse.stream.strategy:MultiResponseStrategy

Determine the handling strategy for multiple responses

schema.reload.onEnvChange?​

optionalschema.reload.onEnvChange:boolean

Reload schema when switching environments

schema.reloadOnStart?​

optionalschema.reloadOnStart:boolean

Reload schema on app start

script.allowedCookies?​

optionalscript.allowedCookies:string[]

List of cookies to be accessible in the pre-request script

Example​

['cookie1','cookie2']

Default​

[]

tabSize​

tabSize:number

Specifies the tab size for the editor

theme​

theme:string

Specifies the theme. Themes available by default are 'light', 'dark', 'system', 'dracula'. Additional themes can be added via plugins.

Default​

'system'

theme.dark?​

optionaltheme.dark:string

Specifies the theme for dark mode

theme.editorFontFamily?​

optionaltheme.editorFontFamily:string

Specifies the font family for the editors. Any valid CSS font family combination can be used here

theme.editorFontSize?​

optionaltheme.editorFontSize:number

Specifies the font size for the editors

theme.fontsize?​

optionaltheme.fontsize:number

Specifies the base font size

Default​

24

themeConfig?​

optionalthemeConfig:RecursivePartial<ITheme>

Specify custom theme config to override the specified theme values

themeConfig.dark?​

optionalthemeConfig.dark:RecursivePartial<ITheme>

Theme config object for dark mode