Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orizens/ngx-typeahead
A simple but yet powerful typeahead component for Angular (css framework agnostic)
https://github.com/orizens/ngx-typeahead
angular angular-library angular6 angularjs autocomplete component rxjs typeahead
Last synced: about 1 month ago
JSON representation
A simple but yet powerful typeahead component for Angular (css framework agnostic)
- Host: GitHub
- URL: https://github.com/orizens/ngx-typeahead
- Owner: orizens
- License: mit
- Created: 2017-05-03T05:47:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-20T22:59:42.000Z (5 months ago)
- Last Synced: 2024-09-27T17:40:54.134Z (about 2 months ago)
- Topics: angular, angular-library, angular6, angularjs, autocomplete, component, rxjs, typeahead
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/ngx-typeahead
- Size: 970 KB
- Stars: 61
- Watchers: 3
- Forks: 29
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/ngx-typeahead)
# Angular Typeahead Directive/Component (Standalone)
This is an extract of the typeahead component from the [open source](http://github.com/orizens/echoes-player) [Echoes Player](http://echoesplayer.com).
## Data Sources Support
Its built with **JSONP** support **by default**.
Supports **HTTP** remote source with any http method (get, post etc..).
Supports static list (in array form).
## Angular Support
Now, ngx-typeahead now follows Angular versions, starting with **[email protected]** for Angular 6.X.X.
For **Angular 4.3/5.X** (With the new **HttpClient**)- please use version > 0.2.1
For **Angular 2, 4** (Without **HttpClient**)- please use version 0.0.3
AOT compatible
## Angular Consulting Services
I'm a Senior Javascript Engineer & A Front End Consultant at [Orizens](http://orizens.com).
My services include:
- consulting on how to approach code in projects and keep it maintainable.
- I provide project bootstrapping and development - while afterwards, I integrate it on site and guide the team on it.
[Contact Me Here](http://orizens.com/contact)
## Installation
```
npm install ngx-typeahead --save-dev
```
## Supported API
### Inputs
| Input | Type | Required | Description |
| -------------------- | -------------------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| taUrl | string | YES | the url of a remote server that supports jsonp calls. |
| taParams | { key: string, value: any} | optional, default: {} | a {key,value} (json) object to include as params for the json call. Each api supports different structure. |
| taQueryParam | query | optional, default: 'q' | a string member which is set with the query value for search. |
| taCallbackParamValue | query | optional, NO Default | a string value for the callback query parameter. |
| taItemTpl | TemplateRef | - optional | a template reference to be used for each result item. |
| taApi | string | optional, default: 'jsonp' | the utility to make a request with - 'jsonp', 'http'. |
| taApiMethod | string | optional, default: 'get' | the method to be used in either 'jsonp' or 'http'. |
| taList | any[] | optional | provide a static list of items to display. This prevents any remote request and has first precedence. |
| taListItemField | string[] | optional | if item in static list is an object, this list of keys in the object that are checked when the list is filtered with the query. if list is empty, all keys are checked |
| taListItemLabel | string | optional | if static list of type object - this label is used as the key for displaying the item in the suggestions list - item[label] |
| taDebounce | number | optional | set the debounce time before a request is called |
| taAllowEmpty | boolean | optional, default: false | if true, it allows empty strings to pass and invoke search |
| taCaseSensitive | boolean | optional, default: false | if true, comparing query is performed with case sensitive |
| taDisplayOnFocus | boolean | optional, default: false | if true, will display results (if exist) when input is clicked |
### Outputs
| Output | Type | Required | Description |
| ---------- | ------ | -------- | ----------------------------------------- |
| taSelected | string | YES | emits an event once the item is selected. |
## DEMO
[Demo with all parameters StackBlitz](https://stackblitz.com/edit/ngx-typeahead?file=src/main.ts)
## Usage
App/Component should be loaded as a standalone component:
```typescript
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import { provideHttpClient, withJsonpSupport } from '@angular/common/http';
bootstrapApplication(AppComponent, {
providers: [provideHttpClient(withJsonpSupport())],
});
```
Then, in your component, add to `imports` array:
```typescript
import { Component } from "@angular/core";
import { NgxTypeAheadComponent } from 'ngx-typeahead';
@Component({
selector: "app",
template: `
`,
imports: [NgxTypeAheadComponent]
})
export class AppComponent {
url = "http://suggestqueries.google.com/complete/search";
params = {
hl: "en",
ds: "yt",
xhr: "t",
client: "youtube",
q: query,
};
search = "";
handleResultSelected(result) {
this.search = result;
}
}
```
## Custom Template For Item
```typescript
import { Component } from "@angular/core";
import { NgxTypeAheadComponent } from 'ngx-typeahead';
@Component({
selector: "app",
template: `
MY {{ result.result }}
`,
imports: [NgxTypeAheadComponent]
})
export class AppComponent {
url = "http://suggestqueries.google.com/complete/search";
params = {
hl: "en",
ds: "yt",
xhr: "t",
client: "youtube",
q: query,
};
search = "";
handleResultSelected(result) {
this.search = result;
}
}
```
# Showcase Examples
- [Echoes Player - Developed with Angular, angular-cli and ngrx](http://orizens.github.io/echoes-player) ([github repo for echoes player](http://github.com/orizens/echoes-player))
# NgxTypeahead
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.1.11.