Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gch1p/bootstrap-5-autocomplete
autocomplete/typeahead js plugin for bootstrap v5
https://github.com/gch1p/bootstrap-5-autocomplete
autocomplete bootstrap bootstrap5 typeahead
Last synced: 4 days ago
JSON representation
autocomplete/typeahead js plugin for bootstrap v5
- Host: GitHub
- URL: https://github.com/gch1p/bootstrap-5-autocomplete
- Owner: gch1p
- Created: 2021-01-03T20:06:26.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-19T02:58:10.000Z (almost 2 years ago)
- Last Synced: 2024-12-10T02:20:25.472Z (14 days ago)
- Topics: autocomplete, bootstrap, bootstrap5, typeahead
- Language: HTML
- Homepage:
- Size: 36.1 KB
- Stars: 104
- Watchers: 5
- Forks: 35
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bootstrap-5-autocomplete
This is a rewrite of https://github.com/Honatas/bootstrap-4-autocomplete for bootstrap v5.
### Example
```js
const ac = new Autocomplete(field, {
data: [{label: "I'm a label", value: 42}],
maximumItems: 5,
onSelectItem: ({label, value}) => {
console.log("user selected:", label, value);
}
});
// later, when you need to change the dataset
ac.setData([
{label: 'New York JFK', value: 'JFK'},
{label: 'Moscow SVO', value: 'SVO'},
]);
```
Or use custom label/value keys:
```js
const ac = new Autocomplete(field, {
data: [{name: "entry1", text: "The first entry"}, {name: "entry2", text: "The second entry"}],
label: "name",
value: "text",
onSelectItem: ({label, value}) => {
console.log("user selected:", label, value);
}
});
```
Or use a simple object instead of an array of objects:
```js
const ac = new Autocomplete(field, {
data: {entry1: "The first entry", entry2: "The second entry"},
label: null,
value: null,
onSelectItem: ({label, value}) => {
console.log("user selected:", label, value);
}
});
```
### Options
Options is a JSON object with the following attributes (in alphabetical order):
**data**:
The data from where autocomplete will lookup items to show. This data can be a simple object or an array of JSON objects. By default the format for every object in the array is as following, but you can also change the name of the label and value keys (see below):
{"label": "This is a text", "value": 42}
**dropdownOptions**:
It's the same options from Bootstrap's Dropdown, documented [here](https://getbootstrap.com/docs/5.0/components/dropdowns/#options).
**dropdownClass**:
The class of the dropdown-menu element, which is the box that is displayed. Can take a string or an array of strings.
**highlightClass**:
The class to use when highlighting typed text on items. Only used when highlightTyped is true. Default is text-primary. Can take a string or an array of strings.
**highlightTyped**:
Whether to highlight (style) typed text on items. Default is true.
**label**:
The name of the `label` key in your data. The label is what will be shown on each item in the autocomplete list.
**maximumItems**:
How many items you want to show when the autocomplete is displayed. Default is 5. Set to 0 to display all available items.
**onInput**:
A callback function to execute on user input.
**onSelectItem**:
A callback that is fired every time an item is selected. It receives an object in following format:
{label: , value: }
**showValue**:
If set to true, will display the value of the entry after the label in the dropdown list.
**showValueBeforeLabel**:
If set to true and `showValue` also set to true, the value will be displayed before the label.
**threshold**:
The number of characters that need to be typed on the input in order to trigger the autocomplete. Default is 4.
**value**:
The name of the `value` key in your data.
### License
MIT