diff --git a/public/docs/js/latest/guide/setup.jade b/public/docs/js/latest/guide/setup.jade index f7922078f7..d6d6423cf6 100644 --- a/public/docs/js/latest/guide/setup.jade +++ b/public/docs/js/latest/guide/setup.jade @@ -1,16 +1,3 @@ -.l-main-section - p. - Mission: By the end of this chapter, you should be able to get an Angular 2 component to appear on - the page. - - .l-sub-section - h3#section-examples Examples: - ul - li - a(href='http://plnkr.co/edit/MRz2i7sjupzxERPAa3SF?p=preview') TypeScript - li - a(href='http://plnkr.co/edit/wzzKo4etk24t0oAnL6ep?p=preview') ES5 - .l-main-section h2#section-install-or-plunker Install Angular or Use Plunker p There are four steps to create any Angular app: @@ -23,11 +10,14 @@ p. You can edit and test out your apps either though serving local files through a web server or through a service like Plunker. - + + .callout.is-helpful + header Plunker is the fastest setup + p. + Plunker is a free online text editor. You can use the starter template for Angular 2 to get going without any setup. + p. - For Plunker, just use the starter template to get going. If you're - serving local files, edit and save them and start a web server that serves files in that directory. If you have - Python installed, you can run a basic HTTP server from the root of your code directory with: + For Plunker, just use the starter template to get going. If you're serving local files, edit and save them and start a web server that serves files in that directory. If you have Python installed, you can run a basic HTTP server from the root of your code directory with: pre.prettyprint.lang-bash code python -m SimpleHTTPServer 8000 @@ -41,6 +31,9 @@ p. In the <body>, add an element called <my-app> that will be the root of your application. + + p. + The TypeScript setup includes System.js, a third-party open-source library that adds ES6 module loading functionality to browsers. This step isn't needed for the ES5 version. System requires mapping the code file paths to understand what to be load. pre.prettyprint.lang-html code. @@ -126,7 +119,7 @@ } bootstrap(AppComponent); - + .l-main-section h2#section-run-it Run it! @@ -141,21 +134,58 @@ p This basic Angular app contains the structure for any app you'll build. - p. - You can think of Angular apps as a tree of components. This root component we've been talking about acts as the top - level container for the rest of your application. You've named this one AppComponent, but there's - nothing special about the name and you can use whatever makes sense to you. + .l-sub-section + h3 It's all a tree + p. + You can think of Angular apps as a tree of components. This root component we've been talking about acts as the top + level container for the rest of your application. You've named this one AppComponent, but there's + nothing special about the name and you can use whatever makes sense to you. - p. - The root component's job is to give a location in the index.html file where your application will - render through it's element, in this case <my-app>. There is also nothing special about this - element name and you can pick it as you like. + p. + The root component's job is to give a location in the index.html file where your application will + render through it's element, in this case <my-app>. There is also nothing special about this + element name and you can pick it as you like. - p. - The root component loads the initial template for the application that will load other components to perform - whatever functions your application needs - menu bars, views, forms, etc. We'll walk through examples of all of - these in the following pages. + p. + The root component loads the initial template for the application that will load other components to perform + whatever functions your application needs - menu bars, views, forms, etc. We'll walk through examples of all of + these in the following pages. + + .l-sub-section + h3 @Component and @View annotations + + p. + A component annotation describes details about the component. An annotation can be identified by its at-sign (@). + p. + The @Component annotation defines the HTML tag for the component by specifying the component's CSS selector. + p. + The @View annotation defines the HTML that represents the component. The component you wrote uses an inline template, but you can also have an external template. To use an external template, specify a templateUrl property and give it the path to the HTML file. + + .l-sub-section + h3 import vs. window.angular + p. + The main difference between the ES5 and TypeScript versions is the loading of modules. + + strong TypeScript + p. + TypeScript supports ES6 module loading syntax. ES6 modules allow for modular loading of JavaScript code. Using ES6 modules you can cherry-pick only what you need for your app. + + pre.prettyprint.lang-typescript + code. + import {Component, View, bootstrap} from 'angular2/angular2'; + ... + // bootstrap is available for use because it was imported from angular core + bootstrap(AppComponent); + + strong ES5 + p. + In ES5 the script file creates an angular property on the window of the browser. This property contains every piece of Angular core, whether you need it or not. + + pre.prettyprint.lang-typescript + code. + // window.angular is available because the script file attaches the angular property to the window + document.addEventListener('DOMContentLoaded', function() { + angular.bootstrap(AppComponent); + }); p Exciting! Not excited yet? Let's move on to Displaying Data. - -