1 | # autoComplete.js :sparkles:
|
2 |
|
3 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
|
4 | [![GitHub package.json version](https://img.shields.io/github/package-json/v/TarekRaafat/autoComplete.js)](https://badge.fury.io/gh/tarekraafat%2FautoComplete.js)
|
5 | [![npm](https://img.shields.io/npm/v/@tarekraafat/autocomplete.js)](https://badge.fury.io/js/%40tarekraafat%2Fautocomplete.js)
|
6 | ![GitHub top language](https://img.shields.io/github/languages/top/TarekRaafat/autoComplete.js?color=yellow)
|
7 | ![\[Zero Dependencies\]()](https://img.shields.io/badge/Dependencies-0-blue.svg)
|
8 | ![\[Size\]()](https://img.shields.io/badge/Size-10%20KB-green.svg)
|
9 | ![Maintained](https://img.shields.io/badge/Maintained%3F-yes-success)
|
10 | [![](https://data.jsdelivr.com/v1/package/npm/@tarekraafat/autocomplete.js/badge)](https://www.jsdelivr.com/package/npm/@tarekraafat/autocomplete.js)
|
11 | ![npm](https://img.shields.io/npm/dm/@tarekraafat/autocomplete.js?label=npm)
|
12 | [![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/TarekRaafat/autoComplete.js)
|
13 |
|
14 | <br>
|
15 | <br>
|
16 | <p align="center">
|
17 | <a href="https://tarekraafat.github.io/autoComplete.js/">
|
18 | <img src="./docs/img/autoComplete.js.png" alt="autoComplete.js Design" width="50%">
|
19 | </a>
|
20 | </p>
|
21 | <br>
|
22 | <br>
|
23 |
|
24 | > Simple autocomplete pure vanilla Javascript library. <a href="https://tarekraafat.github.io/autoComplete.js/demo/" target="\_blank">:rocket: Live Demo</a> **v9.0**
|
25 |
|
26 | autoComplete.js is a simple pure vanilla Javascript library that's progressively designed for speed, high versatility and seamless integration with a wide range of projects & systems, made for users and developers in mind.
|
27 |
|
28 | ## Features
|
29 |
|
30 | - Pure Vanilla Javascript
|
31 | - Zero Dependencies
|
32 | - Simple & Easy to use
|
33 | - Extremely Lightweight
|
34 | - Blazing Fast
|
35 | - Versatile
|
36 | - Hackable & highly customizable
|
37 |
|
38 | ## [![autoComplete.js Code Example](./docs/img/autoComplete.init.png "autoComplete.js Code Example")](https://codepen.io/tarekraafat/pen/rQopdW?editors=0010)
|
39 |
|
40 | ## Get Started
|
41 |
|
42 | ### Clone:
|
43 |
|
44 | - Clone autoComplete.js to your local machine
|
45 |
|
46 | ```shell
|
47 | git clone https://github.com/TarekRaafat/autoComplete.js.git
|
48 | ```
|
49 |
|
50 | ### Installation:
|
51 |
|
52 | - <a href="https://www.jsdelivr.com/package/gh/TarekRaafat/autoComplete.js"><img src="https://www.jsdelivr.com/img/logo@2x.png" alt="jsDelivr" width="100px"></a> CDN
|
53 |
|
54 | `CSS`
|
55 |
|
56 | ```html
|
57 | <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tarekraafat/autocomplete.js@9.0.0/dist/css/autoComplete.min.css">
|
58 | ```
|
59 |
|
60 | `JS`
|
61 |
|
62 | ```html
|
63 | <script src="https://cdn.jsdelivr.net/npm/@tarekraafat/autocomplete.js@9.0.0/dist/js/autoComplete.min.js"></script>
|
64 | ```
|
65 |
|
66 | - <a href="https://www.npmjs.com/package/@tarekraafat/autocomplete.js">npm</a> install `(Node Package Manager)`
|
67 |
|
68 | ```shell
|
69 | npm i @tarekraafat/autocomplete.js
|
70 | ```
|
71 |
|
72 | - <a href="https://yarn.pm/@tarekraafat/autocomplete.js">Yarn</a> install `(Javascript Package Manager)`
|
73 |
|
74 | ```shell
|
75 | yarn add @tarekraafat/autocomplete.js
|
76 | ```
|
77 |
|
78 |
|
79 |
|
80 | ## Documentation:
|
81 |
|
82 | - For more details check out **autoComplete.js** <a href="https://tarekraafat.github.io/autoComplete.js/">**docs** :notebook_with_decorative_cover:</a>
|
83 |
|
84 |
|
85 |
|
86 | ## Third-Party Plugins:
|
87 |
|
88 | - [Contao autoComplete.js Bundle](https://github.com/heimrichhannot/contao-autocompletejs-bundle) by [@heimrichhannot](https://github.com/heimrichhannot)
|
89 |
|
90 | * * *
|
91 |
|
92 | ## Support
|
93 |
|
94 | For general questions about autoComplete.js, tweet at [@TarekRaafat].
|
95 |
|
96 | For technical questions, you should post a question on [Stack Overflow] and tag
|
97 | it with [autoComplete.js][so tag].
|
98 |
|
99 |
|
100 |
|
101 | [stack overflow]: https://stackoverflow.com/
|
102 |
|
103 | [@tarekraafat]: https://twitter.com/TarekRaafat
|
104 |
|
105 | [so tag]: https://stackoverflow.com/questions/tagged/autoComplete.js
|
106 |
|
107 | * * *
|
108 |
|
109 | ## Author
|
110 |
|
111 | **Tarek Raafat**
|
112 |
|
113 | - Email: tarek.m.raafat@gmail.com
|
114 | - Website: <http://www.tarekraafat.com/>
|
115 | - Github: <https://github.com/TarekRaafat/>
|
116 |
|
117 | Distributed under the Apache 2.0 license. See `Apache 2.0` for more information.
|
118 |
|
119 | * * *
|
120 |
|
121 | ## License
|
122 |
|
123 | Apache 2.0 © [Tarek Raafat](http://www.tarekraafat.com)
|