Skip to content

Commit

Permalink
v0.5.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Niklas Rämö committed Oct 27, 2017
1 parent bd476c5 commit df2de4a
Show file tree
Hide file tree
Showing 6 changed files with 929 additions and 22 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ website
/website
/demos
*.log
*.env
*.env
*.DS_Store
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Muuri is a magical JavaScript layout engine that allows you to build all kinds o

Muuri's default "First Fit" bin packing layout algorithm generates layouts similar to [Packery](https://github.com/metafizzy/packery) and [Masonry](http://masonry.desandro.com/). The implementation is heavily based on the "maxrects" approach as described by Jukka Jylänki in his research [A Thousand Ways to Pack the Bin](http://clb.demon.fi/files/RectangleBinPack.pdf). If that's not your cup of tea you can always provide your own layout algorithm to position the items as you wish.

Muuri uses [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) to power it's internal animation engine and [Hammer.js](http://hammerjs.github.io/) to handle dragging. And if you're wondering about the name of the library "muuri" is Finnish meaning a wall.
Muuri uses [Web Animations](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) to power it's internal animation engine and [Hammer.js](http://hammerjs.github.io/) to handle dragging. And if you're wondering about the name of the library "muuri" is Finnish meaning a wall.

**Features**

Expand Down Expand Up @@ -61,7 +61,7 @@ bower install muuri

### 2. Get the dependencies

* Muuri uses [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) to handle all the animations by default. If you need to use Muuri on a browser that does not support Web Animations yet you need to use a [polyfill](https://github.com/web-animations/web-animations-js). If you're feeling lucky you might be interested to know that it is possible to replace Muuri's default animation engine with your own implementation by overwriting the `Muuri.ItemAnimate` constructor.
* Muuri uses [Web Animations](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) to handle all the animations by default. If you need to use Muuri on a browser that does not support Web Animations yet you need to use a [polyfill](https://github.com/web-animations/web-animations-js). If you're feeling lucky you might be interested to know that it is possible to replace Muuri's default animation engine with your own implementation by overwriting the `Muuri.ItemAnimate` constructor.

* Muuri uses [Hammer.js](https://github.com/hammerjs/hammer.js) (v2.0.0+) to handle all the drag events. It is an optional dependency and only required if the dragging is enabled. Currently there is no easy way to use another library for handling the drag interaction. Almost all of the drag related logic exists within `Muuri.ItemDrag` constructor, which is instantiated for each item, so if you really need to customize the drag behaviour beyond what is available via the options you can replace the `Muuri.ItemDrag` constructor with your own implementation (fingers crossed).

Expand Down Expand Up @@ -1994,17 +1994,13 @@ First of all you should check out [the current questions](https://github.com/hal

Please [create an issue](https://github.com/haltu/muuri/issues/new) and explain the bug in detail. If possible create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and share a link to it. You can, for example, fork [this CodePen example](https://codepen.io/niklasramo/pen/jyJLGM) and modify it to demonstrate the bug.

**Is there a React/Vue version?**

Not yet, but it is planned. Hold on tight!

## Credits

**Created and maintained by [Niklas Rämö](https://github.com/niklasramo).**

* This project owes much to David DeSandro's [Masonry](http://masonry.desandro.com/) and [Packery](http://packery.metafizzy.co/) libraries. You should go ahead and check them out right now if you haven't yet. Thanks Dave!
* This project owes much to David DeSandro's [Masonry](http://masonry.desandro.com/), [Packery](http://packery.metafizzy.co/) and [Isotope](https://isotope.metafizzy.co/)libraries. You should go ahead and check them out right now if you haven't yet. Thanks Dave!
* Jukka Jylänki's research [A Thousand Ways to Pack the Bin](http://clb.demon.fi/files/RectangleBinPack.pdf) came in handy when building Muuri's layout algorithms. Thanks Jukka!
* Big thanks to the people behind [Web Animations API polyfill](https://github.com/web-animations/web-animations-js) and [Hammer.js](http://hammerjs.github.io/) for providing such awesome libraries. Muuri would be much less cool without animations and dragging.
* Big thanks to the people behind [Web Animations polyfill](https://github.com/web-animations/web-animations-js) and [Hammer.js](http://hammerjs.github.io/) for providing such awesome libraries. Muuri would be much less cool without animations and dragging.
* [Haltu Oy](http://www.haltu.fi/) was responsible for initiating this project in the first place and funded the intial development. Thanks Haltu!

## License
Expand Down
8 changes: 5 additions & 3 deletions muuri.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*!
* Muuri v0.5.0-dev
* Muuri v0.5.0
* https://github.com/haltu/muuri
* Copyright (c) 2015, Haltu Oy
*
Expand Down Expand Up @@ -3834,9 +3834,11 @@

}

// Set drag class, bind scrollers and emit dragStart event.
// Set drag class and bind scrollers.
addClass(element, settings.itemDraggingClass);
drag.bindScrollListeners();

// Emit dragStart event.
grid._emit(evDragStart, item, event);

return drag;
Expand Down Expand Up @@ -5372,7 +5374,7 @@
*/

/*!
* muuriLayout v0.5.0-dev
* muuriLayout v0.5.0
* Copyright (c) 2016 Niklas Rämö <[email protected]>
* Released under the MIT license
*/
Expand Down
4 changes: 2 additions & 2 deletions muuri.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit df2de4a

Please sign in to comment.