docs(footer, header): add docs

This commit is contained in:
mhartington
2016-07-29 10:37:05 -05:00
parent a468fde3f3
commit 1c596556c5

View File

@ -6,7 +6,31 @@ import { ViewController } from '../nav/view-controller';
/**
* @private
* @name Header
* @description
* Header is a parent compnent that holds the navbar and toolbar component.
* It's important to note that `ion-header` needs to be the one of the three root elements of a page
*
* @usage
*
* ```ts
* @Component({
* template: `
* <ion-header>
* <ion-navbar>
* <ion-title>Page1</ion-title>
* </ion-navbar>
*
* <ion-toolbar>
* <ion-title>Subheader</ion-title>
* </ion-toolbar>
* </ion-header>
*
* <ion-content></ion-content>
* `
* })
* ```
*
*/
@Directive({
selector: 'ion-header'
@ -21,7 +45,26 @@ export class Header {
/**
* @private
* @name Footer
* @description
* Footer is a root component of a page that sits at the bottom of the page.
* Footer can be a wrapper for `ion-toolbar` to make sure the content area is sized correctly.
*
* @usage
*
* ```ts
* @Component({
* template: `
* <ion-content></ion-content>
* <ion-footer>
* <ion-toolbar>
* <ion-title>Footer</ion-title>
* </ion-toolbar>
* </ion-footer>
* `
* })
* ```
*
*/
@Directive({
selector: 'ion-footer'