From d6f6fbb9218ca75596f62c12993032da391351d8 Mon Sep 17 00:00:00 2001 From: Kathy Walrath Date: Mon, 2 Mar 2015 14:46:31 -0800 Subject: [PATCH] copy of js docs --- public/docs/dart/latest/_data.json | 29 +++ public/docs/dart/latest/api.jade | 14 ++ public/docs/dart/latest/help.jade | 33 ++++ public/docs/dart/latest/index.jade | 30 +++ public/docs/dart/latest/quickstart.jade | 243 ++++++++++++++++++++++++ public/docs/dart/latest/resources.jade | 20 ++ 6 files changed, 369 insertions(+) create mode 100644 public/docs/dart/latest/_data.json create mode 100644 public/docs/dart/latest/api.jade create mode 100644 public/docs/dart/latest/help.jade create mode 100644 public/docs/dart/latest/index.jade create mode 100644 public/docs/dart/latest/quickstart.jade create mode 100644 public/docs/dart/latest/resources.jade diff --git a/public/docs/dart/latest/_data.json b/public/docs/dart/latest/_data.json new file mode 100644 index 0000000000..155fe09c17 --- /dev/null +++ b/public/docs/dart/latest/_data.json @@ -0,0 +1,29 @@ +{ + "index": { + "icon": "home", + "title": "Angular Docs", + "menuTitle": "Docs Home", + "banner": "Angular 2 is currently in Alpha Preview. We reccomend using Angular 1.X for production applications." + }, + + "quickstart": { + "icon": "query-builder", + "title": "5 Min Quickstart" + }, + + "resources": { + "icon": "play-circle-fill", + "title": "Angular Resources", + "banner": "Angular 2 is currently in Alpha Preview. For Angular 1.X Resources please visit Angularjs.org." + }, + + "api": { + "icon": "book", + "title": "API Proposal" + }, + + "help": { + "icon": "chat", + "title": "Help & Support" + } +} \ No newline at end of file diff --git a/public/docs/dart/latest/api.jade b/public/docs/dart/latest/api.jade new file mode 100644 index 0000000000..e652be232b --- /dev/null +++ b/public/docs/dart/latest/api.jade @@ -0,0 +1,14 @@ +.l-main-section + h2 Developer Preview + + p. + The Angular 2.0 API is currently in active development and not production ready. + This page will showcase a preview of proposed methods to help further the discussion + in the development community. + + .l-sub-section + h3 Angular 1.X for Production + p. + If you're building a production app today, please + use Angular 1.X. + These versions of Angular are production ready and available today. diff --git a/public/docs/dart/latest/help.jade b/public/docs/dart/latest/help.jade new file mode 100644 index 0000000000..2ad2430887 --- /dev/null +++ b/public/docs/dart/latest/help.jade @@ -0,0 +1,33 @@ +.l-main-section + h2 Get Help Using Angular + + p. + We have an incredible community of developers who are passionate about solving problems. + We reccomend some of the following methods to get help with Angular. + + + .l-sub-section + h3 Angular Google Group + + ul + li Search the archive first, it's likely that your question was already answered. + li To avoid the spam moderation queue, don't include code directly in your email. (See #3) + li Linking to a live code example that demonstrates your problem or question will get you an answer faster. Use this template. + li If you get help, help others. Good karma rulez! + + a(href="https://groups.google.com/forum/#!forum/angular" class="button button-primary" md-button) View the Google Group + + .l-sub-section + h3 Angular Chat Room + + p Talk in real time with other Angular developers. + + a(href="http://webchat.freenode.net/?channels=angularjs&uio=d4" class="button button-primary" md-button) View the Chat Room + + + .l-sub-section + h3 Report an Issue + + p If your run into an issue or have a feature request, you can create a new issue on our github repostitory. + + a(href="https://github.com/angular/angular.js/issues" class="button button-primary" md-button) Report an Issue diff --git a/public/docs/dart/latest/index.jade b/public/docs/dart/latest/index.jade new file mode 100644 index 0000000000..1e87776524 --- /dev/null +++ b/public/docs/dart/latest/index.jade @@ -0,0 +1,30 @@ + +div.c4 + md-card + md-card-content + h3.text-headline.text-uppercase Quickstart + p.text-body Learn in 5 minutes + + footer + a(href="/docs/#{current.path[1]}/#{current.path[2]}/quickstart.html" class="button" md-button) View Quickstart + + +div.c4 + md-card + md-card-content + h3.text-headline.text-uppercase Resources + p.text-body Preview of v2.0 + + footer + a(href="/docs/#{current.path[1]}/#{current.path[2]}/resources.html" class="button button-primary" md-button) View Resources + + +div.c4 + md-card + md-card-content + h3.text-headline.text-uppercase API Preview + p.text-body Proposal for v2.0 API + + footer + a(href="/docs/#{current.path[1]}/#{current.path[2]}/api.html" class="button" md-button) View API + diff --git a/public/docs/dart/latest/quickstart.jade b/public/docs/dart/latest/quickstart.jade new file mode 100644 index 0000000000..6deedf14fe --- /dev/null +++ b/public/docs/dart/latest/quickstart.jade @@ -0,0 +1,243 @@ +// STEP 1 - Install Angular ########################## +.l-main-section + h2#section-install-angular 1. Install Angular + + p. + Angular is still unpackaged and in alpha. This quickstart does not + reflect the final build process for Angular. The following setup is for those who + want to try out Angular while it is in alpha. + + p. + For the sake of this quickstart we recommend using the + es6-shim GitHub repository. + This repository will provide a faster start. es6-shim includes Angular and dependencies to compile ES6 in incompatible browsers. + + p Clone the repository inside of aleady existing project. + + pre.prettyprint.linenums + code git clone https://github.com/davideast/concious.git es6-shim + + .l-sub-section + h3 A word on ES6 + p. + Angular builds on top of ES6, the new specification of the JavaScript language. + Not all ES6 features are available in all browsers. The following es6-shim + repository allows you to use ES6 in the browser today. + + p. + Angular is available on npm. Configuring Angular to run ES6 in the browser + requires a build process, detailed here. + + p. + The es6-shim package includes Angular and dependencies needed to compile + ES6 in the browser. Think of the es6-shim repository as package rather than a new project. + + + +// STEP 2 - Import Angular ########################## +.l-main-section + h2#section-transpile 2. Import Angular + + p. + Create a file named app.es6 at the root of the project. + The .es6 extension signifies that the file uses ES6 syntax. + Using the ES6 module syntax you can import the required modules from Angular2. + + pre.prettyprint.linenums + code import {Component, Template, bootstrap} from 'angular2/angular2'; + + p The above import statement will import the three modules from Angular. These modules load at runtime. + + + +// STEP 3 - Create a component ########################## +.l-main-section + + h2#section-angular-create-account 3. Create a component + + p. + Components are custom HTML elements. Angular uses components to empower HTML. + Components structure and repre.prettyprint.linenumssent the UI. This quickstart + demonstrates the process of creating a component. This component will have the tag of app. + + pre.prettyprint.linenums + code <app></app> + + p A component consists of two parts; the annotation section and the component controller. + + pre.prettyprint.linenums + code. + import {Component, Template, bootstrap} from 'angular2/angular2'; + + // Annotation Section + @Component({ + selector: 'app' + }) + @Template({ + inline: ` + <h1>Hello {{ name }}</h1> + ` + }) + // Component Controller + class AppComponent { + constructor() { + this.name = "Alice"; + } + } + + .l-sub-section + h3 Component Annotations + + p. + A component annotation provides meta-data about the component. + An annotation can always identified by its at-sign — @. + p. + The @Component annotation defines the HTML tag for the component. + The selector property specifies the tag. The selector property is a CSS selector. + + p. + The @Template annotation defines the template to apply to the + component. This component uses an inline template, but external templates are + available as well. To use an external template specify a url property + and give it the path to the html file. + + pre.prettyprint.linenums + code. + @Component({ + selector: 'app' + }) + @Template({ + inline: ` + <h1>Hello {{ name }}</h1> + ` + }) + + p. + The component created above has a HTML tag of <app></app> + and a template of <h1>Hello {{ name }}</h1>. + + .l-sub-section + h3 Component Controller + + p. + The component controller is the backing of the component's template. A component + controller uses ES6 class syntax. + + pre.prettyprint.linenums + code + class AppComponent { + constructor() { + this.name = "Alice"; + } + } + + p. + Templates read from their component controllers. Templates have access to any properties + or functions placed on the component controller. + + p. + The template above binds to a name property through the {{ }} + syntax.The body of the constructor assigns "Alice" to the name property. When the + template renders, Alice will appear instead of {{ name }}. + + + +// STEP 4 - Bootstrap ########################## +.l-main-section + h2#section-transpile 4. Bootstrap + + p The last step to load the component on the page. + + .l-sub-section + h3 The bootstrap function + p. + Angular provides a bootstrap function that renders a + component to the page. The bootstrap function takes a + component as a parameter. Any child components inside of the parent + component will render as well. + + pre.prettyprint.linenums + code bootstrap(AppComponent); + + + +// STEP 5 - Declare the HTML ########################## +.l-main-section + + h2#section-angular-create-account 5. Declare the HTML + + p. + Create an index.html file at the root of the project. + Include the es6-shim.js file in the head tag. + Now, declare the app component the body. The es6-shim must + load before any application code. + + pre.prettyprint.linenums + code. + <html> + <head> + <title>Angular 2 Quickstart</title> + <script src="/es6-shim/dist/es6-shim.js"></script> + </head> + <body> + + <!-- The app component created in app.es6 --> + <app></app> + + </body> + </html> + + .l-sub-section + h3 Load the component module + p. + The last step is to load the module for the app component. + The es6-shim file comes packaged with the System library. + Most browsers today do not support ES6 module loading. System + provides module loading functionality to these browsers. + + p. + To load the needed modules, System needs to know where to + load the files from. The paths property in System specifies + the location of the files. + + p Tell System about three paths: + ol + li Angular - The Angular framework. + li Runtime assertions - Optional assertions for runtime type checking. + li The app component created above - The component to display on the page. + + pre.prettyprint.linenums + code. + <html> + <head> + <title>Angular 2 Quickstart</title> + <script src="/es6-shim/dist/es6-shim.js"></script> + </head> + <body> + + <!-- The app component created in app.es6 --> + <app></app> + + <script> + // Rewrite the paths to load the files + System.paths = { + 'angular2/*':'/es6-shim/angular2/*.js', + 'rtts_assert/*': '/es6-shim/rtts_assert/*.js', + 'app': 'app.es6' + }; + + // Kick off the application + System.import('app'); + </script> + </body> + </html> + + p Run the root of your project on a local server. + + + +// WHAT'S NEXT... ########################## +.l-main-section + h2#section-transpile Great Job! Next Step... + + p Learn some template syntax for extra-credit. diff --git a/public/docs/dart/latest/resources.jade b/public/docs/dart/latest/resources.jade new file mode 100644 index 0000000000..53d5a2302e --- /dev/null +++ b/public/docs/dart/latest/resources.jade @@ -0,0 +1,20 @@ +.l-main-section + h2 Victor Savkin's blog posts + ul + li Change Detection + li Functional programming + li Dependency Injection + +.l-main-section + h2 David East's Intro Todo App + ul + li Building a Todo App (video) + +.l-main-section + h2 More Videos + ul + li ng-europe playlist of videos on Angular 2 and future of Angular + li Hejlsberg's talk on TypeScript from December + li Coming soon: playlist of video from ng-conf 2015 + +