Skip to content
React typeahead with Bootstrap styling
Branch: master
Clone or download
Latest commit 308df6c Mar 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs Deprecate `bodyContainer` prop in favor of `positionFixed` Mar 4, 2019
example Stricter linting & fix examples Jan 28, 2019
scripts Don't publish example site for pre-release versions Feb 21, 2019
scss
src Fix positionFixed + pagination behavior (#431) Mar 20, 2019
test Fix lint error Feb 25, 2019
.babelrc
.eslintignore
.eslintrc Fix AsyncTypeahead bugs and update tests (#417, #422) Feb 25, 2019
.gitignore
.npmignore
.travis.yml Force node-sass rebuildin CI env Oct 2, 2018
CHANGELOG.md
CONTRIBUTING.md Update CONTRIBUTING.md May 3, 2018
LICENSE.md Update readme & license Jul 25, 2016
README.md
karma.conf.js
package.json v3.4.2 Mar 20, 2019
webpack.config.base.js
webpack.config.js
yarn.lock

README.md

React Bootstrap Typeahead

A React-based typeahead that relies on Bootstrap for styling and was originally inspired by Twitter's typeahead.js. It supports both single- and multi-selection and is compliant with WAI-ARIA authoring practices. Try the live examples.

npm version npm downloads build status cdnjs

Please note that documentation and examples apply to the most recent release and may no longer be applicable if you're using an outdated version.

Installation

npm install --save react-bootstrap-typeahead

or

yarn add react-bootstrap-typeahead

Include the module in your project:

import {Typeahead} from 'react-bootstrap-typeahead'; // ES2015
var Typeahead = require('react-bootstrap-typeahead').Typeahead; // CommonJS

UMD Build

Development and production builds are included in the NPM package. Alternatively, you can get them from CDNJS or unpkg.

Documentation

CSS

While the component relies primarily on Bootstrap for styles, some additional CSS is necessary for everything to behave correctly. You must include the provided CSS file in your project:

// Import as a module in your JS
import 'react-bootstrap-typeahead/css/Typeahead.css';

or

<!-- Link as a stylesheet in your HTML -->
<link rel="stylesheet" href="https://unpkg.com/react-bootstrap-typeahead/css/Typeahead.css">

Bootstrap 4

In an effort to fully support Bootstrap 4, this package also contains a CSS file named Typeahead-bs4.css that should be included alongside the base CSS file above.

Examples

Try the live examples, which also include code samples. If you'd like to modify the examples, clone the repository and run npm install and npm start to build the example file. You can then open the HTML file locally in your browser.

Browser Support

Recent versions of the following browsers are supported:

  • Chrome
  • Firefox
  • IE (>=11)
  • Safari

Special thanks to BrowserStack for providing cross-browser testing support.

http://i.imgur.com/9aLP6Fx.png?1

License

MIT

You can’t perform that action at this time.