/Masonry

Layout UI addon that brings power of Masonry JavaScript library to Vaadin 7

Primary LanguageJava

Published on Vaadin  Directory Stars on Vaadin Directory

Masonry Add-on for Vaadin 7

Masonry is a cascading grid layout add-on for Vaadin 7.

Build Status

Online demo

Try the online add-on demo at app.siika.fi/MasonryDemo or siika.fi:8080/MasonryDemo

Download release

Official releases of this add-on are available at Vaadin Directory. For Maven instructions, download and reviews, go to http://vaadin.com/addon/Masonry

Building and running demo

git clone https://github.com/alump/Masonry.git mvn clean install cd demo mvn jetty:run

To see the demo, navigate to http://localhost:8080/

Development with Eclipse IDE

For further development of this add-on, the following tool-chain is recommended:

  • Eclipse IDE
  • m2e wtp plug-in (install it from Eclipse Marketplace)
  • Vaadin Eclipse plug-in (install it from Eclipse Marketplace)
  • JRebel Eclipse plug-in (install it from Eclipse Marketplace)
  • Chrome browser

Importing project

Choose File > Import... > Existing Maven Projects

Note that Eclipse may give "Plugin execution not covered by lifecycle configuration" errors for pom.xml. Use "Permanently mark goal resources in pom.xml as ignored in Eclipse build" quick-fix to mark these errors as permanently ignored in your project. Do not worry, the project still works fine.

Debugging server-side

If you have not already compiled the widgetset, do it now by running vaadin:install Maven target for Masonry-root project.

If you have a JRebel license, it makes on the fly code changes faster. Just add JRebel nature to your Masonry-demo project by clicking project with right mouse button and choosing JRebel > Add JRebel Nature

To debug project and make code modifications on the fly in the server-side, right-click the Masonry-demo project and choose Debug As > Debug on Server. Navigate to http://localhost:8080/Masonry-demo/ to see the application.

Debugging client-side

The most common way of debugging and making changes to the client-side code is dev-mode. To create debug configuration for it, open Masonry-demo project properties and click "Create Development Mode Launch" button on the Vaadin tab. Right-click newly added "GWT development mode for Masonry-demo.launch" and choose Debug As > Debug Configurations... Open up Classpath tab for the development mode configuration and choose User Entries. Click Advanced... and select Add Folders. Choose Java and Resources under Masonry/src/main and click ok. Now you are ready to start debugging the client-side code by clicking debug. Click Launch Default Browser button in the GWT Development Mode in the launched application. Now you can modify and breakpoints to client-side classes and see changes by reloading the web page.

Another way of debugging client-side is superdev mode. To enable it, uncomment devModeRedirectEnabled line from the end of DemoWidgetSet.gwt.xml located under Masonry-demo resources folder and compile the widgetset once by running vaadin:compile Maven target for Masonry-demo. Refresh Masonry-demo project resources by right clicking the project and choosing Refresh. Click "Create SuperDevMode Launch" button on the Vaadin tab of the Masonry-demo project properties panel to create superder mode code server launch configuration and modify the class path as instructed above. After starting the code server by running SuperDevMode launch as Java application, you can navigate to http://localhost:8080/Masonry-demo/?superdevmode. Now all code changes you do to your client side will get compiled as soon as you reload the web page. You can also access Java-sources and set breakpoints inside Chrome if you enable source maps from inspector settings.

Release notes

Version 0.5.0

  • Valo theme support
  • API to change wrapper style names (issue #10)
  • Masonry library updated to 3.3.1
  • HTML5 drag'n drop reordering removed as it did not work as well as well as planned. Might need to write own Packery JS library based add-on.

Version 0.4.0

  • Renaming DnDMasonryLayout to MasonryDnDWrapper
  • Transition time can be now defined with server API
  • New nicer drag reordering with HTML5 DnD (MasonryDndLayout)

Version 0.3.0

  • Adds imageLoaded as optional feature that will make client side to automatically re-layout when images loaded

Version 0.2.1

  • CSS fixes (eq. dragged clones of components)
  • Fancier paper style added
  • More features in demo app
  • Missing API added to DnDMasonryLayout

Version 0.2.0

  • Minor fixes (more delayed automatic layout calls on client side)
  • changes to APIs of DnDMasonryLayout component.

Version 0.1.1

  • Of course one mistake leaked in (styles were broken)

Version 0.1.0

  • First release
  • Includes initial DnD reorder implementation

Roadmap

This component is developed as a hobby with no public roadmap or any guarantees of upcoming releases. That said, the following features are planned for upcoming releases:

  • TBD

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:

  • Fork this project
  • Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
  • Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
  • Refer to the fixed issue in commit
  • Send a pull request for the original project
  • Comment on the original issue that you have implemented a fix for it

License & Author

Add-on (all Vaadin and GWT related code) is distributed under Apache License 2.0. For license terms, see LICENSE.txt. JavaScript libraries from David DeSandro aee distributed under MIT license. See masonry.pkgd.min.js and imagesloaded.pkgd.min.js files or http://masonry.desandro.com/ and http://imagesloaded.desandro.com/

Vaadin addo-on is written by Sami Viitanen sami.viitanen@gmail.com JavaScript libraries are written by David DeSandro

Developer Guide

Getting started

For a comprehensive example, see masonry-demo subproject