Interface ISuggestOptions

Configuration options for editor suggest widget

interface ISuggestOptions {
    filterGraceful?: boolean;
    insertMode?: "insert" | "replace";
    localityBonus?: boolean;
    matchOnWordStartOnly?: boolean;
    preview?: boolean;
    previewMode?: "prefix" | "subword" | "subwordSmart";
    selectionMode?: "always" | "never" | "whenTriggerCharacter" | "whenQuickSuggestion";
    shareSuggestSelections?: boolean;
    showClasses?: boolean;
    showColors?: boolean;
    showConstants?: boolean;
    showConstructors?: boolean;
    showDeprecated?: boolean;
    showEnumMembers?: boolean;
    showEnums?: boolean;
    showEvents?: boolean;
    showFields?: boolean;
    showFiles?: boolean;
    showFolders?: boolean;
    showFunctions?: boolean;
    showIcons?: boolean;
    showInlineDetails?: boolean;
    showInterfaces?: boolean;
    showIssues?: boolean;
    showKeywords?: boolean;
    showMethods?: boolean;
    showModules?: boolean;
    showOperators?: boolean;
    showProperties?: boolean;
    showReferences?: boolean;
    showSnippets?: boolean;
    showStatusBar?: boolean;
    showStructs?: boolean;
    showTypeParameters?: boolean;
    showUnits?: boolean;
    showUsers?: boolean;
    showValues?: boolean;
    showVariables?: boolean;
    showWords?: boolean;
    snippetsPreventQuickSuggestions?: boolean;
}

Properties

filterGraceful? insertMode? localityBonus? matchOnWordStartOnly? preview? previewMode? selectionMode? shareSuggestSelections? showClasses? showColors? showConstants? showConstructors? showDeprecated? showEnumMembers? showEnums? showEvents? showFields? showFiles? showFolders? showFunctions? showIcons? showInlineDetails? showInterfaces? showIssues? showKeywords? showMethods? showModules? showOperators? showProperties? showReferences? showSnippets? showStatusBar? showStructs? showTypeParameters? showUnits? showUsers? showValues? showVariables? showWords? snippetsPreventQuickSuggestions?

Properties

Optional filterGraceful

filterGraceful?: boolean

Enable graceful matching. Defaults to true.

Optional insertMode

insertMode?: "insert" | "replace"

Overwrite word ends on accept. Default to false.

Optional localityBonus

localityBonus?: boolean

Favors words that appear close to the cursor.

Optional matchOnWordStartOnly

matchOnWordStartOnly?: boolean

Controls whether suggestions allow matches in the middle of the word instead of only at the beginning

Optional preview

preview?: boolean

Enable or disable the rendering of the suggestion preview.

Optional previewMode

previewMode?: "prefix" | "subword" | "subwordSmart"

Configures the mode of the preview.

Optional selectionMode

selectionMode?: "always" | "never" | "whenTriggerCharacter" | "whenQuickSuggestion"

Select suggestions when triggered via quick suggest or trigger characters

Optional shareSuggestSelections

shareSuggestSelections?: boolean

Enable using global storage for remembering suggestions.

Optional showClasses

showClasses?: boolean

Show class-suggestions.

Optional showColors

showColors?: boolean

Show color-suggestions.

Optional showConstants

showConstants?: boolean

Show constant-suggestions.

Optional showConstructors

showConstructors?: boolean

Show constructor-suggestions.

Optional showDeprecated

showDeprecated?: boolean

Show deprecated-suggestions.

Optional showEnumMembers

showEnumMembers?: boolean

Show enumMember-suggestions.

Optional showEnums

showEnums?: boolean

Show enum-suggestions.

Optional showEvents

showEvents?: boolean

Show event-suggestions.

Optional showFields

showFields?: boolean

Show field-suggestions.

Optional showFiles

showFiles?: boolean

Show file-suggestions.

Optional showFolders

showFolders?: boolean

Show folder-suggestions.

Optional showFunctions

showFunctions?: boolean

Show function-suggestions.

Optional showIcons

showIcons?: boolean

Enable or disable icons in suggestions. Defaults to true.

Optional showInlineDetails

showInlineDetails?: boolean

Show details inline with the label. Defaults to true.

Optional showInterfaces

showInterfaces?: boolean

Show interface-suggestions.

Optional showIssues

showIssues?: boolean

Show issue-suggestions.

Optional showKeywords

showKeywords?: boolean

Show keyword-suggestions.

Optional showMethods

showMethods?: boolean

Show method-suggestions.

Optional showModules

showModules?: boolean

Show module-suggestions.

Optional showOperators

showOperators?: boolean

Show operator-suggestions.

Optional showProperties

showProperties?: boolean

Show property-suggestions.

Optional showReferences

showReferences?: boolean

Show reference-suggestions.

Optional showSnippets

showSnippets?: boolean

Show snippet-suggestions.

Optional showStatusBar

showStatusBar?: boolean

Enable or disable the suggest status bar.

Optional showStructs

showStructs?: boolean

Show struct-suggestions.

Optional showTypeParameters

showTypeParameters?: boolean

Show typeParameter-suggestions.

Optional showUnits

showUnits?: boolean

Show unit-suggestions.

Optional showUsers

showUsers?: boolean

Show user-suggestions.

Optional showValues

showValues?: boolean

Show value-suggestions.

Optional showVariables

showVariables?: boolean

Show variable-suggestions.

Optional showWords

showWords?: boolean

Show text-suggestions.

Optional snippetsPreventQuickSuggestions

snippetsPreventQuickSuggestions?: boolean

Prevent quick suggestions when a snippet is active. Defaults to true.

Settings

Member Visibility

Theme

On This Page

filterGracefulinsertModelocalityBonusmatchOnWordStartOnlypreviewpreviewModeselectionModeshareSuggestSelectionsshowClassesshowColorsshowConstantsshowConstructorsshowDeprecatedshowEnumMembersshowEnumsshowEventsshowFieldsshowFilesshowFoldersshowFunctionsshowIconsshowInlineDetailsshowInterfacesshowIssuesshowKeywordsshowMethodsshowModulesshowOperatorsshowPropertiesshowReferencesshowSnippetsshowStatusBarshowStructsshowTypeParametersshowUnitsshowUsersshowValuesshowVariablesshowWordssnippetsPreventQuickSuggestions