Bootstrap 5 Autocomplete
Tags: bootstrap, javascript, webdev, html
Published: 2021-05-12 09:26:47

## What is Bootstrap Autocomplete?

Autocomplete component predicts the words being typed based on the first few letters given by the user. You can search the list using basic scroll and the keyboard arrows

______

## Installation

#### Manual installation (zip package)

To take advantage of  our Bootstrap images component and use them in your project, you first need to install the [MDB 5 Free package](https://mdbootstrap.com/docs/standard/getting-started/installation/#section-manual-installation)

_______

#### MDB CLI

Watch our [**Quick Start Tutorial**](https://mdbootstrap.com/docs/standard/getting-started/quick-start/) to discover and use the full potential of MDB 5 and MDB CLI

_______

#### NPM

###### Prerequisites

Before starting the project make sure to install [Node LTS (12.x.x recommended)](https://nodejs.org/en/).

###### Installation

To install MDB UI KIT in your project easily type the following command in the terminal:
```terminal
npm i mdb-ui-kit 
```

###### Importing JS modules

You can import the entire library or just individual modules:
```terminal
import * as mdb from 'mdb-ui-kit'; // lib
import { Input } from 'mdb-ui-kit'; // module 
```

###### Importing CSS file

To import MDB stylesheet please use the following syntax:
```terminal
@import '~mdb-ui-kit/css/mdb.min.css'; 
```

###### Importing SCSS modules

You can also import individual SCSS modules. To do it properly, we recommend to copy them from the node_modules/mdb-ui-kit/src/scss location directly to your project and import in the same way as CSS files.

###### Webpack integration

You can significantly speed up the process of creating a new project based on Webpack using our [Starter](https://github.com/mdbootstrap/mdb-webpack-starter).

__________

#### CDN

Installation via CDN is one of the easiest methods of integrating MDB UI KIT with your project. Just copy the latest compiled JS script tag and CSS link tag from [cdnjs](https://cdnjs.com/libraries/mdb-ui-kit) to the application.

Don't forget to add also Font Awesome and Roboto font if you need it. Here's an example code:

###### CSS

```css
<!-- Font Awesome -->
<link
  href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css"
  rel="stylesheet"
/>
<!-- Google Fonts -->
<link
  href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap"
  rel="stylesheet"
/>
<!-- MDB -->
<link
  href="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.css"
  rel="stylesheet"
/>
```


###### JS

```javascript
<!-- MDB -->
<script
  type="text/javascript"
  src="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.js"
></script>
```

________

## Customization

##### Basic example

The `filter` option is required in order for a component to work properly. The option accepts a function that is expected to return an array of results or a `Promise` that resolves to an array of results.

###### HTML
```html
<div id="basic" class="form-outline">
  <input type="text" id="form1" class="form-control" />
  <label class="form-label" for="form1">Example label</label>
</div>
```

###### JS
```javascript
const basicAutocomplete = document.querySelector('#basic');
const data = ['One', 'Two', 'Three', 'Four', 'Five'];
const dataFilter = (value) => {
  return data.filter((item) => {
    return item.toLowerCase().startsWith(value.toLowerCase());
  });
};

new mdb.Autocomplete(basicAutocomplete, {
  filter: dataFilter
});
```



##### Display value

The `displayValue` option allow to separate oryginal result value from the value that will be displayed in the result list or input (after selection). It's useful when the data returned by the `filter` function is an array of objects. You can specify which parameter of the object should be displayed.

###### HTML
```html
<div id="displayValue" class="form-outline">
  <input type="text" id="form1" class="form-control" />
  <label class="form-label" for="form1">Example label</label>
  <div class="autocomplete-custom-content"></div>
</div>
```

###### JS
```javascript
const displayValueAutocomplete = document.querySelector('#displayValue');
const data = [
  { title: 'One', description: 'Lorem ipsum dolor sit, amet consectetur adipisicing elit' },
  { title: 'Two', description: 'Lorem ipsum dolor sit, amet consectetur adipisicing elit' },
  { title: 'Three', description: 'Lorem ipsum dolor sit, amet consectetur adipisicing elit' },
  { title: 'Four', description: 'Lorem ipsum dolor sit, amet consectetur adipisicing elit' },
  { title: 'Five', description: 'Lorem ipsum dolor sit, amet consectetur adipisicing elit' }
];
const dataFilter = (value) => {
  return data.filter((item) => {
    return item.title.toLowerCase().startsWith(value.toLowerCase());
  });
};

new mdb.Autocomplete(displayValueAutocomplete, {
  filter: dataFilter,
  displayValue: (value) => value.title,
});
```




#### You can see more customization examples on the [📄 Autocomplete documentation page](https://mdbootstrap.com/docs/standard/forms/autocomplete/)

______

## Crucial Resources

Here are the resources that we have prepared to help you work with this component:

1. Read [📄 Autocomplete documentation page](https://mdbootstrap.com/docs/standard/forms/autocomplete/) <-- start here
2. In to get the most out of your project, you should also get acquainted with other Forms options related to Autocomplete. See the section below to find the list of them.
3. You can use predesigned Forms elements in [📥 Starter Bootstrap 5 templates](https://mdbootstrap.com/freebies/)
4. Templates are a part of [📦 Free UI Kit for Bootstrap 5](https://mdbootstrap.com/docs/standard/)
5. After finishing the project you can publish it with CLI in order to receive [💽 Free hosting (beta)](https://mdbootstrap.com/docs/standard/cli/)

-----

## Related Content and Styles options & features
- [Checkbox](https://mdbootstrap.com/docs/standard/forms/checkbox/)
- [Datepicker](https://mdbootstrap.com/docs/standard/forms/datepicker/)
- [DateTimepicker](https://mdbootstrap.com/docs/standard/forms/datetimepicker/)
- [File](https://mdbootstrap.com/docs/standard/forms/file/)
- [Input fields](https://mdbootstrap.com/docs/standard/forms/input-fields/)
- [Input group](https://mdbootstrap.com/docs/standard/forms/input-group/)
- [Multi Range Slider](https://mdbootstrap.com/docs/standard/forms/multi-range-slider/)
- [Search](https://mdbootstrap.com/docs/standard/forms/search/)
- [Select](https://mdbootstrap.com/docs/standard/forms/select/)
- [Switch](https://mdbootstrap.com/docs/standard/forms/switch/)
- [Radio](https://mdbootstrap.com/docs/standard/forms/radio/)
- [Range](https://mdbootstrap.com/docs/standard/forms/range/)
- [Timepicker](https://mdbootstrap.com/docs/standard/forms/timepicker/)
- [Validation](https://mdbootstrap.com/docs/standard/forms/validation/)


-----

## Learn Bootstrap 5 in 1.5H

{% youtube c9B4TPnak1A %}

-----

## Additional resources

Learn web development with our **learning roadmap**:
**[:mortar_board: Start Learning](https://mdbootstrap.com/docs/standard/getting-started/)**

Join our mailing list & receive **exclusive resources** for developers
**[:gift: Get gifts](https://mdbootstrap.com/newsletter/)**

Join our private FB group for **inspiration & community experience**
**[👨‍👩‍👧‍👦 Ask to join](https://www.facebook.com/groups/682245759188413)**

**Support creation of open-source packages** with a STAR on GitHub
[![GitHub Stars](https://img.shields.io/github/stars/mdbootstrap/mdb-ui-kit?label=Star%20now&style=social)](https://github.com/mdbootstrap/mdb-ui-kit/)