moroshko/react-autosuggest
React Autosuggest
React Autosuggest is a fully controlled React component that provides an autocomplete input with a dropdown of suggestions as the user types. It delegates all state management to the parent component through callbacks, making it compatible with state management patterns like Flux or Redux. The component implements WAI-ARIA accessibility patterns, including keyboard navigation with arrow keys, Enter, and Escape, along with live region integration for screen reader announcements.
The component offers extensive customization through render-prop functions, allowing developers to replace the default input element and control how each suggestion is rendered, including support for grouped sections with headers. It provides scroll isolation within the suggestions container, preventing page scrolling when the list reaches its boundary. Styling can be applied through a theme object that works with any CSS solution, including CSS Modules, Radium, or JSS.
The component gives developers control over when suggestions are displayed, such as after a minimum character count or based on custom logic, and supports automatic highlighting of matched text. It handles long suggestion lists by rendering them in a scrollable container, and provides direct access to the underlying input element for DOM manipulation.
Features
- Autocomplete Inputs - Provides a fully controlled autocomplete input with filtered suggestions as the user types.
- Keyboard and Navigation - Supports full keyboard navigation with arrow keys, Enter, and Escape for suggestion selection.
- Keyboard-Accessible - Implements full keyboard navigation with arrow keys, Enter, and Escape for suggestion selection.
- Custom Suggestion Templates - Allows replacing the default input and suggestion container with custom rendering logic.
- Keyboard Navigation State Machines - Ships an internal state machine for keyboard-driven suggestion navigation and selection.
- Autocomplete Components - Provides a fully controlled React autocomplete input with a dropdown of suggestions as the user types.
- Controlled - Ships a fully controlled React autocomplete component that delegates all state management to parent callbacks.
- Customizable Suggestion Renderers - Provides render-prop functions for fully customizing suggestion markup, grouped sections, and styling.
- Controlled Components - Delegates all state management to the parent via callbacks, implementing a fully controlled component pattern.
- Render Props - Exposes render props for input and suggestion rendering, giving full markup and style control.
- Controlled Component State Integrations - Ships a fully controlled React autocomplete component that delegates all state management to parent callbacks for Flux or Redux integration.
- Keyboard-Accessible Autocomplete - Provides keyboard-accessible autocomplete with ARIA attributes for screen reader navigation.
- Screen Reader Accessibility - Announces each suggestion to screen readers with full keyboard navigation for selection.
- Screen Reader Live Regions - Delivers screen reader announcements through ARIA live regions that update as suggestions appear.
- WAI-ARIA Frameworks - Implements WAI-ARIA accessibility patterns with keyboard navigation and screen reader announcements.
- Autocomplete State Controllers - Delegates all autocomplete state management to parent callbacks for seamless Flux or Redux integration.
- Input Suggestions - Provides a scrollable suggestion container for long lists of autocomplete options.
- Sectioned Suggestion Groups - Supports rendering suggestions in grouped sections with headers for better organization.
- Suggestion Visibility Controls - Controls when suggestions appear, such as after a minimum character count or based on custom logic.
- Grouped List Sections - Renders suggestions as grouped sections with headers for organized browsing.
- Custom Input Overrides - Allows replacing the default input element with a fully custom component for UI library integration.
- Container Scroll Isolations - Isolates scroll inside the suggestions container to prevent page scrolling at boundaries.
- Scroll Boundary Event Captures - Captures wheel events when the suggestion container reaches its scroll boundary to isolate scrolling.
- Container Scroll Isolations - Isolates scroll within the suggestions container to prevent page scrolling at boundaries.
- Scrollable Form Lists - Renders the suggestion list inside a scrollable container to keep long lists usable.
- Scroll-Isolated Suggestion Lists - Isolates scroll within the suggestions container to prevent page scrolling when the list boundary is reached.
- CSS Styling - Applies custom styles via a theme object compatible with CSS Modules, Radium, Aphrodite, or JSS.
- Form Controls - WAI-ARIA compliant autosuggest component.
