Completions

Version:

Usage🔗

By default, Sublime Text will automatically show the completions popup when a user is editing source code or markup, but not within prose in comments, strings or markups.

Pressing the Esc key will hide the completions popup. To manually show the completions popup, press Ctrl+Space. If no completions are available, the message No available completions will be displayed in the status bar.

Customization🔗

There exist a number of ways in which the engine can be augmented with new completions:

• Completion Files

• Snippets

• Plugins

{
    "scope": "source.python",
    "completions": [
        "def",
        "class",
        "None",
        "True",
        "False"
    ]
}

{
    "scope": "source.python",
    "completions": [
        {
            "trigger": "def",
            "contents": "def",
            "kind": "keyword"
        },
        {
            "trigger": "fun",
            "annotation": "basic function",
            "contents": "def ${1:name}($2):\n    $0\n",
            "kind": "snippet",
            "details": "A simple, non-<code>async</code> function definition"
        }
    ]
}

<snippet>
    <scope>source.python</scope>
    <tabTrigger>fun</tabTrigger>
    <content><![CDATA[def ${1:name}($2):
    ${0:pass}]]></content>
    <description>function, non-async</description>
</snippet>

Name: $1
Email: $2
Description: $0

Name: ${1:first} ${2:last}
Email: ${3:user}@${4:example.com}

Name: ${1:first} ${2:last}
Email: ${3:$1}@${4:example.com}

Name: ${1:name}
Email: ${2:${1/\s.*//}}@${3:example.com}

import sublime
import sublime_plugin


class MyCompletions(sublime_plugin.EventListener):
    def on_query_completions(self, view, prefix, locations):
        if not view.match_selector(locations[0], "source.python"):
            return []

        available_completions = [
            "def",
            "class",
            "None",
            "True",
            "False"
        ]

        prefix = prefix.lower()

        out = []
        for comp in available_completions:
            if comp.lower().startswith(prefix):
                out.append(comp)

        return out

Settings🔗

"tab_completion" boolean🔗

When enabled, pressing Tab will insert the best matching completion. When disabled, Tab will only trigger snippets or insert a tab character. Shift+Tab can be used to insert an explicit tab when tab_completion is enabled.

Disabling this setting will not implicitly disable auto_complete.

"auto_complete" boolean🔗

Automatically show the completions popup when typing.

This behavior is not influenced by the setting tab_completion.

"auto_complete_size_limit" integer🔗

If the file size in bytes of the current file is larger than this, the completions popup will not be automatically shown.

"auto_complete_delay" integer🔗

The number of milliseconds to wait before showing the completions popup automatically.

"auto_complete_selector" string🔗

A selector to limit when the completions popup will be automatically shown.

Example: "meta.tag, source - comment - string.quoted.double.block - string.quoted.single.block - string.unquoted.heredoc"

The "auto_complete_triggers" setting may be used to re-enable the automatic completions popup in specific situations.

"auto_complete_triggers" array of objects🔗

Provides explicit triggers for when to automatically show the completions popup.

Each object must contain the keys "selector" with a string value containing a selector to match the caret position against, and a "characters" key with a string value specifying what characters must be present to the left of the caret.

Example:

[
    {
        "selector": "text.html",
        "characters": "<"
    }
]

Triggers will override the setting auto_complete_selector.

"auto_complete_commit_on_tab" boolean🔗

By default, auto complete will commit the current completion on Enter. This setting can be used to make it complete on Tab instead.

Completing on Tab is generally a superior option, as it removes ambiguity between committing the completion and inserting a newline.

"auto_complete_with_fields" boolean🔗

Controls if the completions popup is automatically shown when snippet fields are active. Only relevant if auto_complete_commit_on_tab is enabled.

"auto_complete_cycle" boolean🔗

Controls what happens when pressing ⬆ while the first item in the completions popup is selected: if false, the popup is hidden, otherwise the last completion in the popup is selected.

Also causes the first completion to be selected when ⬇ is pressed on the last completion.

"auto_complete_use_history" boolean🔗

If previously-selected completions should be automatically selected.

"auto_complete_include_snippets_when_typing" boolean🔗

.. since:: 4052

When this is set to false, snippets won‘t be present in the completions popup when it is automatically triggered. They will be shown if it is manually triggered.