angular2gridster

Angular 2 implementation of well known Gridster (no jQuery, no external libraries, only Angular2 and Rx.js). Demo.

More comprehensive documentation is available in Wiki.

Core new features in v.0.6

Enabling/disabling resizing item
Enabling/disabling repositioning item
Responsive options

Breaking changes in v.0.6

Configuration of GridsterItem should be now set by ´options´ attribute on GridsterItem component itself - not on Gridster options like before. Map between deprecated Gridster options and new adequate GridsterItem options:

Gridster options (deprecated)	GridsterItem option (new)	Default value	Info
minWidth	minWidth	1	Min width (in lanes) of item that can be set by resize feature. This option in Gridster options is still valid but has another meaning. Look for responsive options.
minHeight	minHeight	1	Min height (in lanes) of item that can be set by resize feature.
maxWidth	maxWidth	null	Max width (in lanes) of item that can be set by resize feature.
maxHeight	maxHeight	null	Max height (in lanes) of item that can be set by resize feature.
defaultItemWidth	defaultWidth	1	Default width of an item when new item (without size) will be pushed to the gridster.
defaultItemHeight	defaultHeight	1	Default height of an item when new item (without size) will be pushed to the gridster.

Removed events on GridsterComponent:

gridsterPositionChange
resize

In place of them use new change event on GridsterItemComponent. More info here.

Installation

npm install angular2gridster

Once installed you need to import our module:

...
import { GridsterModule } from 'angular2gridster';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    ...
    GridsterModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

The example it imports in AppModule, but it could also be imported in any other module - depends where you want to use it.

Additional steps for System.js

To make Angular2gridster works with System.js you need to provide dedicated configuration in systemjs.config.js. It requires change in map object and 'packages' as follows:

System.config({
  map: {
    // ...
    'rxjs':             'node_modules/rxjs',
    'angular2gridster': 'node_modules/angular2gridster'
  },
  packages: {
    // ...
    'rxjs':             { defaultExtension: 'js' },
    'angular2gridster': { main: 'dist/index.js', defaultExtension: 'js' }
  }
});

Example usage

<gridster [options]="gridsterOptions" [draggableOptions]="{ handlerClass: 'panel-heading' }">

  <gridster-item *ngFor="let widget of widgets" 
                 [(x)]="widget.x" [(y)]="widget.y" [(w)]="widget.w" [(h)]="widget.h">
      <!--some content-->
  </gridster-item>

</gridster>

widgets: Array<any> = [...];
gridsterOptions = {
  lanes: 5, // how many lines (grid cells) dashboard has
  direction: 'vertical', // items floating direction: vertical/horizontal
  dragAndDrop: true, // possible to change items position by drag n drop
  resizable: true // possible to resize items by drag n drop by item edge/corner
};

Demo

Clone or download this repository. Demo folder is dedicated nester project build on Angular CLI. To run:

    cd demo
    npm install
    ng serve

Go to: http://localhost:4200/

Compilation problems

If somebody will have compilation problems please add an issue (if not yet created). I will try to fix it as soon as possible. Angular compiler has still some issues opened that can be a problem to you this module in your project. If so please, as a temporary solution copy files from /src folder to dedicated folder in your project.

Issues

If the current behavior is a bug or you can illustrate your feature request better with an example, please provide the steps to reproduce and if possible a minimal demo of the problem via plnkr (http://plnkr.co/edit/4pGyURZVVrL6MONXc8A0?p=preview). The project is in development so don't hesitate to writte any questions or suggestion on issue list. I look forward to get response from you.

Origin

This project was created on idea of GridList. Great alternative for Gridster.

sti-web / angular2gridster Goto Github PK