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 withHint
component bsSize
prop has been renamed tosize
(deprecated in v4.2)- Remove
getInstance
(deprecated in v4.2) - Increase specificity for multi-select component
Deprecations
asyncContainer
,menuItemContainer
, andtokenContainer
deprecated; renamed towithAsync
,withItem
, andwithToken
, respectively.selectHintOnEnter
prop deprecated; useshouldSelect
prop onHint
component orshouldSelectHint
prop onTypeaheadInputSingle
&TypeaheadInputMulti
Enhancements
- New
useAsync
,useItem
, anduseToken
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 addRootClose
shim component (#415) - Move
RootClose
component to main Typeahead file - Remove extraneous type definition
- Rename and reorganize some files
- Improve test coverage
- Update documentation