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
MDB CLI
Watch our Quick Start Tutorial 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).
Installation
To install MDB UI KIT in your project easily type the following command in the terminal:
npm i mdb-ui-kit
Importing JS modules
You can import the entire library or just individual modules:
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:
@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.
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 to the application.
Don't forget to add also Font Awesome and Roboto font if you need it. Here's an example code:
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
<!-- 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
<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
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
<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
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
Crucial Resources
Here are the resources that we have prepared to help you work with this component:
- Read ๐ Autocomplete documentation page <-- start here
- 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.
- You can use predesigned Forms elements in ๐ฅ Starter Bootstrap 5 templates
- Templates are a part of ๐ฆ Free UI Kit for Bootstrap 5
- After finishing the project you can publish it with CLI in order to receive ๐ฝ Free hosting (beta)
Related Content and Styles options & features
- Checkbox
- Datepicker
- DateTimepicker
- File
- Input fields
- Input group
- Multi Range Slider
- Search
- Select
- Switch
- Radio
- Range
- Timepicker
- Validation
Learn Bootstrap 5 in 1.5H
Additional resources
Learn web development with our learning roadmap:
๐ Start Learning
Join our mailing list & receive exclusive resources for developers
๐ Get gifts
Join our private FB group for inspiration & community experience
๐จโ๐ฉโ๐งโ๐ฆ Ask to join
Support creation of open-source packages with a STAR on GitHub
Top comments (0)