Skip to content

SettingsState

Properties

addQueryDepthLimit

addQueryDepthLimit: number

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


alert.disableUpdateNotification?

optional alert.disableUpdateNotification: boolean

Disable update notification


alert.disableWarnings?

optional alert.disableWarnings: boolean

Disable warning alerts


beta.disable.newEditor?

optional beta.disable.newEditor: boolean

Disable new editor beta


beta.disable.newScript?

optional beta.disable.newScript: boolean

Disable new script beta


disableLineNumbers?

optional disableLineNumbers: boolean

Disable line numbers


disablePushNotification?

optional disablePushNotification: boolean

Specifies if native push notifications should be disabled

Default

ts
false

editor.shortcuts?

optional editor.shortcuts: Record<string, string>

Contains shortcut to action mapping


enableExperimental?

optional enableExperimental: boolean

Enable experimental features. Note: The features might be unstable

Default

ts
false

enableTablistScrollbar?

optional enableTablistScrollbar: boolean

Enable the scrollbar in the tab list


historyDepth?

optional historyDepth: number

Number of items allowed in history pane


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?

optional plugin.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 with altair-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

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

Default

ts
[]

request.withCredentials?

optional request.withCredentials: boolean

Send requests with credentials (cookies)


response.hideExtensions?

optional response.hideExtensions: boolean

Hides extensions object


response.stream.strategy?

optional response.stream.strategy: MultiResponseStrategy

Determine the handling strategy for multiple responses


schema.reloadOnStart?

optional schema.reloadOnStart: boolean

Reload schema on app start


script.allowedCookies?

optional script.allowedCookies: string[]

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

Example

ts
['cookie1', 'cookie2']

Default

ts
[]

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

ts
'system'

theme.dark?

optional theme.dark: string

Specifies the theme for dark mode


theme.editorFontFamily?

optional theme.editorFontFamily: string

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


theme.editorFontSize?

optional theme.editorFontSize: number

Specifies the font size for the editors


theme.fontsize?

optional theme.fontsize: number

Specifies the base font size

Default

ts
24

themeConfig?

optional themeConfig: RecursivePartial<ITheme>

Specify custom theme config to override the specified theme values


themeConfig.dark?

optional themeConfig.dark: RecursivePartial<ITheme>

Theme config object for dark mode