UNPKG

1.64 kBMarkdownView Raw
1# Terra Search Field
2
3
4[![NPM version](https://badgen.net/npm/v/terra-search-field)](https://www.npmjs.org/package/terra-search-field)
5[![Build Status](https://badgen.net/travis/cerner/terra-core)](https://travis-ci.com/cerner/terra-core)
6
7A search component with a field that automatically performs a search callback after user input.
8
9- [Getting Started](#getting-started)
10- [Documentation](https://github.com/cerner/terra-core/tree/master/packages/terra-search-field/docs)
11- [LICENSE](#license)
12
13## Getting Started
14
15- Install from [npmjs](https://www.npmjs.com): `npm install terra-search-field`
16
17<!-- AUTO-GENERATED-CONTENT:START Peer Dependencies -->
18## Peer Dependencies
19
20<details>
21<summary>View information on this component's peer dependencies.</summary>
22
23This component requires the following peer dependencies be installed in your app for the component to properly function.
24
25| Peer Dependency | Version |
26|-|-|
27| react | ^16.8.5 |
28| react-dom | ^16.8.5 |
29| react-intl | ^2.8.0 |
30
31
32</details>
33<!-- AUTO-GENERATED-CONTENT:END -->
34
35## LICENSE
36
37Copyright 2017 - 2019 Cerner Innovation, Inc.
38
39Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
40
41&nbsp;&nbsp;&nbsp;&nbsp;http://www.apache.org/licenses/LICENSE-2.0
42
43Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.