Gathering detailed insights and metrics for @algolia/autocomplete-core
Gathering detailed insights and metrics for @algolia/autocomplete-core
🔮 Fast and full-featured autocomplete library
Installations
npm install @algolia/autocomplete-coreScore
59.7
Supply Chain
73.7
Quality
94.7
Maintenance
100
Vulnerability
100
License
Developer
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
NPM Version
Statistics
5,060 Stars
2,426 Commits
331 Forks
108 Watching
32 Branches
385 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (95.6%)
SCSS (2.88%)
JavaScript (1.52%)
Total Downloads
Cumulative downloads
Total Downloads
63,299,394
Last day
-0.9%
124,331
Compared to previous day
Last week
3.2%
732,017
Compared to previous week
Last month
8.1%
3,125,844
Compared to previous month
Last year
63%
31,558,785
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
A JavaScript library that lets you quickly build autocomplete experiences
All you need to get started is:
- A container to inject the experience into
- Data to fill the autocomplete with
- Any Virtual DOM solution (JavaScript, Preact, React, Vue, etc.)
The data that populates the autocomplete results are called sources. You can use whatever you want in your sources: a static set of searches terms, search results from an external source like an Algolia index, recent searches, and more.
By configuring just those two required parameters (container and getSources) you can have an interactive autocomplete experience. The library creates an input and provides the interactivity and accessibility attributes, but you're in full control of the DOM elements to output.
Documentation •
API •
Playground
Installation
The recommended way to get started is with the autocomplete-js package. It includes everything you need to render a JavaScript autocomplete experience.
Otherwise, you can install the autocomplete-core package if you want to build a renderer from scratch.
All Autocomplete packages are available on the npm registry.
1yarn add @algolia/autocomplete-js 2# or 3npm install @algolia/autocomplete-js
If you don't use a package manager, you can use the HTML script element:
1<script src="https://cdn.jsdelivr.net/npm/@algolia/autocomplete-js"></script> 2<script> 3 const { autocomplete } = window['@algolia/autocomplete-js']; 4</script>
Usage
To get started, you need a container for your autocomplete to go in. If you don't have one already, you can insert one into your markup:
1<div id="autocomplete"></div>
Then, insert your autocomplete into it by calling the autocomplete function and providing the container. It can be a CSS selector or an Element.
Make sure to provide a container (e.g., a div), not an input. Autocomplete generates a fully accessible search box for you.
1import { autocomplete } from '@algolia/autocomplete-js'; 2 3autocomplete({ 4 container: '#autocomplete', 5 // ... 6});
Continue reading our Getting Started guide.
Documentation
The documentation offers a few ways to learn about the Autocomplete library:
- Read the Core Concepts to learn more about underlying principles, like Sources and State.
- Follow the Guides to understand how to build common UX patterns.
- Refer to API reference for a comprehensive list of parameters and options.
- Try out the Playground where you can fork a basic implementation and play around.
You can find more on the documentation.
Support
Packages
| Package | Description | Documentation |
|---|---|---|
autocomplete-js | JavaScript package for Autocomplete | Documentation |
autocomplete-core | JavaScript core primitives to build an autocomplete experience | Documentation |
autocomplete-plugin-recent-searches | A plugin to add recent searches to Autocomplete | Documentation |
autocomplete-plugin-query-suggestions | A plugin to add query suggestions to Autocomplete | Documentation |
autocomplete-plugin-algolia-insights | A plugin to add Algolia Insights to Autocomplete | Documentation |
autocomplete-plugin-redirect-url | A plugin to enable redirect URLs | Documentation |
autocomplete-plugin-tags | A plugin to manage and display a list of tags in Autocomplete | Documentation |
autocomplete-preset-algolia | Presets to use Algolia features with Autocomplete | Documentation |
autocomplete-theme-classic | Classic theme for Autocomplete | Documentation |
Showcase
See the awesome experiences people built with Autocomplete:
 |  |
|---|---|
Find more in our Showcase.
Sandboxes
Check out sandboxes using Autocomplete.
License
No vulnerabilities found.
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
no binaries found in the repo
Reason
Found 28/30 approved changesets -- score normalized to 9
Reason
7 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 6
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 28 are checked with a SAST tool
Reason
46 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-hpx4-r86g-5jrg
- Warn: Project is vulnerable to: GHSA-prr3-c3m5-p7q2
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-c2jc-4fpr-4vhg
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
- Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-7hpj-7hhx-2fgx
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-mv48-hcvh-8jj8
- Warn: Project is vulnerable to: GHSA-353f-5xf4-qw67
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-c24v-8rfc-w8vw
- Warn: Project is vulnerable to: GHSA-8jhw-289h-jh2g
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
4.2
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More