From fc8f4688c78a89cfd1ca10803d4a72cf1ed1829a Mon Sep 17 00:00:00 2001 From: Pawel Kozlowski Date: Wed, 15 Jul 2015 12:07:02 +0200 Subject: [PATCH] docs(Title): add documentation for the Title service Closes #3063 --- modules/angular2/src/services/title.ts | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/modules/angular2/src/services/title.ts b/modules/angular2/src/services/title.ts index 9b60c7c4c9..c07a0148da 100644 --- a/modules/angular2/src/services/title.ts +++ b/modules/angular2/src/services/title.ts @@ -1,7 +1,23 @@ 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 (`` tag) + * it is not possible to bind to the `text` property of the `HTMLTitleElement` elements + * (representing the `` tag). Instead, this service can be used to set and get the current + * title value. + */ export class Title { + /** + * Get the title of the current HTML document. + * @returns {string} + */ getTitle(): string { return DOM.getTitle(); } + /** + * Set the title of the current HTML document. + * @param newTitle + */ setTitle(newTitle: string) { DOM.setTitle(newTitle); } }