v5.0.0-rc.1

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

v4.2.3

Bug Fixes

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

v4.2.2

• Fix outdated yarn.lock file
• Update flow version

v4.2.0

Bug Fixes

• Fix keyboard navigation in StrictMode (#530)

Deprecations

• Deprecate getInstance
• Deprecate bsSize prop

Enhancements + Feature Requests

• Accept node for newSelectionPrefix and paginationText (#535)
• Add toggleMenu callback

Internal + Documentation

• Upgrade dependencies
• Update how tests access the component instance
• Add community examples section to README (#455)
• Fix anchor links in upgrade guide
• Remove duplicated labelKey tag in docs (Thanks @atefBB!)

v5.0.0-alpha.1

Breaking Changes

• Drop support for React < 16.8.
• Drop official support for Bootstrap 3. Among other things, this consists of updating the HTML structure and class names of included components like MenuItem in a backwards-incompatible way. Note that if you are using BS3, things should still work, but you may need to render your own menu, menu item, and input components.
• Remove deprecated use of findDOMNode (#415). In some cases, this now requires explicitly passing refs to underlying DOM nodes. If using renderInput, you will need to pass the referenceElementRef prop to a DOM node. This will usually be the input itself, but may be a container node. When using custom tokens, you will need to pass the ref from tokenContainer to the token DOM node.
• Convert hintContainer to Hint component
• Rename bsSize prop to size

Enhancements

• Remove UNSAFE_componentWillReceiveProps (#415)
• Update react-overlays and add RootClose shim component (#415)
• Update token and multi-input CSS to better match BS4

Internal

• Refactor some components to SFCs using hooks

v4.1.0

Bug Fixes

• Don't perform results logic when menu is hidden
• Reset state.initialItem when hiding menu
• Fix Flow type import

Internal

• Upgrade flow-bin + rollup
• Upgrade minor versions of dependencies
• Use React.Fragment instead of array
• lodash.isequal -> fast-deep-equal (~8% pkg reduction)
• Pass input node to hint container via context
• Update Typeahead child function signature
• Move reference element ref to main component
• Move RootCloseWrapper to main component
• Simplify ref flow types

v4.0.0

Breaking Changes

See the upgrade guide for details on how to migrate to v4.0:

• Require React >=16.3.0
• Remove create-react-context & react-lifecycles-compat dependencies
• Remove ability to hide menu via falsy emptyLabel value
• Drop menuId in favor of id and make required for a11y
• Updates to Overlay API; use positionFixed prop instead of bodyContainer
• Remove onMenuHide and onMenuShow; use onMenuToggle prop instead
• Fix default for autoComplete attribute (#413)
• Remove a11y announcer (a11yNumResults & a11yNumSelected)(#301, #321)

Bug Fixes

• Disable root close when token is inactive
• Fix hint alignment issues (#501, #515)
• Revert back to componentWillReceiveProps (#437)
• Fix input focus bug when tabbing
• Don't render interactive token if it is disabled
• Fix undefined Element during SSR (#522)
• Fix a11y issues in component + examples (#517)
• Fix useCache bug (#520, #521 - Thanks @jbialobr!)
• Fix custom option id incrementing
• Update keydown behaviors
• Don't filter results when menu is closed
• Fix lib files not being included in package
• Fix invalid aria values (#438)
• Fix updating active index when result order changes
• Prepend menu id to menu item id for uniqueness

Feature Requests + Enhancements

• Include .scss files in package (#486)
• Include ES module files in package
• Allow event handlers to be passed to Token (#467, #471)
• Remove findDOMNode from tokenContainer (#415)
• Add readOnly prop to Token
• Use forwardRef in MenuItem
• Forward refs within input components
• Publicly expose lower-level input components
• Pass option to tokenContainer for onRemove
• Render tokens as child of TypeaheadInputMulti
• Update .npmignore to omit unnecessary files/folders from package
• Add renderInput prop and expose hintContainer (#316)
• Allow style prop to be passed to top-level element

Tooling

• Update eslint-config + lint rules
• Use Rollup for build, reduce umd package size by ~16%
• Add Flow and annotate code
• Use Jest for testing + add tests
• Add code coverage reports and configure with Coveralls + Codecov
• Add husky and lint-staged for git hooks

Internal

• Update bsSize handling
• Pass limited state down to menu & input
• More consistent naming
• Reduce lodash footprint
• Update CSS build script
• Add homepage and files to package.json, remove .npmignore
• Update pagination option handling
• Rename inner typeahead component
• Drop Node 6 & 8 testing; add Node 12
• Update dependencies
• Use scroll-into-view-if-needed package
• Simplify inputs + styles
• Simplify Highlighter component
• Consolidate propTypes
• Use terser instead of uglify for minification
• Add state modifier functions
• Return strings/arrays from Highlighter component instead of wrapping with span
• Re-organize file structure
• Refactor internals to move towards a more modular and declarative API
• Create a core set of components for better modularity
• Better separation of typeahead and rendering logic

Examples & Docs

• Default examples to Bootstrap 4
• Update examples to use SFCs + hooks
• Fix w3c validation
• Update rendering and pagination examples
• Add sandbox link to bug report template
• Remove deprecated lifecycles
• Fix scrollspy behavior
• Update Markdown component
• General improvements and updates to documentation

v4.0.0-rc.2

Bug Fixes

• Fix undefined Element during SSR (#522)
• Fix a11y issues in component + examples (#517)
• Fix useCache bug (#520, #521 - Thanks @jbialobr!)

Enhancements + Feature Requests

• Include .scss files in package (#486)

v4.0.0-rc.1

Breaking Changes

• Require React >=16.3.0
• Remove create-react-context dependency
• Remove react-lifecycles-compat dependency
• Return strings/arrays from Highlighter component instead of wrapping with span

Bug Fixes

• Fix hint alignment issues (#501, #515)
• Revert back to componentWillReceiveProps (#437)
• Fix input focus bug when tabbing
• Don't render interactive token if it is disabled

Feature Requests + Enhancements

• Allow event handlers to be passed to Token (#467, #471)
• Remove findDOMNode from tokenContainer (#415)
• Add readOnly prop to Token
• Use forwardRef in MenuItem
• Forward refs within input components
• Publicly expose lower-level input components
• Pass option to tokenContainer for onRemove
• Render tokens as child of InputMulti

Internal + Documentation

• Drop Node 6 & 8 testing; add Node 12
• Improve API documentation
• Update dependencies
• Improvements to Flow typing
• Use terser instead of uglify for minification
• Add state modifier functions
• Update eslint-config
• Fix broken tests

v3.4.7

Bug Fixes

• Fix query not set with initial input value (#479)
• Set NODE_ENV=production for production builds (#482)
• Fix Firefox bug when deleting tokens with backspace (#484)

Documentation

• Link TypeaheadMenu to its implementation in Docs (#481, Thanks @mcampagonzalez!)
• Update Rendering docs

Internal

• Update dependencies
• Update TravisCI config to fix failing tests