Changelog

Release Notes

v5.4.0 (18 Nov 2024)

• 📝 docs: update docs for updateHits hook with new parameters and return flags
• ✨ feat: add possibility to update search index from within the updateHits hook
• ✨✅ feat: display loader within hooks if necessary
• 📝 docs: add docs for hooks config option
• ✅ test: add test for updateHits hook
• ✨ feat: add hook to allow overriding search results
• 🐛 fix: broken hints with aplinejs or htmx. Closes #85

v5.3.2 (03 Oct 2024)

• 🩹 fix: resize list container when the inputs size changes. Fixes #88

v5.3.1 (26 Sep 2024)

• ✅ test: verify selection of default items via keyboard navigation
• 🐛 fix: submit items from empty list correctly. Fixes #86

v5.3.0 (23 July 2024)

• ♻️ chore: minor refactoring of retainFocus option and its docs
• feat: add retainFocus config parameter (#83)

v5.2.0 (25 June 2024)

• 🔖 minor version bump to v5.2.0
• 🩹 fix: keyboard navigation via tab key
• 📝 docs: add details about listScrollOptions config param
• ✨ feat: add listScrollOptions config parameter
• 🚨 chore: fix eslint config and reported errors
• refactor vite config to ts
• fix: only scroll window if selected suggestion is out of view
• ✅ test: refactor js unit test files to ts
• 🗑 chore: remove unused e2e tests
• 🔧 chore: update meta data for test pages
• fix: remove tabindex from tt-list

v5.1.0 (21 June 2024)

• 🐛 fix: remote url being as callback. Fixes #80
• 📝🩹 chore: clarify docs, fix trie example
• 🔍️ chore: update sitemap to include demo website
• 📝 docs: update version info

v5.0.0 (14 June 2024)

• ⚙️ chore: set highlight config option to true by default
• ⚡️ chore: limit input query tokens to improve performance
• 📝 chore: add example to test performance
• 💥 chore: refactor items to hits for clarity
• ♻️ chore: cleanup unrequired assignments
• 📝 docs: add details about support for nested properties for groupKey config option
• ✅ test: added e2e test for groupKey
• ✨ feat: add support for nested keys when using the groupKey
• 📝 docs: add usage details of nested keys
• ✅ test: add e2e test for validating usage of nested keys
• ✨✅ feat: add support for nested keys
• 🦺 chore: mark package as side effect free
• 🩹 fix: highlight all search terms correctly
• ♻️ chore: refactor accessibility tests to use esm version
• 🏷️ chore: correct esm /umd typings
• 🧑‍💻 chore: add recipe to generate packed version for testing types
• ⬆️ chore: upgrade dependencies
• 📝 docs: add details for trie internal methods
• 💥 chore: refactor container to wrapper in the resultSet
• 💥 feat: use return value of empty template to display default suggestions/custom html
• 🎨📝 docs: add details about tokenizer, minor styling
• ✅ test: add unit + e2e tests for tokenizer
• ✨ feat: add tokenizer config option
• 📝 docs: replace artifacts of identifier and dataTokens
• 💥 chore: replace groupIdentifier by groupKey
• 💥 chore: replace identifier and dataTokens by keys
• 📝 docs: update readme, doc site
• ✅ test: fix tests post removal of deprecated items
• 💥 chore: move config debounceRemote into remote config
• 💄 style: add shadow, curved borders and max height for suggestion list
• 🗑️ chore: remove config classname in favor of wrapper class
• 🩹 fix: highlight multiple words irrespective of order for multiple queries
• ⚡️ feat: optimise code for speed, early exits, misc efficiency updates
• ⚡️ feat: optimize the search function of trie
• ⚡️ feat: improve performance of the find fn within the trie
• ⚡️ feat: opmitize performance

v4.26.0 (03 May 2024)

• 📝 docs: update readme and version history
• 🔖 minor version bump to v4.26.0
• 🐛 fix: export entire dist directory
• 🐛 fix: expose stylesheet correctly
• 🔖 patch version bump to v4.25.3
• 🩹 fix: docs and package json entry points
• 🚨 [HOTFIX] revert to .js as cjs returns unwanted headers on CDN

v4.25.1 (14 Feb 2024)

• 📝 Add JS-docs and examples to typings
• 💚 ci: fix caching cypress binary
• 🏷️ Split types into separate files
• 📝 docs: add info to type definitions
• 🏷️ Fix typescript types

v4.25.0 (10 Feb 2024)

• 🙈 add cypress downloaded to gitignore
• 💚 split CI jobs, run unit tests as well
• ✨🔥⚡️💚 feat: update packages, add es6 dev mode, fix CI
• 🔥✨🏗️ chore: migrate to vite, vitest and pnpm. Fixes #63
• 💸 Update funding info

v4.24.0 (07 Feb 2024)

• 📝 docs: update template info on config page
• 🗑️ remove circle CI. Update docs
• 💚 add github action workflow to build and test
• ✅ test: navigate default suggestions
• 🐛 fix: sorting by query and group behavior
• ✅ fix e2e tests
• Add info about defaultItems in resultSet
• Fix keyboard navigation for default items (Thanks to @amritapathak89 )

v4.23.0 (31 Aug 2023)

• ✨ feat: provide input to url callback for remote calls. Fixes #66

v4.22.0 (08 Jun 2023)

• ✅ test: add tests for APIs
• 📝 docs: add details about the reset and addToIndex api
• ✨🎉 feat: expose addToIndex and reset methods

v4.21.0 (20 May 2023)

• 🚨 chore: remove unsafe chaining (courtesy: eslint)
• ✅ test: navigate to link within suggestion template
• 🩹 fix: enable event default behaviour on suggestion click
• ✅ test: add test to check handling of Esc key, fix broken tests post upgrade
• ♿️ chore: fix accessibility issues with list header/footer
• ⬆️ chore: upgrade Cypress, axe and npm audit fixes
• 📝 docs: add details about user input event
• 📝 docs: replace travis-CI badge with circle-CI badge
• ✅ test: user input event is emitted via click and via keypress
• ✨ feat: emit a custom input event when a suggestion is selected. Fixes #60

v4.20.1 (08 May 2023)

• 📝 docs: update CI badge details
• 🗑️ chore: remove travis CI config
• 👷 feat: Add .circleci/config.yml

v4.20.0 (07 May 2023)

• 🐛 fix: handle input event correctly for Firefox Android #54

v4.19.0 (16 April 2023)

• 🐛 fix: FF mobile handle input event being called incorrectly. Fixes #54
• 🩹🎨 fix: positioning of the list and the hint element
• 🎨💄✨ style: refactor to use flexbox instead of absolute positioning
• Revert "♻️ chore: remove unrequired value from boolean attrs"
• 🐛 fix: remove aria-label from hint. Fixes #53
• ♻️ chore: remove unrequired value from boolean attrs
• 🩹 fix: use semantic html, replace span by div

v4.18.0 (17 March 2023)

• 🩹 fix: set list width in pixels to support firefox within offcanvas. Fixes #47
• 📝 docs: add details about the new classNames config object
• ♻️ chore: deprecate className and reuse the new classNames config for wrapper class
• ♻️ 🏷️chore: refactor classnames, better typing
• Allow setting custom class names (#51)
• ♻️ chore: improvise isObject helper
• ♻️ chore: refactor fetchWrapper to use better typing
• 🗑️♻️ chore: remove deprecated kbd event props
• ♻️ chore: refactor kbd event handler

v4.17.0 (06 Feb 2023)

• 📝 docs: add usage details for empty template
• ✅ test: add e2e tests for empty template mgmt
• ✨💫 feat: allow custom html to be used in an empty template
• ✨ feat: inject entire DOM wrapper into the resultSet
• ✨ feat: Add empty template to display default suggestions
• ♻️⚡️ chore: refactor no suggestion handler
• ✅ test: add e2e test to ensure empty templates are not injected into the DOM
• 🩹 fix: inject only truthy templates into the DOM

v4.16.0 (01 Feb 2023)

• 📝 docs: Add usage details of resultSet within templates
• ✅ test: add e2e test for template resultSet
• ♻️ chore: move limit option to resultSet
• ✨🎨 feat: pass resultSet to templates for fine-tuning
• ✨ feat: add suggestion total count to the result set
• ✨✅ feat: update trie to return count, fix unit tests
• ♻️ chore: refactor to use a resultSet

v4.15.0 (31 Jan 2023)

• 📝 docs: add loader template details
• ✅ test: add e2e tests for loader template
• ✨ feat: Add a loader template

v4.14.1 (06 Jan 2023)

• 🩹 fix: update target to support webpack 4.x
• ♻️ refactor: search fn within trie
• 📝 docs: fix typo in hint config

v4.14.0 (Nov 9th 2022)

• 📝 docs: additional styling while disabling hint
• ✅ test: verify non-existence of hint element in DOM when hint is disabled
• 🩹 fix: render hint element only when enabled. Fixes #38
• 🔨 chore: improve url check

v4.13.0 (Nov 4th 2022)

• 📝 doc: update doc with possibility of remote/prefetch url being a callback
• ✅ test: Add test to ensure dynamic get params get passed as expected
• ✨ feat: Allow modifying GET request on the fly

v4.12.0 (Sept 16th 2022)

• ✅ test: e2e to ensure newly loaded remote data undergoes deduplication
• 🗑️ chore: deprecate limit flag from internal search
• ⚡️⚡️⚡️ feat: improve perf by removing array deduplication
• ✨ feat: coerce datatokens to string
• 🩹 fix: consistent behavior of onSubmit callback via keyboard/mouse

v4.11.0 (Sept 7th 2022)

• ✅ test: onsubmit hook for kbd/mouse selection
• 🩹 fix: consistent behavior of onSubmit hook. Fixes #30
• 📝✨🔍️ docs: Add new submenu listing nav
• 📝 docs: update display callback description

v4.10.0 (Sept 5th 2022)

• 🐛 bugfix: keyboard navigation for cached results. Fixes #28

v4.9.0 (Aug 25th 2022)

• ✅ test: Add test to ensure typeahead el gets added at the original position in the DOM
• 🐛 fix: positioning of typeahead el wrt siblings

v4.8.0 (Aug 23rd 2022)

• ✅ test: verify event retention
• 🐛 fix: ensure retention of original input event handlers. Fixes #26

v4.7.0 (Aug 23rd 2022)

• 🐛 fix: keyboard navigation when suggestion list is not open
• docs: 🩹 fix copy link on install page
• ⬆️ chore: upgrade jest to v28
• 📝 docs: add info about WAI-ARIA support
• ✅🧪 test: setup accessibility testing with cypress-axe
• ♿️ feat: complement aria attrs for list and hint elements
• ⬆️ chore: upgrade dev dependencies
• ♿️ feat: setup WAI-ARIA
• 📝 docs: update playground pg

v4.6.0 (July 22nd 2022)

• ⚡️ test: finalize dev test
• ✨ feat: autoscroll to selected item during keyboard navigation
• 🧪 feat: Add dev test page
• chore: move assets into demo directory
• ✨ docs: add scroll to top btn
• 📝 docs: update playground examples
• 🐛 fix: Ensure diacritics works correctly with suggestion data
• 🌱 docs: add playground examples
• 📝🎨🔍️ docs: Add sitemap, robots.txt, 404 template
• 📝 docs: Add section links to all pages
• ✨🔍️📝 docs: add internal section link nav handling
• ✨🌐 feat: Add language diacritic support
• 🌐 docs: Add info about browser support
• 🩹 fix: recalculate sticky position on fragment load for docs

v4.5.0 (July 11th 2022)

• 📱 docs: Add mobile sub nav
• ♻️🗑️ Deprecate klipse plugin and use codepen prefill embeds
• ⛹️‍♂️ docs: Add page playground
• 📝 docs: Add instructions for References section
• 💄 docs: Add instructions for styling
• 📝 docs: update missing config params
• 🐛 fix: Deduplicate space separated suggestions correctly
• ✨ docs: Add config page details
• 🎨 docs: update cover image and tag line
• ✨💄 docs: Add page to list configuration options scaffold
• ✨🎨🔥 docs: Add usage instructions
• ✨🎨 docs: Finalise install page
• 🎨💄 style: Add styling/handling for code blocks and tabs
• ✡︎ docs: Update tags to include trending stuff
• ✪ docs: Add installation instructions
• ✷ Add intro page for demo
• docs: update base page
• 🎉🔥 feat: Add docs scaffold SPA
• 🔍️ update meta tags for demo, add main img
• 💄 style: update nav-submenu spacing
• 🎨✨ style: update link styling for examples page
• ⚡️🎨 feat: Add smooth scroll to internal links of demo pg
• ✨💄 feat: Add a navigable menu for demo page
• 🎨 style: Add favicon for demo example page
• 🚧 fix: update css for code-mirror, reduce css load priority

v4.4.0 (June 22nd 2022)

• ✅🧪 test: add test for custom display fn with handling for optional 2nd arg
• 📝 docs: add details for Event arg in display callback
• ✨ feat: pass event arg to display callback

v4.3.0 (June 9th 2022)

• 🐛 fix: escape regex chars within the hint correctly
• 🛡 chore: Add security.md
• 🔨📝✨ chore: Add issue, PR templates/config & funding info
• 🏷️ Improve typings for Trie, es6 trie updates
• 🩹 verify that source is an object
• 🏷️ chore: Update typeahead data source types

v4.2.0 (June 2nd 2022)

• 🦸‍💪⚜️ Refactor code, deprecate IE focus evnt, fail early for malformed args

v4.1.0 (May 6th 2022)

• ⚡️✨ Handle collisions correctly, add identity config option
• 📑 docs: update package highlights
• 🩹 fix: fix script loading order for demo
• 🔖 patch version bump to v4.0.1
• 📝 docs: Fix install doc CDN links and misc typos

v4.0.0 (April 28th 2022)

• ⚡️ feat: optimize highlight function
• 🗑️ Deprecate and remove global debounce timeout
• ♻️✅ refactor update callback, add test for focus event
• ♻️~🗑️ refactor: Deprecate containerVisible method
• ✨⚡️ feat: Separate css and js assets 💥 Breaking Change
• ✅ test: Add e2e tests for transform callback (on Prefetch, Remote)
• ♻️ refactor: named functions to named const es6
• 🩹✅ fix: handle storedInput correctly
• ✅ test: fix e2e tests, fix sort
• ✨♻️ feat: update keyboard handling mechanism to provide better hints on selection
• ⚡️ fix: remove double sorting whilst using groups
• 🔥 Standardize all templates to be callbacks 💥Breaking Change
• ✨🔥 feat: cache remote response for non-trie matches
• 🗑️⚰️ Deprecate, remove datastore
• ✨✅📝 feat: Add process hook for prefetch source, update tests/docs
• ⚡️📝 feat: improve transform callback handling, update docs
• ✨ feat: update onSubmit config param to pass selected item if available
• ✨🗑️ feat: add display config option and deprecated onSelect 💥 BreakingChange

v3.6.0 (April 24th 2022)

• ✅📝 Add docs, tests for onSubmit callback
• 🐛 Fix highlight input pattern
• ✨ Add onSubmit config param
• ✨ Allow propogation of events to allow multiple click handlers
• 🩹 Fix closing order of suggestions list
• 📝 docs: Add donate via paypal shield

v3.5.0 (Dec 28th 2021)

• ✅ test: check requestOptions for fetch API
• ⚡️ optimise fetch wrapper options and add requestOptions to prefetch
• Added docs for request options
• Added requestOptions to remote

v3.4.0 (Dec 25th 2021) Christmas

• ✅ test: Add test for check sorting preference, sort by groups
• ✅🩹 test: Fix broken tests
• ⚡️🐛 fix: avoid redrawing of list when groups exist, improve sorting
• ✨ Sort suggestions by giving preference to start of the query
• ⚡️ refactor: improve setting of classes
• 🐛 fix: remove hardcoded value in favor of param
• 🩹 fix: remove stickyness for mobile devices

v3.3.0 (Dec 22nd 2021)

• ✨ feat: Make gAdvert sticky on demo page
• 📝 docs: Add basic example preview
• ✅ add test to verify suggestions for queries entered in reverse order
• 📝🩹 Fix demo links, update doc
• ♻️ use better api calls for e2e tests
• ✅ Add test to check hint for multiple space separated queries
• 🐛 fix hint generation for multiple-queries
• ⬆️ Upgrade dependencies and fix vulnerabilites in packages

v3.2.0 (Dec 12th 2021)

• 👽️🧑‍💻 Update demo to use local prefetch resource
• 🐛 Fix Ajax example for demo
• Add list of countries for online example
• chore: fix browser field in package.json
• Setup code scanning analysis workflow

v3.1.0 (Aug 21st 2021)

• ✅ test: Fix broken e2e test
• 🗑️ chore: cleanup, deprecate code
• ♻️ chore: minor refactoring to arrow functions
• ✨♻️ feat: add autoSelect suggestion config option
• 🔥 chore: remove redundant code
• ✨🔥 feat: deprecate autoselection of first suggestion, update hint mechanism
• 🌐📝 Add error codes
• 📝🐛 fix: make dev form submit, update doc

v3.0.5 (July 6th 2021)

• 🐛 Fix local source type
• 🔨 copy types.d.ts manually within a script
• 🏷️ expose typescript types
• 📝 use bundlephobia size bagde
• chore: bump patch version
• docs: update live demo link
• 💄 chore: remove unrequired setting of position

v3.0.0 (May 14th 2021)

• 🐛 bugfix: Fix backfilling of remote suggestions
• ✨🎨📝 update demo
• 📝 docs: update Readme
• 🎨 refactor: add deduplicateArr helper method
• 🐛 bugfix: filter submitted form data
• ✨🔥⚡️ optimise trie methods and fix dependents
• ✨ feat: add dataTokenizer, query tokenizer
• ✨🔥 feat: optimize trie
• ✅ test: update e2e test
• 🔥✨✅🍱 feat: setup end to end tests with Cypress
• ⚡️🔥✨ sort items when groups are used, deduplicate matches
• bugfix: verify that group label is displayed only once
• bugfix: display hint only for query matches
• ✨🐛⚡️ feat: Add support dataTokens config options
• optimize check for existing templates
• deprecate normalizer config option
• ✨💥🏗️ feat: allow using any prop as display label
• update trie addAll method to accept dynamic identifier
• use helper function to check objects
• chore: transfer repo to digitalfortress
• docs: add link to config params

v2.4.0 (Mar 22nd 2021)

• docs: fix syntax error in doc
• feat: refactor startEvent param to when, update dependencies
• chore: deprecate trailing flags

v2.3.0 (Feb 23rd 2021)

• Add example of prefetched data to Demo
• Add support for prefetching data
• Add fn to check for LS support
• update readme.md for readibility

v2.2.0 (Nov 26th 2020)

• Deprecate debounceWaitMs config option and EventTrigger
• docs: improve, clarify readme.md
• Render not found template immediately if remote request was cached
• hide suggestions list via a class

v2.1.0 (Nov 21st 2020)

• Fix destruction of the typeahead instance correctly
• Merge suggestions correctly while using local+remote data sources
• Bugfix: Fix noResults template rendering multiple times when on fully local
• update demo examples to be compatible with v2.0.0

v2.0.0 (Nov 19th 2020)

• Update readme.md for major version
• check noSuggestionCb() immediately in update hook
• use frozen input as the cache string
• render notFound template only when remote results are available
• Better handling of noResults templates, check-templates existence earlier
• optimize checks for existence of remote
• deprecate updateScroll() method
• Make listContainer to stay in DOM, play only with visibility
• Add remote debounce config option
• Add suggestion retrieval from remote
• Add possibility to limit items found in trie
• integrate trie search with typeahead, deprecate config.fetch()

v1.9.0 (Nov 14th 2020)

• update typeaheadSource type, test fetchWrapper
• refactor to use async, await. Remove unrequired post method from fetchWrapper
• Add fetchWrapper
• update trie algorithm to add multiple words, update tests
• move onSelect handler to helper
• Add unit test for normalizer
• Add normalizer and normalize local data
• Add new config option - normalizer
• Add unit test for trie
• Add, configure Jest unit testing
• Add/use trie data structure algorithm for autocomplete
• update search input type from text to search
• Add templating JS fiddle as the 3rd example

v1.8.0 (Nov 9th 2020)

• update Readme to clarify overriding styling
• Deprecate keyup listener in favor of input listener
• rename variables for greater clarity
• Style demo search item box by its templates
• Add custom class to wrapper element instead of list container

v1.7.0 (Nov 5th 2020)

• Style demo and use in-house code editor
• update demo dev mode handling
• fix: selectPrev, selectNext when handling limited suggestions
• Add, config group template. Deprecate renderGroup config option
• Add notFound template, deprecate emptyMsg, wrap header, footer templates
• Add support for header and footer template
• deprecate render config option
• Add templates for suggestions

v1.6.0 (Oct 28th 2020)

• Deprecate showOnFocus config option
• Fix showOnFocus config option
• Deprecate resize event handler
• deprecate scroll event handler

v1.5.0 (Oct 27th 2020)

• Add example demonstrating ajax requests
• deprecate customize config param
• if raw input is empty, clear everything immediately
• use selected item on tab
• improve scroll perf
• Update position of listbox, update classnames

v1.4.0 (Oct 26th 2020)

• Update wrapper classnames
• Add, config hint option to typeahead, update types
• normalize user input
• Undo perf tweak
• improve perf of highlighting text

v1.3.0 (Oct 22nd 2020)

• Auto-select first suggestion by default
• Add support for highlighting text
• Add limit config option to limit suggestions, set target to es6 update readme badges

v1.2.0 (Oct 21st 2020)

• Select by default only when a single suggestion is available
• prefix tt-* to all classnames for exclusivity
• refactor settings to config, update dependencies
• Provide a default onSelect fn, add helpers

v1.1.0 (Oct 20th 2020)

• Update Demo to include live example, add tracking
• upgrade all dev packages

v1.0.0 (Oct 19th 2020)

• Add constants, fix types, update readme
• Refactor styling, update demo
• split typeahead interfaces
• remove deprecated webpack conf, lint
• Add demo
• Add autocompletion, squash
• add, config typescript, eslint, tslint, prettier
• Add first public version