Changes

🚀 Features

• Add JSON support to custom properties @brosua (#1001)
• Allow overwrite of the $choices-z-index variable @Moonlight-Angel (#1034)

🐛 Bug Fixes

• Fix support for non-Latin characters @ousmorez (#1072)
• Correct evaluation of HTML custom properties @brosua (#1001)
• Fix typo on aria-labelledby attribute @comxd (#1026)
• Fix type for parameter on setChoiceByValue @mtriff (#1021)

🔧 Maintenance

• Documentation: Add option "uniqueItemText" and "customAddItemText" to README @Sysix (#1051)

Contributors

@Moonlight-Angel, @Sysix, @brosua, @comxd, @mtriff, @ousmorez, David DIVERRES and Josua Vogel

Changes

🚀 Features

• Add option labelId to improve a11y @brosua (#971)

🐛 Bug Fixes

• Fix first character not appearing in webkit browsers @mtriff (#1010)
• Fix multiple select in Internet Explorer 11 @supermueller (#996)

🔧 Maintenance

• README Fix: Use select-single everywhere, fix missing comma in default options @mysliwietzflorian (#1000)

Contributors

@brosua, @mtriff, @mysliwietzflorian and @supermueller

Changes

🚨 Breaking changes

• Upgrade to Fuse v6 @mtriff (#991)
  • The fuseOptions have changed. See https://fusejs.io/api/options.html for details.
• Introduce allowHTML option to allow people to disable injecting HTML into choices. @victiondev (#984)
  • Previously all Choices elements were set using innerHTML. This had the potential to allow XSS attacks when loading items from external, untrusted sources. This behaviour has been deprecated. The new option allowHTML has been introduced, with the current default to true. The default will change to false in a future release. It is recommended that you set it to false unless you require HTML.
  • As a result of this change, callbackOnCreateTemplates now receives the full configuration object, instead of just classNames. The method signature to match previous versions is now ({ classNames }, data). See the documentation for the updated example.

🐛 Bug Fixes

• Trigger search when clearing the input field with search floor of 0 @daicambruzzi (#992)
• Remove character sanitisation when searching @isaac-mercieca (#990)
• Prevent browser autocomplete suggestions on Choices elements @bobmaerten (#908)
• Fix Sanitization of > Characters @rjorel (#983)

🔧 Maintenance

• Fix typings @mtriff, @victiondev (#985, #986, #987)

Contributors

@bobmaerten, @mtriff, @rjorel, @victiondev, @isaac-mercieca, @daicambruzzi

Changes

Although this is primarily a maintenance release, there have been a couple of large refactorings done (for example, conversion of the library to TypeScript). So, just to be cautious, this is a minor version bump.

🐛 Bug Fixes

• Resolve #780 @jshjohnson (#785)
• Resolve #774 @jshjohnson (#777)
• Resolve #762 @jshjohnson (#767)

🔧 Maintenance

• Switch to dart-sass, fix npm audit issues @mtriff (#979)
• Documentation of input type terms @trbroyles1 (#873)
• Solve deprecated warning using / for division outside of calc() @hans2103 (#976)
• Update README.md @flip111 (#844)
• Fix typo in README.md s/withing/within @JoshuaCrewe (#848)
• Update dependencies, fix GitHub Action workflows @mtriff (#977)
• Fix broken demo link in README.md @bzf (#975)
• Fix a typo in the README: s/seperates/separates @alexwlchan (#807)
• Update release drafter to latest @jshjohnson (#800)
• Convert to typescript @jshjohnson (#795)
• Adds a variable for the z-index @dgrammatiko (#794)
• Resolve #622 and #781 @jshjohnson (#784)
• Resolve #778 @jshjohnson (#783)
• Update polyfill list @jshjohnson (#765)

Contributors

@JoshuaCrewe, @actions-user, @alexwlchan, @bzf, @dgrammatiko, @flip111, @hans2103, @jshjohnson, @mtriff, @trbroyles1 and Joshua Crewe

Changes

🐛 Bug Fixes

• Fix #573 @kzkn (#574)

🔧 Maintenance

• Fix releases @jshjohnson (#761)

Contributors

@jshjohnson, @kzkn and GitHub Action

Changes

🚨 Breaking changes

• Add missing type definitions + rename sortFn @jshjohnson (#734)
• Fix #727 @jshjohnson (#731)

🐛 Bug Fixes

• Remove redundant event listener conditional @jshjohnson (#755)
• Resolve bug #637 @jshjohnson (#754)
• Always hide remove button if no value is selected @bronzehedwick (#744)
• Indent fixed in "choices__list--dropdown" @dios-oleg (#750)
• Resolve bug 473 @jshjohnson (#739)
• Resolve bug 533 @jshjohnson (#736)
• fix setChoices flow @tinovyatkin (#730)

🔧 Maintenance

• Typo. @agamemnus (#759)
• Commit and push built files to master @jshjohnson (#756)
• Upgrade Cypress to 3.6 and use cache in Github Actions @tinovyatkin (#748)
• Fix id types @jshjohnson (#743)
• remove safari test, update snapshots for new macOS, use dependency caching @tinovyatkin (#745)
• Enable test on Safari @tinovyatkin (#737)
• [bug] Override Prettier settings for Demo page @tinovyatkin (#733)
• [TEST] Automatic screenshots comparing and error checking in IE11, Firefox and Chrome @tinovyatkin (#715)
• Add documentation label + headings @jshjohnson (#729)
• Update GitHub action workflows @jshjohnson (#728)
• Fix lint @tinovyatkin (#723)
• Store config in file @jshjohnson (#722)
• Add release drafter @jshjohnson (#720)

🔧 Maintenance

• improve whole-page performance by scoping events handlers @tinovyatkin (#740)
• Code refactoring @jshjohnson (#735)
• speed up getAdjacentEl @tinovyatkin (#726)
• use CSS queries @tinovyatkin (#718)

Contributors

@agamemnus, @bronzehedwick, @dios-oleg, @jshjohnson and @tinovyatkin

This version contains multiple breaking changes:

• The ability to pass multiple elements to one instance of Choices has been removed - now only one element can be associated with Choices (https://github.com/jshjohnson/Choices/pull/693)
• The undocumented userDefaults static property has been removed
• The ajax method has been removed. setChoices can now be used to set choices dynamically - more info can be found in the README (https://github.com/jshjohnson/Choices/pull/701)
• The addItemFilterFn option has been renamed to addItemFilter and now supports regex's (https://github.com/jshjohnson/Choices/pull/699)
• Element.prototype.closest has been added to the required polyfill list (https://github.com/jshjohnson/Choices/pull/696)
• The .is-hidden class has been replaced with the hidden attribute (https://github.com/jshjohnson/Choices/pull/691/files)

This version also contains numerous bug fixes, type fixes + tooling improvements 🎉

Big thanks to @tinovyatkin for his contributions to this release!

https://github.com/jshjohnson/Choices/pull/617

https://github.com/jshjohnson/Choices/pull/608 https://github.com/jshjohnson/Choices/pull/648 https://github.com/jshjohnson/Choices/pull/642 https://github.com/jshjohnson/Choices/pull/644

Includes the following changes:

• https://github.com/jshjohnson/Choices/pull/548 - clearChoices is now a public method and passing an empty array to setChoices will also clear choices
• https://github.com/jshjohnson/Choices/pull/547 - fixes scrollbar bug in IE11
• https://github.com/jshjohnson/Choices/pull/536 - removes CustomEvent polyfill (bring your own polyfills instead)