@react-md/autocomplete/CHANGELOG.md

Create an accessible autocomplete component that allows a user to get real-time suggestions as they type within an input. This component can also be hooked up to a backend API that handles additional filtering or sorting.

# Change Log

All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

# [2.7.0](https://github.com/mlaursen/react-md/compare/v2.6.0...v2.7.0) (2021-02-28)


### Documentation

* **tsdoc:** fixed some tsdoc annotations and styling ([0449b86](https://github.com/mlaursen/react-md/commit/0449b86e4e51793710b35a452b7ebcbb6e7b5b2e))
* **tsdoc:** updated \@since annotations ([c62027e](https://github.com/mlaursen/react-md/commit/c62027ebf2223167a2fde0378882e4b934d61971))


### Other Internal Changes

* updated test coverage to not include conditional component PropTypes ([24e5df1](https://github.com/mlaursen/react-md/commit/24e5df14c731411d7691253383435036326407b5))






# [2.6.0](https://github.com/mlaursen/react-md/compare/v2.5.5...v2.6.0) (2021-02-13)

**Note:** Version bump only for package @react-md/autocomplete





## [2.5.5](https://github.com/mlaursen/react-md/compare/v2.5.4...v2.5.5) (2021-01-30)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.5.4](https://github.com/mlaursen/react-md/compare/v2.5.3...v2.5.4) (2021-01-27)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.5.3](https://github.com/mlaursen/react-md/compare/v2.5.2...v2.5.3) (2021-01-12)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.5.2](https://github.com/mlaursen/react-md/compare/v2.5.1...v2.5.2) (2021-01-12)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.5.1](https://github.com/mlaursen/react-md/compare/v2.5.0...v2.5.1) (2020-12-16)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

# [2.5.0](https://github.com/mlaursen/react-md/compare/v2.4.3...v2.5.0) (2020-12-15)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.4.3](https://github.com/mlaursen/react-md/compare/v2.4.2...v2.4.3) (2020-11-14)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.4.2](https://github.com/mlaursen/react-md/compare/v2.4.1...v2.4.2) (2020-10-23)

**Note:** Version bump only for package

## [2.4.1](https://github.com/mlaursen/react-md/compare/v2.4.0...v2.4.1) (2020-10-17)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

# [2.4.0](https://github.com/mlaursen/react-md/compare/v2.3.1...v2.4.0) (2020-10-17)

### Features

- [@react-md/theme](../theme): Better Contrast Colors by Default and dev-utils
  refactor ([#955](https://github.com/mlaursen/react-md/issues/955))
  ([519b128](https://github.com/mlaursen/react-md/commit/519b128522de944d55ff96a1e1125447665ed586))

## [2.3.1](https://github.com/mlaursen/react-md/compare/v2.2.0...v2.3.1) (2020-09-15)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

# [2.3.0](https://github.com/mlaursen/react-md/compare/v2.2.0...v2.3.0) (2020-09-10)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.2.2](https://github.com/mlaursen/react-md/compare/v2.2.1...v2.2.2) (2020-09-02)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.2.1](https://github.com/mlaursen/react-md/compare/v2.2.0...v2.2.1) (2020-09-02)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

# [2.2.0](https://github.com/mlaursen/react-md/compare/v2.1.2...v2.2.0) (2020-08-11)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.1.2](https://github.com/mlaursen/react-md/compare/v2.1.1...v2.1.2) (2020-08-01)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.1.1](https://github.com/mlaursen/react-md/compare/v2.1.0...v2.1.1) (2020-07-21)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

# [2.1.0](https://github.com/mlaursen/react-md/compare/v2.0.4...v2.1.0) (2020-07-12)

### Features

- Exported the `useAutoComplete` hook
  ([cac5cd1](https://github.com/mlaursen/react-md/commit/cac5cd16a1452130ba600833c8ad1180d7ec4918))
- Render non-searchable items in `AutoComplete`
  ([e7a82ac](https://github.com/mlaursen/react-md/commit/e7a82acf874f46b56e8427cdb389ff1f18f12927))

## [2.0.3](https://github.com/mlaursen/react-md/compare/v2.0.2...v2.0.3) (2020-07-07)

**Note:** Version bump only for package
[@react-md/autocomplete](../autocomplete)

## [2.0.2](https://github.com/mlaursen/react-md/compare/v2.0.1...v2.0.2) (2020-06-30)

### Bug Fixes

- **LICENSE:** Removed the time range from license since it was incorrect
  ([50c9021](https://github.com/mlaursen/react-md/commit/50c9021cedc0d642758b9fd541bb6c93d2fe1786))
- Added `sideEffects` field to `package.json`
  ([31820b9](https://github.com/mlaursen/react-md/commit/31820b9b43705e5849664500a17b6849eb6dc2a9))
- `sideEffects` formatting
  ([78a7b6b](https://github.com/mlaursen/react-md/commit/78a7b6b0e40c7daefb749835670705f21bd21720))

## v2.0.1

No changes.

## v2.0.0

The v2 release completely re-write the `Autocomplete` component and renamed it
to `AutoComplete`. There is a new API for dealing with data as well as a lot of
accessibility fixes.

### New Behavior and Features

- correctly forwards the ref to the `<input />` element
- inherits all the new text field styles
- inherits all the new `Option`/`ListItem` styles
- lots of accessibility fixes since it now respects to the
  [combobox role](https://www.w3.org/TR/wai-aria-practices/#combobox)
- opinionated better focus styles to help show keyboard focus vs "real" focus
- the `"inline"` autocomplete is no longer a clickable `<span>` and instead is
  done with `input.setSelectionRange`
- supports both `"inline"` and `"menu"` autocomplete behavior instead of being
  separate
- supports limited highlighting of text within the search results
- defaults to showing the list of suggestions once focused instead of after
  typing a letter
- added additional filter options to the filter function
- added a flag to be able to filter the data when there is no `value` for custom
  display items
- added `getResultId`, `getResultLabel` and `getResultValue` to customizing the
  displayed matches a bit nicer (this is also have the `data` is filtered)

### Breaking Changes

Everything is honestly a breaking change, but here's a few that are important to
mention:

- no longer has any styles of its own
- only supports "smart" menus (automatically render itself within the viewport)
- the `value` is no longer controllable (will be added in a later release)
- no longer supports adding `aria-setsize` and `aria-posinset` for each option
  automatically when paginating results (will be added in a later release)
- no longer supports rendering items that are not searchable and focusable (will
  be added in a later release)
- the visibility of the autocomplete list is no longer controllable
- renamed `dataLabel` to `labelKey`
- renamed `dataValue` to `valueKey`
- renamed the `deleteKeys` to `omitKeys`
- all the positioning options were renamed

#### Removed SCSS Variables Placeholders, and Mixins

- removed `$md-inline-autocomplete`
- removed `$md-autocomplete-suggestion-top`
- removed `$md-autocomplete-suggestion-mobile-floating-top`
- removed `$md-autocomplete-suggestion-mobile-block-top`
- removed `$md-autocomplete-suggestion-desktop-floating-top`
- removed `$md-autocomplete-suggestion-desktop-block-top`
- removed `@mixin react-md-autocompletes`
- removed `@mixin react-md-theme-autocompletes`
- removed `@mixin react-md-autocompletes-mobile`
- removed `@mixin react-md-autocompletes-desktop`
- removed `@mixin react-md-autocompletes-media`