Socket
Socket
Sign inDemoInstall

@codemirror/autocomplete

Package Overview
Dependencies
8
Maintainers
2
Versions
74
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @codemirror/autocomplete

Autocompletion for the CodeMirror code editor


Version published
Maintainers
2
Created

Package description

What is @codemirror/autocomplete?

The @codemirror/autocomplete package is a module for the CodeMirror code editor that provides autocompletion functionality. It can be used to suggest, complete, or hint at possible code snippets, variables, or other elements to users as they type, enhancing the coding experience by making it faster and reducing errors.

What are @codemirror/autocomplete's main functionalities?

Autocompletion

Enables autocompletion in the CodeMirror editor. As the user types, suggestions are displayed in a dropdown, allowing for quick insertion of code snippets.

import { autocompletion } from '@codemirror/autocomplete';

// To enable autocompletion in a CodeMirror editor
new EditorView({
  extensions: [autocompletion()],
  parent: document.body
});

Customizable Completion Source

Allows developers to provide a custom source for completions, enabling the suggestion of context-specific code snippets or keywords.

import { autocompletion, CompletionSource } from '@codemirror/autocomplete';

const myCompletionSource: CompletionSource = (context) => {
  // Custom logic to provide completions
  return [{ label: 'mySnippet', type: 'keyword' }];
};

// To use the custom completion source
new EditorView({
  extensions: [autocompletion({ override: [myCompletionSource] })],
  parent: document.body
});

Asynchronous Completion

Supports asynchronous computation of completions, allowing for the integration of dynamic data sources or external APIs for suggestions.

import { autocompletion, CompletionResult } from '@codemirror/autocomplete';

const asyncCompletionSource = async (context): Promise<CompletionResult> => {
  // Fetch or compute completions asynchronously
  return { from: context.pos, options: [{ label: 'asyncSnippet', type: 'function' }] };
};

// To use asynchronous completions
new EditorView({
  extensions: [autocompletion({ override: [asyncCompletionSource] })],
  parent: document.body
});

Other packages similar to @codemirror/autocomplete

Changelog

Source

6.3.4 (2022-11-24)

Bug fixes

Fix an issue where completion lists could end up being higher than the tooltip they were in.

Readme

Source

@codemirror/autocomplete NPM version

[ WEBSITE | DOCS | ISSUES | FORUM | CHANGELOG ]

This package implements autocompletion for the CodeMirror code editor.

The project page has more information, a number of examples and the documentation.

This code is released under an MIT license.

We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.

Keywords

FAQs

Last updated on 24 Nov 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc