honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(Title): add documentation for the Title service 

Closes #3063
This commit is contained in:
Pawel Kozlowski 2015-07-15 12:07:02 +02:00 committed by Tobias Bosch
parent 3f6dd6cd42
commit fc8f4688c7
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
modules/angular2/src/services/title.ts
View File

@ -1,7 +1,23 @@
import {DOM} from 'angular2/src/dom/dom_adapter'; import {DOM} from 'angular2/src/dom/dom_adapter';
/**
* A service that can be used to get and set the title of a current HTML document.
*
* Since an Angular 2 application can't be bootstrapped on the entire HTML document (`<html>` tag)
* it is not possible to bind to the `text` property of the `HTMLTitleElement` elements
* (representing the `<title>` tag). Instead, this service can be used to set and get the current
* title value.
*/
export class Title { export class Title {
/**
* Get the title of the current HTML document.
* @returns {string}
*/
getTitle(): string { return DOM.getTitle(); } getTitle(): string { return DOM.getTitle(); }
/**
* Set the title of the current HTML document.
* @param newTitle
*/
setTitle(newTitle: string) { DOM.setTitle(newTitle); } setTitle(newTitle: string) { DOM.setTitle(newTitle); }
} }