6.1.1

What's Changed

• Fix copy paste in docs by @Vestride in #497
• Fix some typos by @ydah in #555
• Fix missing types when resolving from exports field in package.json by @Schleuse in #561
• update dependencies by @Vestride in #562

New Contributors

• @ydah made their first contribution in #555
• @Schleuse made their first contribution in #561

Full Changelog: v6.1.0...v6.1.1

v6.1.0

New features

• The package.json now contains sideEffects: false to improve dead code removal and tree shaking.
  • https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free
• The package.json now contains an export-map to assist bundlers in choosing the correct file.

Bug fixes

• Update index.d.ts (in #402) to be more accurate with the real code.

Internal

• Shuffle is now a monorepo, built with turborepo (#399).
• Rewrote the website with Docusaurus.

Full Changelog: v6.0.0...v6.1.0

v6

Breaking

• Remove IE 11 from browsers list. If you need to support IE 11 (sorry), please use v5. Did you know Microsoft 365 apps and services stopped supporting IE 11 in August 2021?
• Remove matches-selector package and use the native matches (see browser support).
• Remove deprecated delimeter option (the misspelled one). Use the delimiter option instead.
• Replace window resize event listener with ResizeObserver (#321). Browser support for it is very good, but if you want to support a browser that doesn't have it, you can manually add a window resize event and call update() within the event callback.
  • Removed throttleit dependency
  • Removed throttle option.
  • Removed throttleTime option.
• Changed the method signature for update().

  -shuffle.update(true);
  +shuffle.update({ recalculateSizes: false });

• Changed how data attribute are accessed. Previously, Shuffle used element.getAttribute('data-groups'). Now, it uses element.dataset.groups. dataset is very well supported now.

New features

• Minified file size
  • Before: 20.8 kB
  • After: 16.9 kB
• Added force option to update method to force shuffle to update even if it's disabled (#321).

  shuffle.update({ force: true });
  

Other

• Convert demos to ES6 classes.
• Move browsers list to .browserslistrc.
• Add prettier
• Add BMC button.
• Remove polyfill.io links -- they add nothing with current versions of Chrome and others.
• Run sass division migration
• Remove dist files from git
• Recreate demos to codepen. Collection.
  • basic layout
  • homepage demo
  • compound filters
  • images
  • image problems
  • adding and removing
  • animated viewport entry
  • bootstrap 3 grid
  • bootstrap 4 grid
  • flexbox grid
  • with react
  • ajax
  • Shuffle v5 with IE9

v5.4.1

• Add sortedItems property which is the shuffle items in sorted order. Only visible items are in this array.
• Fix Chrome DPI bug described in #314 that was causing column sizes to be calculated incorrectly.

v5.3.0

Add isRTL option thanks to @AmirHosseinKarimi

Add TinyEmitter methods to TypeScript definitions

The TypeScript definitions were missing on, once, emit, and off because the definitions file did not have extends TinyEmitter. These methods now work correctly and contain type information for the data object in the event callback.

v5.2.2

Jest

Moved to jest for testing #278

TypeScript definitions #287

Fixes

• Fix bad default parameters for enable, update, and getSize.
• Fix missing Css export on Shuffle.ShuffleItem.Css.
• Fix Shuffle.ALL_ITEMS and Shuffle.FILTER_ATTRIBUTE_KEY not being overridable.

New

• Add types for .sort() method's options: SortOptions.
• Add types for .filter()'s function signature.
• Add types for ShuffleItem.Css.

Tests

• Add test ts file.
• Run tsc on test file during tests.

Breaking for TypeScript users:

• Changed all Element to HTMLElement.
• Shuffle.ShuffleOptions is now exported top-level.

  import Shuffle, { ShuffleOptions, SortOptions } from 'shufflejs';

Full changes: v5.2.1...v5.2.2

v5.2.1

Change typings to use default export #214

-export = Shuffle;
+export default Shuffle;

Upgraded dev dependencies to their latest versions:

• rollup
• terser
• babel
• eslint

Removed @odopod/eslint as I no longer have write access to Odopod's repos.

v5.2.0...v5.2.1

v5.2.0

• Fix for server side rendering #247. The test for whether the browser includes padding in width/height in getComputedStyle has been moved to a lazily-evaluated function instead of happening when the file is imported.
• Updated dev dependencies.

v5.1.2

Fix misspelled delimiter option. Both "delimiter" (correct) and "delimeter" (incorrect) will continue to work for v5. #215