Changelog

v5.8.1 (15 avril 2024)

• 📝 docs: update info on initialising ad-rotator
• 💸 Update funding info
• 💚 ci: remove circle CI
• 💚 ci: move to github actions
• 🔨 chore: mark package as sideeffect free

v5.8.0 (08 Oct 2023)

• 🧪 chore: block flaky tests in CI mode
• 🏷️ chore: fix typings for esm exports, update related doc
• 🔧📝 chore: lint before production build
• 🔨 chore: remove webpack, update deps, move to pnmp
• ✅ test: fix e2e tests
• ♻️ chore: refactor umd and es6 examples
• ✅ test: fix tests post vite migration
• 💥✨ feat: update exported named fn #breaking
• ⚡️💥 chore: install and configure vite
• 📈 docs: add reference to total downloads
• 👷 chore: replace travisCI with CircleCI
• 📝 docs: fix sticky Ad usage example

v5.7.0 (Aug 9th 2022)

• ✨🧲 feat: allow fixed/sticky positioning in config
• ✅♿️ test: setup accessibility tests
• 📝 docs: finalise playground page, sitemap and other minor details
• 📝✨ docs: Add api, styles and references pages
• ✨📝 docs: finalise the install, usage, config pages
• ✨📝💬 docs: revamp official documentation
• ⬆️ Upgrade Cypress to v10, tsconfig
• ⬆️ chore: upgrade jest, deps

v5.6.0 (June 2nd 2022)

• ✨ chore: Add a pull-request template
• 🔰 chore: Add security policy
• ✨🔧 chore: Add, configure issue-template
• 💵💰🪙 chore: Allow yourself to be funded
• ✨ feat: Add title prop to adunits to improve accessibility
• 🔥🗑️ Deprecate objectFit config option
• 📑 docs: Fix size details, rephrase sentences

v5.5.0 (April 30th 2022)

• 💫🩹 feat: update demo links, fix script loading order
• 💥🧾 feat: Split js and css assets, update doc
• 📝 docs: Add donate via paypal shield

v5.0.0 (Feb 22nd 2022) (2022022 -> palindrome + ambigram)

• 📝✅ chore: Add weights example to demo, add desktop test
• 📝 docs: cite info for weight param
• ✅ test: verify rotation with weights
• 🗑️🔥 chore: cleanup, refactor random number generation
• ✨⚡️🚧 feat: Add weight parameter
• 🔥💥📝✅ feat: deprecate height/width config params
• 📝💬🎨 docs: Update demo pages post deprecation of shape param
• 📝 docs: remove refs to shape config param
• 🔥✨⚡️🎨♻️💥 Deprecate shape config option, update dependencies, make images responsive

v4.4.0 (Feb 14th 2022)

• 📝 docs: Update readme
• ⬆️✅ Update dependencies
• Update bait element classlist to allow custom stlying
• 🔥⚡️🗑️ Decprecate unused types, remove unrequired debug msgs, update docs
• Remove unrequired fallback for Brave browser
• Setup codeql analysis
• ✅🔥📝 update demo, fix cypress tests, update doc
• ⚡️ Clear Source element and append html more efficiently
• ⚡️🔥✨ add fallbackMode as a boolean, updates types to exclude null
• 🔥 Remove unrequired style
• ✨⚡️ feat: Detect adblocker only when fallback mode is enabled
• Fix (temp) fallback mode for brave browser
• Add test for Brave browser
• ✨ feat: Add mode config to allow fallback with adblock
• Fix demo examples, refactor selectors

v4.3.0 (Sept 10th 2021)

• Fix e2e test for stickiness
• Fix calculation of sticky adverts
• chore: fix browser field in package.json

v4.2.0 (Aug 22nd 2021)

• 🐛 bugfix: fix remove api call
• ♻️ chore: refactor devices, onclick handler
• 🗑️ chore: deprecate the debug config option
• ♻️ chore: minor refactoring, remove unrequired try-catch blocks
• 🏷️ chore: generate and link types
• 📝 use bundlephobia size bagde
• chore: update version patch
• docs: update demo link
• docs: fix import statement

v4.1.0 (April 1st 2021)

• test: fix unit, e2e tests post timer update
• chore: refactor reusable functions into helpers
• feat: update preload time to 1s
• feat: set minimum rotator time to 2s
• docs: update config options to tabular format
• chore: make deploy script verbose
• chore: fix publish recipe

v4.0.0 (Mar 26th 2021)

• chore: move repo to digitalFortress, major version bump
• chore: Add deploy script
• feat: export stickyEl fn as a standalone one
• feat: refactor to named functions, update doc, deps
• chore: setup Cypress for Travis CI
• test: disable video generation in Cypress
• test: add e2e test for sticky advert
• test: add cypress test to verify rotation and hover
• test: setup Cypress e2e tests
• test: verify custom config props are set correctly
• chore: setup jest tests
• chore: refactor everything into typescript

v3.9.0 (Mar 23rd 2021)

• docs: minor version bump, update readme
• feat: Add prettier, update dependencies, use webpack 5

v3.8.0 (Sept 21st 2020)

• Add preloading of Images to allow smoother transitions
• Update eslint config to support promises/async-await
• Update npm dev dependencies, support async await

v3.7.0 (Sept 18th 2020)

• Add analytics to bootstrap demo
• Update Readme.md to include info about new bootstrap demo
• dynamically load dev/cdn version of the library (bootstrap demo)
• Add Readme.md for bootstrap demo
• Update bootstrap demo, menu, readme
• Remove unrequired checks, optimize sticky removal

v3.6.0 (Sept 13th 2020)

• Fix cleaning up of scroll refs

v3.5.0 (Sept 1st 2020)

• Add mobile, sidebar code snippets to bootstrap demo
• Optimize sticky event handler
• Add,config live examples, syntax-highlighter, 2 steps for bootstrap demo
• add scaffold for live examples page
• Update bootstrap demo homepage
• update sidebar demo
• Ad noMobile param to stickyAds
• make stickyEl fn standalone

v3.4.0 (Aug 31st 2020)

• Add onClick event handler for each Ad unit
• Add possibility to provide a onHover callback
• Use mouseenter/mouseleave en lieu of mouseover/mouseout
• Refactor stickyPub to stickEl, add validation

v3.3.0 (Aug 29th 2020)

• add and configure sidebar adverts for bootstrap demo
• bugfix: fix calculation of distance to top for sticky ads
• Add class stickyElx to stickyAds to allow fine-tuning
• add mobile adverts for bootstrap demo
• add transition effect for sticky ad
• Use clientWidth of root Element for mobile targets

v3.2.0 (Aug 27th 2020)

• Fix code examples in readme
• Add new bootstrap demo scaffold

v3.1.0 (Aug 25th 2020)

• Added the possibility to provide a custom callback cb config parameter that should be executed at each rotation
• deprecate and remove force-pause config param
• update README.md

v3.0.0 (Aug 24th 2020)

• Use IntersectionObserverAPI to rotate ads only when in view
• Add target config option to truly allow distinction between desktop/mobile ads
• Add support for mobile shape (sizing,definitions)
• Reset offsetTop for sticky adverts

v2.8.4 (Aug 20th 2020)

• Add fallback for sticky advertisement
• Add help recipe
• Fix Offset Top for sticky adverts
• Update dependent packages
• Fix vulnerabilities from dependencies
• Update Keywords
• Fix Demo

v2.8.2 (March 10th 2020)

• Fix browser Inclusion Path
• Add debug flag and silent fail for initilization error
• Update readme with licence bagde, downloads badge, maintained badge
• Update default timer to 5s

v2.7.1 (Feb 14th 2020)

• Add recipe to publish only production ready code to npm

v2.7.0 (Feb 13th 2020)

• Fix umd builds
• update webpack config
• update make recipe

v2.5.0 (Feb 13th 2020)

• Fix memory leak by removing references to non-existent DOM nodes
• Clear scroll event efficiently by keeping a reference in the event Manager

v2.4.0 (Feb 12th 2020)

• Fix sticky advert
• Move stickyPub into event Manager
• Fix unintended destruction of event

v2.3.1 (Feb 12th 2020)

• Add event manager
• Fix duplicate event creation
• Cleanup events correctly on destroy
• Update readme

v2.2.1 (Feb 11th 2020)

• Pause Rotation on hover
• Add resume() method to api

v2.1.0 (Feb 7th 2020)

• Add remove() method to api
• deprecate static config option
• Add newTab config option to allow opening advertisements in a new tab
• Add possibility to update configuration options post instantiation.

v2.0.0 (Feb 6th 2020)

• major refactor of api
• enable injecting new advertisements
• added api methods destroy(), add()
• rewrite sequential rotation logic
• clean up and remove global variables
• deprecate debug flag
• update start() api to be the only entry point for rotation
• update error generation mechanism
• permit multiple isolated instances of adRotator on the same page

v1.1.0 (Feb 5th 2020)

• add methods to pause, restart rotation
• add method to destroy, start rotation
• force static flag if only 1 advertisement provided
• Allow injecting new Ad item

v1.0.5 (Feb 4th 2020)

• Fix Travis CI
• Update Readme.md

v1.0.0 (Feb 3rd 2020)

• Initial release
• Rotates advertisements
• Supports dynamic/custom adverts