Skip to content

Latest commit

 

History

History
142 lines (91 loc) · 7.59 KB

CHANGELOG.md

File metadata and controls

142 lines (91 loc) · 7.59 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

[1.5.1] - 2023-12-23

Added

  • setOption(option, value) method to the API to fix issue that assigning values directly to the api.options object has no effect

[1.5.0] - 2023-03-04

Added

  • delete() method to the API to remove the latest entry. In multiple mode, can specify a selected entry. E.g. api.delete() to delete the last entry in the selected array, or api.delete(api.selected[0]) to delete a specific entry, or api.delete('some-value') to delete an entry with that specific value.
  • deleteAll() method to the API to delete all entries in multiple mode. If not in multiple mode, this will be the equivalent of calling delete() without an argument.

Chore

  • updated all dependencies

1.4.0 - 2021-03-27

Added

  • the ability to provide a function for the confirmOnBlur option that can return a string to compare against the search result labels.
  • page up and page down key handling within the options list to move the current focus position up or down by 10 options.
  • handling for disabled options, including ones based on disabled checkboxes and disabled select options.

Changed

  • adjusted the confirmOnBlur string matching behaviour to use the "cleaned" version of the search term and option label when blurring off of the field without a currently focused menu option.
  • defensive adjustment to setting the input value and moving focus to it after the component area is blurred.

Fixed

  • the create option when used as a function not being called with the API as context.

1.3.0 - 2021-03-07

Added

  • srDelay option to specify the delay before custom screen reader announcements are made. This now defaults to 1400 milliseconds, instead of 400 as before.
  • srAssistiveTextAutoClear option to allow the assistive text option to be removed when user input is detected, to decrease screen reader verbosity. The assistive text is re-associated with the generated input if its value is cleared.

Changed

  • increased the default srAutoClear value to 10000 milliseconds.

1.2.3 - 2020-11-01

Fixed

  • The create option not applying to starting values.
  • The create option persistence now correctly only applies when the autocomplete is used to progressively enhance a <select> or checkbox list.
  • Various HTML injection risks, particularly with the create and onItemRender options.

1.2.0 - 2020-10-31

Added

  • onChange callback option that fires when the selected item(s) changes, and provides all selections in an array as an argument.
  • onFocus callback option that fires when the overall component gains focus, and receives the component wrapper as an argument.
  • onBlur callback option that fires when the overall component loses focus, and receives the component wrapper as an argument.
  • id option to set a specific ID on the generated input
  • the function usage of the source option can now take a Promise which resolves with the items to render, instead of having to use the provided second argument callback
  • onAsyncBeforeSend callback option, to allow adjustments to the xhr object before it is sent (e.g. adding auth headers)
  • onAsyncComplete callback option, that fires after async call successfully completes and all items have rendered
  • srAutoClear option that takes a boolean, or number, to allow a delay before automatically clearing the screen reader announcement element - defaults to 5 seconds
  • deleteAllControl and deleteAllText options to render a button enabling quick deletion of all selected items (when there are at least 2 selected items)
  • create option to allow adding a results entry for the current search text (if no exact results match is found)
  • for all async related callbacks, and when the source is a function, there is now an additional final param that indicates if it is the first/starting call.
  • the selected items in multiple mode, and the show all button, will now have their aria-describedby set to link them to the control label

Changed

  • persist the aria-describedby attribute on the generated input, instead of removing it when the input has a value
  • in multiple mode, when deleting a selected item by clicking it or using enter, move focus to the next available selected item
  • set the aria-describedby attribute on the list container to reference the control's
  • do not hide the list when focus moves from the input to the show all control
  • moved the screen reader announcement element to be before the generated input, so that if users navigate past the input, they will not encounter the announcement element out of context

Fixed

  • The name option now works correctly.
  • In certain cases, the change event fired on the original input before the API's selected array was updated.
  • Added a workaround for an IE11 bug where the options were shown on load if the minLength was set to 0 on a multi-select autocomplete with starting values. This was due to the input's placeholder being removed, which erroneously triggers the input event in IE11.
  • Edge case errors when destroying the component immediately after certain actions (such as selecting an item, or blurring off of the component).
  • In multiple mode, moved the selected items to be after the list to fix issue on mobile when navigating by swipe, as it was possible to reach the selected items first, causing the list to disappear.
  • Issue with confirmOnBlur option not working correctly when a results option did not currently have focus.

1.1.4 - 2020-07-05

Fixed

  • TypeScript definitions not included in npm package

1.1.3 - 2020-02-04

Fixed

  • Issue where hitting the enter key after running a search with a value prevented the down arrow from moving focus to the first item in the results. Thanks to /u/holloway on reddit for discovering this.

1.1.2 - 2020-01-31

Fixed

  • Issue with autoGrow not triggering after deleting an item in multiple mode when the placeholder is re-added to the input

1.1.1 - 2020-01-29

Fixed

  • Issue where hide related classes were incorrectly being added to a select element's children, instead of to the select, due to a dependency issue

1.1.0 - 2020-01-29

Added

  • Home key usage to go to first item in the list
  • End key usage to go to last item in the list
  • onAsyncError callback option

Changed

  • Moved code and build over to TypeScript for: code improvements, self-documentation, and reduced bundle size by using an ES6 output from TypeScript that's bundled to UMD with webpack.

Fixed

  • Issue with the API filter method getting an error
  • Issue when clicking on a single-select autocomplete with minLength of 0 with a current selection, which was correctly searching with an empty string, but the polling method was then triggering a search with the value afterwards.
  • Screen reader announcements for results ignoring the number of results rendered