Class HistoryInlineCompletionProvider

An example inline completion provider using history to populate suggestions.

Hierarchy

  • HistoryInlineCompletionProvider

Implements

Constructors

Properties

Accessors

Methods

Constructors

Properties

_maxSuggestions: any
_trans: any
identifier: "@jupyterlab/inline-completer:history" = "@jupyterlab/inline-completer:history"

Unique identifier, cannot change on runtime.

The identifier is also added on data attribute of ghost text widget, allowing different providers to style the ghost text differently.

Accessors

  • get name(): string
  • Name of the provider to be displayed in the user interface.

    Returns string

Methods

  • Optional method called when user changes settings.

    This is only called if schema for settings is present.

    Parameters

    • settings: {
          maxSuggestions: number;
      }
      • maxSuggestions: number

    Returns void

  • The method called when user requests inline completions.

    The implicit request (on typing) vs explicit invocation are distinguished by the value of triggerKind in the provided context.

    Parameters

    Returns Promise<{
        items: {
            insertText: string;
        }[];
    }>

Generated using TypeDoc