5 lines
26 KiB
JSON

{
"id": "api/common/TitleCasePipe",
"title": "TitleCasePipe",
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/common\", \"name\": \"@angular/common\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/common/TitleCasePipe\", \"name\": \"TitleCasePipe\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/common\">@angular/common</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/src/pipes/case_conversion_pipes.ts?message=docs(common)%3A%20describe%20your%20change...#L55-L90\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/pipes/case_conversion_pipes.ts#L55-L90\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"titlecasepipe\">TitleCasePipe<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/TitleCasePipe#titlecasepipe\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label pipe\">pipe</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>Transforms text to title case.\nCapitalizes the first letter of each word and transforms the\nrest of the word to lower case.\nWords are delimited by any whitespace character, such as a space, tab, or line-feed character.</p>\n\n \n </section>\n \n \n \n<section class=\"pipe-overview\">\n <code-example hidecopy=\"true\" class=\"no-box api-heading\">{{ value_expression | <span class=\"kwd nocode\">titlecase</span> }}</code-example>\n\n <h2 id=\"ngmodule\">NgModule<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/TitleCasePipe#ngmodule\"><i class=\"material-icons\">link</i></a></h2>\n<ul class=\"ngmodule-list\">\n\n <li>\n <a href=\"api/common/CommonModule\">\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box\">CommonModule</code-example>\n </a>\n </li>\n \n</ul>\n\n\n\n \n <h2 id=\"input-value\">Input value<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/TitleCasePipe#input-value\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table parameters-table pipe-parameters\">\n <tbody>\n \n <tr class=\"pipe-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>value</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n \n \n</section>\n\n\n \n<section class=\"see-also\">\n <h2 id=\"see-also\">See also<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/TitleCasePipe#see-also\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n \n <li><p><code><a href=\"api/common/LowerCasePipe\" class=\"code-anchor\">LowerCasePipe</a></code></p>\n</li>\n <li><p><code><a href=\"api/common/UpperCasePipe\" class=\"code-anchor\">UpperCasePipe</a></code></p>\n</li>\n </ul>\n</section>\n\n\n \n\n\n \n<section class=\"usage-notes\">\n <h2 id=\"usage-notes\">Usage notes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/TitleCasePipe#usage-notes\"><i class=\"material-icons\">link</i></a></h2>\n <p>The following example shows the result of transforming various strings into title case.</p>\n<code-example path=\"common/pipes/ts/titlecase_pipe.ts\" region=\"TitleCasePipe\">\n@<a href=\"api/core/Component\" class=\"code-anchor\">Component</a>({\n selector: 'titlecase-pipe',\n template: `&#x3C;div>\n &#x3C;p>{{'some string' | titlecase}}&#x3C;/p> &#x3C;!-- output is expected to be \"Some String\" -->\n &#x3C;p>{{'tHIs is mIXeD CaSe' | titlecase}}&#x3C;/p> &#x3C;!-- output is expected to be \"This Is Mixed Case\" -->\n &#x3C;p>{{'it\\\\'s non-trivial question' | titlecase}}&#x3C;/p> &#x3C;!-- output is expected to be \"It's Non-trivial Question\" -->\n &#x3C;p>{{'one,two,three' | titlecase}}&#x3C;/p> &#x3C;!-- output is expected to be \"One,two,three\" -->\n &#x3C;p>{{'true|false' | titlecase}}&#x3C;/p> &#x3C;!-- output is expected to be \"True|false\" -->\n &#x3C;p>{{'foo-vs-bar' | titlecase}}&#x3C;/p> &#x3C;!-- output is expected to be \"Foo-vs-bar\" -->\n &#x3C;/div>`\n})\nexport class TitleCasePipeComponent {\n}\n\n</code-example>\n\n</section>\n\n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/common\n - api/common/CommonModule\n - api/common/LowerCasePipe\n - api/common/UpperCasePipe\n - api/core/PipeTransform\n - guide/testing-components-scenarios\n - guide/testing-pipes\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/CommonModule\n - api/common/LowerCasePipe\n - api/common/TitleCasePipe#input-value\n - api/common/TitleCasePipe#ngmodule\n - api/common/TitleCasePipe#see-also\n - api/common/TitleCasePipe#titlecasepipe\n - api/common/TitleCasePipe#usage-notes\n - api/common/UpperCasePipe\n - api/core/Component\n - https://github.com/angular/angular/edit/master/packages/common/src/pipes/case_conversion_pipes.ts?message=docs(common)%3A%20describe%20your%20change...#L55-L90\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/pipes/case_conversion_pipes.ts#L55-L90\n-->"
}