@react-md/autocomplete

@react-md/autocomplete

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.

Installation

npm install --save @react-md/autocomplete

Documentation

You should check out the full documentation for live examples and more customization information, but an example usage is shown below.

Usage

The AutoComplete component just requires:

• an id to identify the field (required for a11y)
• a list of data that can be a list of string, number, or object

However, it is recommended to also provide a label and placeholder text to help the user understand this component.

import React from "react";
import { AutoComplete } from "@react-md/autocomplete";

const fruits = [
  "Apple",
  "Apricot",
  "Banana",
  "Blueberry",
  "Cranberry",
  "Kiwi",
  "Peach",
  "Plum",
  "Strawberry",
];

function Example() {
  return (
    <AutoComplete
      id="search-fruits"
      name="fruits"
      label="Fruits"
      placeholder="Kiwi..."
      data={fruits}
    />
  );
}

Changelog

3.0.1 (2021-08-15)

Bug Fixes

• Updated peerDependencies to fix yarn berry peer requirements (250efcd), closes #1224

Other Internal Changes

• Fixed link to v3.0.0 PR (ff221cc)