docs(cookbook - jquery plugins)

tweak

ignore

fix array

core shim

e2e

Author: thelgevold

public/docs/_examples/cb-jquery-plugin/e2e-spec.ts

@@ -0,0 +1,32 @@
+/// <reference path='../_protractor/e2e.d.ts' />
+'use strict';
+/* tslint:disable:quotemark */
+describe('Drag and Drop', function () {
+
+  beforeAll(function () {
+    browser.get('');
+  });
+
+  it('should drag hero to assignment', function () {
+
+    let assignment1 = element.all(by.css('.assignment')).get(0);
+
+    let hero1 = element.all(by.css('.hero')).get(0);
+
+    browser.actions()
+           .dragAndDrop(hero1 as any as webdriver.WebElement,
+                        assignment1 as any as webdriver.WebElement)
+           .perform();
+
+    let heroAssignment = element.all(by.xpath('//div[text()="Help Granny cross the street"]/following-sibling::ul/li[text()="Mr. Nice"]'));
+    expect(heroAssignment.count()).toBe(1);
+
+    let doneButton = element(by.xpath('//div[@data-hero="Mr. Nice"]/div/button'));
+
+    // Remove Mr. Nice
+    doneButton.click().then(function(){
+      let remainingHeroes = element.all(by.css('.hero'));
+      expect(remainingHeroes.count()).toBe(3);
+    });
+  });
+});

public/docs/_examples/cb-jquery-plugin/ts/.gitignore

@@ -0,0 +1 @@
+**/*.js

public/docs/_examples/cb-jquery-plugin/ts/app/app.component.ts

@@ -0,0 +1,36 @@
+// #docregion
+import { Component }               from  '@angular/core';
+import { HeroAssignmentComponent } from './hero-assignment.component';
+import { HeroComponent }           from  './hero.component';
+
+@Component({
+  selector: 'my-app',
+  template: `
+    <div id="hero-wrapper">
+      <h2>Hero Assignments</h2>
+      <div *ngFor="let assignment of assignments">
+        <cb-assignment [title]="assignment"></cb-assignment>
+      </div>
+      <div class="heroList">
+        <div *ngFor="let hero of heroes">
+          <cb-hero (remove)="removeHero($event)" [name]="hero"></cb-hero>
+        </div>
+      </div>
+    </div>
+  `,
+  directives: [HeroAssignmentComponent, HeroComponent]
+})
+export class AppComponent {
+  heroes = ['Mr. Nice',
+            'Bombasto',
+            'Celeritas',
+            'Tornado'];
+
+  assignments = ['Help Granny cross the street',
+                 'Rescue village from dragon(s)',
+                 'Rescue princess from tower'];
+
+  removeHero(heroToRemove: string) {
+    this.heroes = this.heroes.filter(hero => hero !== heroToRemove);
+  }
+}

public/docs/_examples/cb-jquery-plugin/ts/app/hero-assignment.component.html

@@ -0,0 +1,7 @@
+<!-- #docregion -->
+<div #assignment class="assignment" [ngClass]="{selected: heroDropped}">
+    <div>{{title}}</div>
+    <ul>
+      <li *ngFor="let hero of assignedHeroes">{{hero}}</li>                    
+    </ul>
+</div>

public/docs/_examples/cb-jquery-plugin/ts/app/hero-assignment.component.ts

@@ -0,0 +1,26 @@
+// #docregion
+import { Component, Input, AfterViewInit, ViewChild, ElementRef } from '@angular/core';
+
+declare var jQuery: any;
+
+@Component({
+  selector: 'cb-assignment',
+  templateUrl: 'app/hero-assignment.component.html'
+})
+export class HeroAssignmentComponent implements AfterViewInit {
+  @Input() title: string;
+  @ViewChild('assignment') assignment: ElementRef;
+
+  assignedHeroes: string[] = [];
+
+  // #docregion add-plugin
+  ngAfterViewInit() {
+    jQuery(this.assignment.nativeElement).droppable({drop : (event: any, ui: any) => {
+      let heroName = ui.draggable.data('hero');
+      if (this.assignedHeroes.indexOf(heroName) === -1) {
+        this.assignedHeroes = [...this.assignedHeroes, heroName];
+      }
+    }});
+  }
+  // #enddocregion add-plugin
+}

public/docs/_examples/cb-jquery-plugin/ts/app/hero.component.html

@@ -0,0 +1,5 @@
+<!-- #docregion -->
+<div #hero class="hero" [attr.data-hero]="name">
+  {{name}}
+  <div><button (click)="done()">Done</button></div>        
+</div>

public/docs/_examples/cb-jquery-plugin/ts/app/hero.component.ts

@@ -0,0 +1,25 @@
+// #docregion
+import { Component, Input, Output, AfterViewInit, ViewChild, ElementRef, EventEmitter } from '@angular/core';
+
+// #docregion declare-jquery
+declare var jQuery: any;
+// #enddocregion declare-jquery
+@Component({
+  selector: 'cb-hero',
+  templateUrl: 'app/hero.component.html'
+})
+export class HeroComponent implements AfterViewInit {
+  @Input() name: string;
+  @Output() remove: EventEmitter<string> = new EventEmitter<string>();
+  @ViewChild('hero') hero: ElementRef;
+
+  // #docregion add-plugin
+  ngAfterViewInit() {
+    jQuery(this.hero.nativeElement).draggable({revert: 'invalid'});
+  }
+  // #enddocregion add-plugin
+
+  done() {
+    this.remove.emit(this.name);
+  }
+}

public/docs/_examples/cb-jquery-plugin/ts/app/main.ts

@@ -0,0 +1,6 @@
+import { bootstrap }    from '@angular/platform-browser-dynamic';
+
+import { AppComponent } from './app.component';
+
+bootstrap(AppComponent, [])
+  .catch((err: any) => console.error(err));

public/docs/_examples/cb-jquery-plugin/ts/example-config.json

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>JQuery Plugin</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <!-- #docregion style -->
+    <link rel="stylesheet" href="styles.css">
+    <link rel="stylesheet" href="sample.css">
+    <!-- #enddocregion style -->
+
+    <!-- Polyfill(s) for older browsers -->
+    <script src="node_modules/core-js/client/shim.min.js"></script>
+
+    <script src="node_modules/zone.js/dist/zone.js"></script>
+    <script src="node_modules/reflect-metadata/Reflect.js"></script>
+    <script src="node_modules/systemjs/dist/system.src.js"></script>
+    
+    <!-- #docregion jquery -->
+    <script src="https://npmcdn.com/jquery@2.2.3"></script>
+    <script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.11.4/jquery-ui.min.js"></script>
+    <!-- #enddocregion jquery -->
+    
+    <script src="systemjs.config.js"></script>
+    <script>
+      System.import('app').catch(function(err){ console.error(err);  });
+    </script>
+
+  </head>
+
+  <body>
+    <my-app>Loading app...</my-app>
+  </body>
+
+</html>

public/docs/_examples/cb-jquery-plugin/ts/index.html

@@ -0,0 +1,9 @@
+{
+  "description": "jQuery Plugin",
+  "files":[
+    "!**/*.d.ts",  
+    "!**/*.js",
+    "!**/*.[1].*"
+  ],
+  "tags":["cookbook"]
+}

public/docs/_examples/cb-jquery-plugin/ts/plnkr.json

@@ -0,0 +1,30 @@
+.hero{
+  background: lightblue;
+  border: 1px solid black;
+  width: 100px;
+  color:black;
+  height: 50px;
+  margin-bottom: 20px;
+  text-align: center;
+  padding-top: 30px;
+}
+
+.assignment{
+  background: darkblue;
+  width: 250px;
+  height: 150px;
+  color:white;
+  margin-right: 20px;
+  text-align: center;
+  padding-top: 10px;
+  float: left;
+  margin-bottom: 30px;
+}
+
+.assignment li{
+  text-align: left;
+}
+
+.heroList{
+  clear:both;
+}

public/docs/_examples/cb-jquery-plugin/ts/sample.css

@@ -38,6 +38,10 @@
     "hide": true
   },
 
+  "jquery-plugin": {
+    "title": "jQuery Plugin Integration",
+    "intro": "Integrate with jQuery plugins"
+  },
   "set-document-title": {
     "title": "Set the Document Title",
     "intro": "Setting the document or window title using the Title service."

public/docs/ts/latest/cookbook/_data.json

@@ -0,0 +1,104 @@
+include ../_util-fns
+
+:marked
+    Using jQuery for direct DOM access is not recommended in Angular projects, but we do see value in supporting integration with third party jQuery plugins.
+    
+    In this cookbook we show how to integrate `draggable` and `droppable` from jQuery UI to make it easier for our admins to assign new adventures to our brave heroes.
+    
+    Before a hero can set out on a new quest, one of our admins will give the hero a new assignment by dragging and dropping the hero's name on top of the assignment.
+:marked
+   **See the [live example](/resources/live-examples/cb-jquery-plugin/ts/plnkr.html)**.   
+   
+<a id="toc"></a>
+:marked
+   ## Table of contents
+
+      [Add jQuery](#jquery-add)
+
+      [Drag](#drag)
+
+      [Drop](#drop)
+      
+.l-main-section
+<a id="jquery-add"></a>
+:marked
+   ## Add jQuery
+   
+   Before we can start we have to add the necessary script references to load the jQuery library and the two plugins, `draggable` and `droppable`, from jQuery UI. 
+   
++makeExample('cb-jquery-plugin/ts/index.html', 'jquery', 'index.html (add jquery scripts)')(format=".")  
+
+:marked
+    jQuery declares a global variable called`jQuery`, but this variable is not know to TypeScript. In order to reference `jQuery` in our TypeScript code we have to declare it as a TypeScript variable as well.
+    
+    In our case we don't need to access the jQuery api, so it's unnecessary to add ambient typings for jQuery. Instead we will just declare `jQuery` as an `any` variable. 
+    
+    If we don't declare the `jQuery` variable, the TypeScript compiler will give us an error when we try to reference `jQuery` from our code.
+    
++makeExample('cb-jquery-plugin/ts/app/hero.component.ts', 'declare-jquery', 'app/hero.component.ts (declare jquery)')(format=".")  
+   
+.l-main-section
+<a id="drag"></a>
+:marked
+   ## Drag
+   
+   `draggable` is a jQuery plugin that allows us to move an element on the screen. In the UI our admins will "drag" heroes and drop them on assignments.
+   
+    `HeroComponent` is created to represent "draggable" hero elements.  
+
++makeTabs(
+  `cb-jquery-plugin/ts/app/hero.component.ts,
+   cb-jquery-plugin/ts/app/hero.component.html`,
+  null,
+  `hero.component.ts,
+   hero.component.html`
+)  
+
+:marked
+    We want to be careful not to access the DOM directly, so we are using `@ViewChild` to access the target element for the `draggable` plugin. 
+    
+    `@ViewChild('hero')` declares a reference to an element in the template with a matching `#hero` variable reference. 
+
+:marked
+    Now, we can go ahead and apply the draggable plugin to `this.hero.nativeElement` using familiar jquery syntax.
++makeExample('cb-jquery-plugin/ts/app/hero.component.ts', 'add-plugin', 'app/hero.component.ts (add plugin)')(format=".")  
+
+:marked
+    We apply the plugin in the `AfterViewInit` lifecycle hook since we know the component view has been fully initialized at this point. 
+   
+.l-main-section
+<a id="drop"></a>
+:marked
+   ## Drop    
+   
+   `droppable` is used in tandem with draggable to create a drop-zone for dragged elements. 
+   
+   `HeroAssignmentComponent` represents an assignment that we can assign one or more heroes to using drag and drop.
+
++makeTabs(
+  `cb-jquery-plugin/ts/app/hero-assignment.component.ts,
+   cb-jquery-plugin/ts/app/hero-assignment.component.html`,
+  null,
+  `hero-assignment.component.ts,
+   hero-assignment.component.html`
+)   
+
+:marked
+    Same as with draggable, we are applying the droppable plugin in `AfterViewInit`.
+    
+    `droppable` lets us specify a callback that executes when a hero is dropped on the assignment. We use this callback to manage an array of assigned heroes whenever a new hero is assigned.  
+
++makeExample('cb-jquery-plugin/ts/app/hero-assignment.component.ts', 'add-plugin', 'app/hero-assignment.component.ts (add plugin)')(format=".")  
+          
+:marked
+    The final UI looks like this.
+    
+    Our admin users can assign any given hero to multiple assignments by dragging and dropping. 
+figure.image-display
+   img(src="/resources/images/cookbooks/jquery-plugin/hero-assignments.png" alt="Hero Assignments")
+   
+:marked
+   [Back to top](#top)   
+    
+          
+