Ace API Reference
    Preparing search index...

    Interface Completer

    interface Completer {
        hideInlinePreview?: boolean;
        id?: string;
        identifierRegexps?: RegExp[];
        insertMatch?: (editor: Editor, data: Completion) => void;
        onInsert?: (editor: Editor, completion: Completion) => void;
        onSeen?: (editor: Editor, completion: Completion) => void;
        triggerCharacters?: string[];
        cancel(): void;
        getCompletions(
            editor: Editor,
            session: EditSession,
            position: Ace.Point,
            prefix: string,
            callback: CompleterCallback,
        ): void;
        getDocTooltip(item: Completion): string | void | Completion;
    }
    Index

    Properties

    hideInlinePreview? id? identifierRegexps? insertMatch? onInsert? onSeen? triggerCharacters?

    Methods

    cancel? getCompletions getDocTooltip?

    Properties

    hideInlinePreview?: boolean

    Whether to hide inline preview text

    id?: string

    Unique identifier for this completer

    identifierRegexps?: RegExp[]

    Regular expressions defining valid identifier characters for completion triggers

    insertMatch?: (editor: Editor, data: Completion) => void

    Custom insertion handler for completion items

    onInsert?: (editor: Editor, completion: Completion) => void

    Called when a completion item is inserted

    onSeen?: (editor: Editor, completion: Completion) => void

    Called when a completion item becomes visible

    triggerCharacters?: string[]

    Characters that trigger autocompletion when typed

    Methods

    • Cleanup method called when completion is cancelled

      Returns void

    • Returns documentation tooltip for a completion item

      Parameters

      • item: Completion

      Returns string | void | Completion

    Settings

    Member Visibility

    On This Page

    Properties
    Methods