#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# autocomplete Module

User Guide & Examples
Defined in: `autocomplete/js/autocomplete-plugin.js:8`

Provides automatic input completion or suggestions for text input fields and textareas.

This module provides the following classes:

- AutoComplete
- AutoCompleteBase
- AutoCompleteFilters
- AutoCompleteHighlighters
- AutoCompleteList
- Plugin.AutoComplete

This module is a rollup of the following modules:

- autocomplete-base
  `Y.Base` extension that provides core autocomplete logic (but no UI implementation) for a text input field or textarea. Must be mixed into a `Y.Base`-derived class to be useful.
- autocomplete-filters
  Provides pre-built result matching filters for AutoComplete.
- autocomplete-filters-accentfold
  Provides pre-built accent-folding result matching filters for AutoComplete. These filters are similar to the ones provided by the `autocomplete-filters` module, but use accent-aware comparisons. For example, "resume" and "résumé" will be considered equal when using the accent-folding filters.
- autocomplete-highlighters
  Provides pre-built result highlighters for AutoComplete.
- autocomplete-highlighters-accentfold
  Provides pre-built accent-folding result highlighters for AutoComplete. These highlighters are similar to the ones provided by the `autocomplete- highlighters` module, but use accent-aware comparisons. For example, "resume" and "résumé" will be considered equal when using the accent-folding highlighters.
- autocomplete-list
  Traditional autocomplete dropdown list widget, just like Mom used to make.
- autocomplete-list-keys
  Mixes keyboard support into AutoCompleteList. By default, this module is not loaded for iOS and Android devices.
- autocomplete-plugin
  Binds an AutoCompleteList instance to a Node instance.
- autocomplete-sources
  Mixes support for JSONP and YQL result sources into AutoCompleteBase.