5 lines
9.6 KiB
JSON

{
"id": "api/platform-browser/animations/BrowserAnimationsModule",
"title": "BrowserAnimationsModule",
"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/platform-browser\", \"name\": \"@angular/platform-browser\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/platform-browser/animations\", \"name\": \"@angular/platform-browser/animations\" } },\n { \"@type\": \"ListItem\", \"position\": 4, \"item\": { \"@id\": \"https://angular.io/api/platform-browser/animations/BrowserAnimationsModule\", \"name\": \"BrowserAnimationsModule\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/platform-browser\">@angular/platform-browser</a> > <a href=\"api/platform-browser/animations\">@angular/platform-browser/animations</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/animations/src/module.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L24-L59\" 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/platform-browser/animations/src/module.ts#L24-L59\" 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=\"browseranimationsmodule\">BrowserAnimationsModule<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/animations/BrowserAnimationsModule#browseranimationsmodule\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label ngmodule\">ngmodule</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>Exports <code><a href=\"api/platform-browser/BrowserModule\" class=\"code-anchor\">BrowserModule</a></code> with additional <a href=\"guide/glossary#provider\">dependency-injection providers</a>\nfor use with animations. See <a href=\"guide/animations\">Animations</a>.</p>\n\n \n </section>\n \n \n \n <section class=\"ngmodule-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/platform-browser/animations/BrowserAnimationsModule\" class=\"code-anchor\">BrowserAnimationsModule</a> {\n <a class=\"code-anchor\" href=\"api/platform-browser/animations/BrowserAnimationsModule#withConfig\">static <span class=\"member-name\">withConfig</span>(config: BrowserAnimationsModuleConfig): ModuleWithProviders&#x3C;BrowserAnimationsModule></a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\n \n\n \n \n \n \n\n \n\n<section class=\"static-methods\">\n <h2 id=\"static-methods\">Static methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/animations/BrowserAnimationsModule#static-methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"withConfig\"></a>\n<table class=\"is-full-width method-table static-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"withconfig\">\n withConfig()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/animations/BrowserAnimationsModule#withconfig\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/animations/src/module.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L35-L58\" 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/platform-browser/animations/src/module.ts#L35-L58\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Configures the module based on the specified object.</p>\n\n <p>See also:</p>\n <ul>\n \n <li><p><code><a href=\"api/platform-browser/animations/BrowserAnimationsModuleConfig\" class=\"code-anchor\">BrowserAnimationsModuleConfig</a></code></p>\n</li>\n </ul>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><a href=\"api/upgrade/static\" class=\"code-anchor\">static</a> <span class=\"member-name\">withConfig</span>(config: BrowserAnimationsModuleConfig): ModuleWithProviders&#x3C;BrowserAnimationsModule></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table static-method-overload-parameters\">\n <tbody>\n \n <tr class=\"static-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>config</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/platform-browser/animations/BrowserAnimationsModuleConfig\" class=\"code-anchor\">BrowserAnimationsModuleConfig</a></code></td>\n <td class=\"param-description\">\n <p>Object used to configure the behavior of the <code><a href=\"api/platform-browser/animations/BrowserAnimationsModule\" class=\"code-anchor\">BrowserAnimationsModule</a></code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code><a href=\"api/core/ModuleWithProviders\" class=\"code-anchor\">ModuleWithProviders</a>&#x3C;<a href=\"api/platform-browser/animations/BrowserAnimationsModule\" class=\"code-anchor\">BrowserAnimationsModule</a>></code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n <tr>\n <td class=\"usage-notes\">\n <h4 id=\"withConfig-usage-notes\">Usage Notes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/animations/BrowserAnimationsModule#withConfig-usage-notes\"><i class=\"material-icons\">link</i></a></h4>\n <p>When registering the <code><a href=\"api/platform-browser/animations/BrowserAnimationsModule\" class=\"code-anchor\">BrowserAnimationsModule</a></code>, you can use the <code>withConfig</code>\nfunction as follows:</p>\n<code-example>\n@<a href=\"api/core/NgModule\" class=\"code-anchor\">NgModule</a>({\n imports: [BrowserAnimationsModule.withConfig(config)]\n})\nclass MyNgModule {}\n</code-example>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n</section>\n\n \n\n \n\n\n \n\n\n \n \n<section class=\"providers\">\n <h2 id=\"providers\">Providers<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/animations/BrowserAnimationsModule#providers\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Provider</th>\n </tr>\n </thead>\n <tbody>\n \n <tr>\n <td>\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box\">\n BROWSER_ANIMATIONS_PROVIDERS\n </code-example>\n </td>\n </tr>\n \n </tbody>\n </table>\n </section>\n\n \n\n \n \n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/animations\n - api/animations/AnimationBuilder\n - api/platform-browser/animations\n - api/platform-browser/animations/BrowserAnimationsModuleConfig\n - guide/animations\n - guide/elements\n - guide/route-animations\n - guide/router-tutorial-toh\n-->\n<!-- links from this doc:\n - /api\n - api/core/ModuleWithProviders\n - api/core/NgModule\n - api/platform-browser\n - api/platform-browser/BrowserModule\n - api/platform-browser/animations\n - api/platform-browser/animations/BrowserAnimationsModule#browseranimationsmodule\n - api/platform-browser/animations/BrowserAnimationsModule#providers\n - api/platform-browser/animations/BrowserAnimationsModule#static-methods\n - api/platform-browser/animations/BrowserAnimationsModule#withConfig\n - api/platform-browser/animations/BrowserAnimationsModule#withConfig-usage-notes\n - api/platform-browser/animations/BrowserAnimationsModule#withconfig\n - api/platform-browser/animations/BrowserAnimationsModuleConfig\n - api/upgrade/static\n - guide/animations\n - guide/glossary#provider\n - https://github.com/angular/angular/edit/master/packages/platform-browser/animations/src/module.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L24-L59\n - https://github.com/angular/angular/edit/master/packages/platform-browser/animations/src/module.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L35-L58\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/animations/src/module.ts#L24-L59\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/animations/src/module.ts#L35-L58\n-->"
}