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

docs(core): improve formatting for the preserveWhitespaces option (#18995) 

PR Close #18995
This commit is contained in:
Pawel Kozlowski 2017-09-01 14:50:50 +02:00 committed by Miško Hevery
parent fef3d2ad53
commit 590b8052fe
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
packages/core/src/metadata/directives.ts
View File

@ -678,7 +678,7 @@ export interface Component extends Directive {
entryComponents?: Array<Type<any>|any[]>;
/**
* If {@link Component#preserveWhitespaces `Component.preserveWhitespaces`} is set to `false`
* If {@link Component#preserveWhitespaces Component.preserveWhitespaces} is set to `false`
* potentially superfluous whitespace characters (ones matching the `\s` character class in
* JavaScript regular expressions) will be removed from a compiled template. This can greatly
* reduce AOT-generated code size as well as speed up view creation.
@ -720,14 +720,24 @@ export interface Component extends Directive {
*
* will be compiled to the equivalent of:
*
* * ```html
* ```html
* <a>Spaces</a> <a>between</a> <a>links.</a>
* ```
*
* Please note that sequences of `&ngsp;` are still collapsed to just one space character when
* the `preserveWhitespaces` option is set to `false` (ex.:
* `<a>before</a>&ngsp;&ngsp;&ngsp;<a>after</a>` would be equivalent to
* `<a>before</a> <a>after</a>`). The `&ngsp;` pseudo-entity is useful for forcing presence of
* the `preserveWhitespaces` option is set to `false`. Ex.:
*
* ```html
* <a>before</a>&ngsp;&ngsp;&ngsp;<a>after</a>
* ```
*
* would be equivalent to:
*
* ```html
* <a>before</a> <a>after</a>
* ```
*
* The `&ngsp;` pseudo-entity is useful for forcing presence of
* one space (a text node having `&ngsp;` pseudo-entities will never be removed), but it is not
* meant to mark sequences of whitespace characters. The previously described
* `ngPreserveWhitespaces` attribute is more useful for preserving sequences of whitespace