# @covalent/search

> Teradata UI Platform Search Box Module

Latest version **0.9.1** (published 2016-11-23) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @covalent/search
pnpm add @covalent/search
yarn add @covalent/search
bun add @covalent/search
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.9.1 |
| Published | 2016-11-23 |
| First published | 2016-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >4.4 < 7 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2223 |
| Author | Teradata UX |
| Maintainers | emoralesb05, ilsiepotamus, teradata |
| Keywords | angular, components, reusable, search, box |

## Links

- npm: https://www.npmjs.com/package/@covalent/search
- Repository: https://github.com/teradata/covalent
- Homepage: https://github.com/teradata/covalent#readme
- Issues: https://github.com/teradata/covalent/issues
- npm.io page: https://npm.io/package/@covalent/search

## Dependencies (1)

- [@covalent/core](https://npm.io/package/@covalent/core.md) 0.9.1

## Alternatives

- [react-native-root-siblings](https://npm.io/package/react-native-root-siblings.md) — 102.9K weekly downloads
- [@praxisui/dialog](https://npm.io/package/@praxisui/dialog.md) — 2.0K weekly downloads
- [easy-toggle-state](https://npm.io/package/easy-toggle-state.md) — 350 weekly downloads
- [ngx-lightbox-evp](https://npm.io/package/ngx-lightbox-evp.md) — 19 weekly downloads
- [react-native-modal-translucent-axton](https://npm.io/package/react-native-modal-translucent-axton.md) — 4 weekly downloads

## Recent versions

- 0.9.1 (latest) — 2016-11-23
- 0.9.0 — 2016-11-21

## README

# td-search-input

`td-search-input` element to generate a search input with its animated cancel button.

## API Summary

Properties:

| Name | Type | Description |
| --- | --- | --- |
| `debounce?` | `number` | Debounce timeout between keypresses. Defaults to 400.
| `placeholder?` | `string` | Placeholder for the underlying input component.
| `showUnderline?` | `boolean` | Sets if the input underline should be visible. Defaults to 'false'.
| `searchDebounce` | `function($event)` | Event emitted after the [debounce] timeout.
| `search` | `function($event)` | Event emitted after the key enter has been pressed.
| `clear?` | `function` | Event emitted after the clear icon has been clicked.

## Usage

Example for HTML usage:

 ```html
<td-search-input placeholder="Search here" [showUnderline]="false|true" [debounce]="500" (searchDebounce)="searchInputTerm = $event" (search)="searchInputTerm = $event" (clear)="searchInputTerm = ''">
</td-search-input>
 ```

# td-search-box

`td-search-box` element to generate a search box with animations.

## API Summary

Properties:

| Name | Type | Description |
| --- | --- | --- |
| `debounce?` | `number` | Debounce timeout between keypresses. Defaults to 400.
| `placeholder?` | `string` | Placeholder for the underlying input component.
| `backIcon?` | `string` | The icon used to close the search toggle, only shown when [alwaysVisible] is false. Defaults to 'search' icon.
| `showUnderline?` | `boolean` | Sets if the input underline should be visible. Defaults to 'false'.
| `alwaysVisible?` | `boolean` | Sets if the input should always be visible. Defaults to 'false'.
| `searchDebounce` | `function($event)` | Event emitted after the [debounce] timeout.
| `search` | `function($event)` | Event emitted after the key enter has been pressed.
| `clear?` | `function` | Event emitted after the clear icon has been clicked.

## Usage

Example for HTML usage:

 ```html
<td-search-box placeholder="Search here" [showUnderline]="false|true" [debounce]="500" [alwaysVisible]="false|true" (searchDebounce)="searchInputTerm = $event" (search)="searchInputTerm = $event" (clear)="searchInputTerm = ''">
</td-search-box>
 ```

## Setup

Import the [CovalentSearchModule] using the forRoot() method in your NgModule:

```typescript
import { CovalentSearchModule } from '@covalent/chips';
@NgModule({
  imports: [
    CovalentSearchModule.forRoot(),
    ...
  ],
  ...
})
export class MyModule {}
```

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