# ngm-live-search

> This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.0.

Latest version **16.0.0** (published 2024-12-26) · 0 weekly downloads

## Install

```sh
npm install ngm-live-search
pnpm add ngm-live-search
yarn add ngm-live-search
bun add ngm-live-search
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 16.0.0 |
| Published | 2024-12-26 |
| First published | 2022-06-29 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 35.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Mostafa Soleimani |
| Maintainers | mostafasoleimani1987 |
| Keywords | Angular, Live Search, Search |

## Links

- npm: https://www.npmjs.com/package/ngm-live-search
- Repository: https://github.com/MostafaSoleimani/Angular-libs.git#main
- Homepage: https://github.com/MostafaSoleimani/Angular-libs/blob/main/projects/ngm-live-search/README.md
- Issues: https://github.com/MostafaSoleimani/Angular-libs/issues
- npm.io page: https://npm.io/package/ngm-live-search

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.3.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 16.0.0 (latest) — 2024-12-26
- 15.0.0 — 2024-12-26
- 14.0.0 — 2024-12-26
- 2.0.4 — 2022-08-02
- 2.0.3 — 2022-07-26
- 2.0.2 — 2022-07-26
- 2.0.1 — 2022-07-21
- 2.0.0 — 2022-07-21
- 1.0.6 — 2022-07-06
- 1.0.5 — 2022-07-04
- 1.0.4 — 2022-07-01
- 1.0.3 — 2022-06-29
- 1.0.2 — 2022-06-29
- 1.0.1 — 2022-06-29
- 1.0.0 — 2022-06-29

## README

# NgmLiveSearch

This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.0.

## Demo

https://stackblitz.com/edit/angular-ivy-kdr5j4?file=src/app/app.component.html

## Installation

Install npm i ngm-live-search with npm

```bash
  cd my-project
  npm i npm i ngm-live-search
```

## Usage/Examples

```javascript
import { NgmLiveSearchModule } from "ngm-live-search";

@NgModule({
  imports: [
    .
    .
    .
    NgmLiveSearchModule
  ],
})
export class AppModule {}
```

Then in your component.html

```html
<ngm-live-search (search)="yourSearch($event)" (searchClosed)="clearSearch()">
</ngm-live-search>
```

Then in your component.ts

```typescript
export class YourComponent {
  /**
   * @params text: the text to search.
   */
  yourSearch(text: string) {
    // Call api or search locally on your data.
    // this.callApi() In case of call api.
    // this.localSearch() In case of local search.
  }

  clearSearch() {
    // Stop filtering your data
  }

  callApi() {}

  localSearch() {}
}
```

## API Reference

#### Inputs

| Parameter | Type            | Description                          |
| :-------- | :-------------- | :----------------------------------- |
| `config`  | `ISearchParams` | debounceTime, minLength, clearOnBlur |

#### Outputs

| Parameter      | Type     | Description                  |
| :------------- | :------- | :--------------------------- |
| `search`       | `string` | Returns the string to search |
| `searchClosed` | `string` | on click on x button         |

---
_Source: https://npm.io/package/ngm-live-search · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._