Skip to content

Commit

Permalink
Version 7.0.2 => Release History for details
Browse files Browse the repository at this point in the history
  • Loading branch information
TarekRaafat committed Sep 25, 2019
1 parent 984b7bd commit 8c32656
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ git clone https://github.com/TarekRaafat/autoComplete.js.git
`CSS`

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].1/dist/css/autoComplete.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].2/dist/css/autoComplete.min.css">
```

`JS`

```html
<script src="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].1/dist/js/autoComplete.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].2/dist/js/autoComplete.min.js"></script>
```

- <a href="https://www.npmjs.com/package/@tarekraafat/autocomplete.js">npm</a> install `(Node Package Manager)`
Expand Down
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,13 @@ npm run build
`CSS`

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].1/dist/css/autoComplete.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].2/dist/css/autoComplete.min.css">
```

`JS`

```html
<script src="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].1/dist/js/autoComplete.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].2/dist/js/autoComplete.min.js"></script>
```

- <img src="./img/logos/html_logo.png" alt="HTML Logo" width="40px"> HTML Local load
Expand Down Expand Up @@ -121,7 +121,7 @@ const autoComplete = require("@tarekraafat/autocomplete.js/dist/js/autoComplete"
```html
<link rel="stylesheet" href="./css/autoComplete.css">
OR
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].1/dist/css/autoComplete.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].2/dist/css/autoComplete.min.css">
```

2. Assign the default `id` value `"autoComplete"` to the desired input field or use any custom `id/class` and configure the API selector accordingly in `Step 4`
Expand All @@ -136,7 +136,7 @@ OR
<script src="./js/autoComplete.min.js"></script>
<script src="./js/index.js"></script>
OR
<script src="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].1/dist/js/autoComplete.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].2/dist/js/autoComplete.min.js"></script>
<script src="./js/index.js"></script>
```

Expand Down Expand Up @@ -215,7 +215,7 @@ new autoComplete({
| Keys | Description | Values | Default |
| -------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `data` | Data Source, Data Key & Data Caching | **1- src**: <br> - `Array` of `Strings` / `Objects`<br>**OR**<br> - `Function` => `Array` of `Strings` / `Objects` <br> **2- key**: <br>- `Array` of `Strings`<br>**Required** if `src` is `Object`, for search to point to desired `keys` <br> **3- Cache**: <br> - `true` for static data `src` <br> - `false` for dynamic data `src` "API" with queries | Data `src` |
| `trigger` | Engine event & condition trigger | **1- event**: <br> - `Array` of `Strings` <br> **2- condition**: <br>- Condition `String` | 1- event: `["input"]` <br> 2- condition: <br> `(queryValue.length > this.threshold && queryValue !== " ")` |
| `trigger` | Engine event & condition trigger | **1- event**: <br> - `Array` of `Strings` <br> **2- condition**: <br>- `Function` (query) => Condition `String` | 1- event: `["input"]` <br> 2- condition: <br> `(query.length > this.threshold && query !== " ")` |
| `query` | Query Interceptor | **-** `Object` with 1 method<br> 1- manipulate: `Function` with (query) argument | Raw `Input` |
| `sort` | Sort rendered results | `Function` | Blank / Empty **(Random Results)** |
| `placeHolder` | Place Holder text | `String` | Blank / Empty |
Expand Down Expand Up @@ -300,8 +300,8 @@ Check out <a href="#/releases?id=versioning">Releases</a> Information :sparkles:
- [x] Handling large data sets
- [x] Event emitter fires on cleared empty input field state
- [x] `Query` Interception & Manipulation
- [x] Improve `Promise` usage for external data source handling
- [ ] Automatic deep search over all keys in multiple nested object data source
- [ ] Improve `Promise` usage for external data source handling
- [ ] Add `weights` on nearest possible results

### Usability:
Expand Down
4 changes: 2 additions & 2 deletions docs/demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/ms-icon-144x144.png">
<meta name="theme-color" content="#ffffff">
<link rel="stylesheet" type="text/css" media="screen" href="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].1/dist/css/autoComplete.min.css">
<link rel="stylesheet" type="text/css" media="screen" href="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].2/dist/css/autoComplete.min.css">
<link rel="stylesheet" type="text/css" media="screen" href="./css/main.css">
<link href="https://fonts.googleapis.com/css?family=PT+Sans" rel="stylesheet">
</head>
Expand Down Expand Up @@ -119,7 +119,7 @@ <h4>mode</h4>
</div>
</footer>
</div>
<script src="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].1/dist/js/autoComplete.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@tarekraafat/[email protected].2/dist/js/autoComplete.min.js"></script>
<script src="./js/index.js"></script>
</body>

Expand Down
9 changes: 7 additions & 2 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,14 @@ Release flags:

## Release Notes

- v7.0.1 :sparkles:
- `api multiple calls` issue fix (Thanks 👍 @srinivas025)
- v7.0.2 :sparkles:
- Data Promise bug fix (Thanks 👍 @braco)
- Remote API duplicate calls fix (Thanks 👍 @srinivas025, @argebynogame)
- `trigger.condition` enhancement (Thanks 👍 @sakuraineed)
- Code Refactor for faster performance and lighter weight

- v7.0.1
- `api multiple calls` issue fix (Thanks 👍 @srinivas025)

- v7.0.0
- New API for results list navigation `resultsList.navigation` (Thanks 👍 @fredluetkemeier)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@tarekraafat/autocomplete.js",
"version": "7.0.1",
"version": "7.0.2",
"description": "Simple autocomplete pure vanilla Javascript library.",
"main": "dist/js/autoComplete.js",
"browser": "dist/js/autoComplete.min.js",
Expand Down

0 comments on commit 8c32656

Please sign in to comment.