react-bootstrap-typeahead

Breaking

• Introduced selectHint as a top-level prop; removed shouldSelectHint from lower-level components.
• Removed 'large' and 'small' as valid values from the size prop

Please see the migration guide for more details on breaking changes.

Internal + Documentation

• Add instructions for BS5 CSS
• Added breaking changes to the migration guide
• Added more Storybook stories
• Updated Jest config/setup

Feature Requests

• Support BS5 close button (Breaking)

Bug Fixes

• Don't pass option object to token

Internal + Documentation

• Incorporate Storybook and add Chromatic integration
• Upgrade some dependencies

Bugs

• Move Size values to constants (#676)

Bugs

• Don't pass option and position to menu item
• Fix typing issues (#683)

Internal & Docs

• Fix prepublish script
• Ignore helper file from test coverage
• Fix act warnings in tests
• Add example for keeping the menu open during multi-selection

Breaking Changes

• Upgrade react-popper/popperjs to v2 (#549)

Bug Fixes

• Fix aux controls overlapping with validation (#658)

Bug Fixes

• Move Size enum to constants (#676)
• Get rid of console warnings in examples

Internal

• Update build scripts
• Update dependencies
• Remove comments, use esnext when emitting types

Bug Fixes

• Trigger change handler when clicking clear button in multi-select mode (#666, #672)
• Only fire onFocus event once (#665)

Internal + Documentation

• Convert Highlighter to function component
• Update migration docs to include v5 -> v6 instructions

Bug Fixes

• Trigger change handler when clicking clear button in multi-select mode (#666, #672)(Thanks @Huulivoide!)

Breaking Changes

• Don't allow refs to be passed via inputProps
• Remove selectHintOnEnter prop
• Drop support for IE11
• Remove asyncContainer, menutItemContainer, and tokenContainer functions

Bug Fixes

• Strip diacritics from non-latin alphabets (#659, #660)

Feature Requests

• Convert to Typescript (#619)

Internal

• Replace Travis w/Github Actions
• Use key instead of keyCode for keyboard events
• Use Prettier

Bug fixes

• Up contrast on hint to meet a11y standards (#638)
• Fix onClick not being applied when passed via inputProps (#616)
• Prevent clicks on multi-input from bubbling to container (#615, #650)
• Trigger onInputChange when clicking the clear button (#594)

Feature Requests

• Add BS5 .visually-hidden classname (#622)
• Allow changing colors via SCSS variables (#613; Thanks @Teyras!)
• Don't override href passed to MenuItem (#649)

Internal & Documentation

• Improve example a11y
• Upgrade dependencies
• Migrate to React Testing Library

Upgrade dependencies and remove an unused package

• Add toggleMenu to public methods example
• Use sass package instead of node-sass (#599, Thanks @Guymestef!)
• Fix broken link in docs (#596)

Bug Fixes

• Prevent menu click/mousedown from blurring the menu (#579)
• Prevent browser back navigation when ClearButton is focused (#580)

Internal + Docs

• Update filterBy in AsyncExample.js (#578 Thanks @ET-CS!)
• Update dependencies

Internal

• Upgrade dependencies, including some vulnerabilities
• Update a bunch of documentation

This release consists primarily of bug fixes in the useAsync hook. As part of that, there is a small backwards-compatible change to the API, hence a minor release. The delay prop in AsyncTypeahead can now be updated, whereas before it could only be set during the initial mount.

Bug Fixes

• Fix useAsync bugs (#561)

Internal, Docs, + Examples

• Use Fragment in example
• Add hooks linter and fix issues

v5.0 is a fairly extensive rewrite that brings the library more up-to-date with all the changes that React has introduced in the past year or so. Deprecated lifecycles and functions are finally gone; many components were rewritten with hooks, some of which have been exposed as part of the public API to make customization easier or more flexible. This version also drops official support for Bootstrap 3.

Breaking Changes

Please see the upgrade guide for more details on migrating from v4 to v5.

• React >= 16.8 is required
• Drop official support for Bootstrap 3
• Remove remaining references to findDOMNode (#415)
• Remove hintContainer and replaced with Hint component
• bsSize prop has been renamed to size (deprecated in v4.2)
• Remove getInstance (deprecated in v4.2)
• Increase specificity for multi-select component

Deprecations

• asyncContainer, menuItemContainer, and tokenContainer deprecated; renamed to withAsync, withItem, and withToken, respectively.
• selectHintOnEnter prop deprecated; use shouldSelect prop on Hint component or shouldSelectHint prop on TypeaheadInputSingle & TypeaheadInputMulti

Enhancements

• New useAsync, useItem, and useToken hooks
• Expose shouldSelectHint prop on input components
• useHint hook + callback for customizing hint selection (#330)

Internal + Documentation

• Remove UNSAFE_componentWillReceiveProps (#415)
• Remove BS3 code from examples
• Update dependencies
• Update react-overlays and add RootClose shim component (#415)
• Move RootClose component to main Typeahead file
• Remove extraneous type definition
• Rename and reorganize some files
• Improve test coverage
• Update documentation

Features

• Add useAsync & useToken hooks
• asyncContainer, menuItemContainer, and tokenContainer HOCs deprecated in favor of withAsync, withItem, and withToken

Internal + Documentation

• Drop .react extension from filenames
• Update docs to reflect new features
• Reshuffle some files

Features

• Expose shouldSelectHint prop on input components (TypeaheadInputSingle + TypeaheadInputMulti)

Internal + Documentation

• Update dependencies
• Update renderInput documentation
• Clarify and expand shouldSelect documentation
• Remove hintContainer and add useItem to docs
• Remove bsSize from docs

Breaking Changes

• Remove getInstance (deprecated in v4.2)
• Increase specificity of multi-input CSS rules to avoid accidental breaking (#542, #544; Thanks @evrimfeyyaz!)

Enhancements

• Add useHint hook + callback for customizing hint selection (#330)
• Deprecate selectHintOnEnter in favor of generalized callback
• Add useItem hook

Internal + Documentation

• Add documentation for new features
• Improve test coverage
• Remove extraneous type definition
• Add upgrade instructions for v5.0
• Remove references to BS4 since it's now the default

Bug Fixes

• Incorporate escape-string-regexp function (#540)
• Fix menu cycling (#545)