5 lines
26 KiB
JSON
5 lines
26 KiB
JSON
{
|
|
"id": "api/animations/group",
|
|
"title": "group",
|
|
"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/animations\", \"name\": \"@angular/animations\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/animations/group\", \"name\": \"group\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/animations\">@angular/animations</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/animation_metadata.ts?message=docs(animations)%3A%20describe%20your%20change...#L668-L705\" 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/animations/src/animation_metadata.ts#L668-L705\" 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=\"group\">group<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/group#group\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label function\">function</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>Defines a list of animation steps to be run in parallel.</p>\n\n \n </section>\n \n \n \n\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"> <span class=\"member-name\"><a href=\"api/animations/group\" class=\"code-anchor\">group</a></span>(steps: <a href=\"api/animations/AnimationMetadata\" class=\"code-anchor\">AnimationMetadata</a>[], options: <a href=\"api/animations/AnimationOptions\" class=\"code-anchor\">AnimationOptions</a> = null): <a href=\"api/animations/AnimationGroupMetadata\" class=\"code-anchor\">AnimationGroupMetadata</a></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table function-overload-parameters\">\n <tbody>\n \n <tr class=\"function-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>steps</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/animations/AnimationMetadata\" class=\"code-anchor\">AnimationMetadata</a>[]</code></td>\n <td class=\"param-description\">\n <p>An array of animation step objects.</p>\n<ul>\n<li>When steps are defined by <code><a href=\"api/animations/style\" class=\"code-anchor\">style</a>()</code> or <code><a href=\"api/animations/animate\" class=\"code-anchor\">animate</a>()</code>\nfunction calls, each call within the group is executed instantly.</li>\n<li>To specify offset styles to be applied at a later time, define steps with\n<code><a href=\"api/animations/keyframes\" class=\"code-anchor\">keyframes</a>()</code>, or use <code><a href=\"api/animations/animate\" class=\"code-anchor\">animate</a>()</code> calls with a delay value.\nFor example:</li>\n</ul>\n<code-example language=\"typescript\">\ngroup([\n <a href=\"api/animations/animate\" class=\"code-anchor\">animate</a>(\"1s\", <a href=\"api/animations/style\" class=\"code-anchor\">style</a>({ background: \"black\" })),\n <a href=\"api/animations/animate\" class=\"code-anchor\">animate</a>(\"2s\", <a href=\"api/animations/style\" class=\"code-anchor\">style</a>({ color: \"white\" }))\n])\n</code-example>\n\n </td>\n </tr>\n <tr class=\"function-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/animations/AnimationOptions\" class=\"code-anchor\">AnimationOptions</a></code></td>\n <td class=\"param-description\">\n <p>An options object containing a delay and\ndeveloper-defined parameters that provide styling defaults and\ncan be overridden on invocation.</p>\n<p> Optional. Default is <code>null</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/animations/AnimationGroupMetadata\" class=\"code-anchor\">AnimationGroupMetadata</a></code>: An object that encapsulates the group data.</p>\n \n \n\n\n \n\n \n</div>\n\n\n \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/animations/group#usage-notes\"><i class=\"material-icons\">link</i></a></h2>\n <p>Grouped animations are useful when a series of styles must be\nanimated at different starting times and closed off at different ending times.</p>\n<p>When called within a <code><a href=\"api/animations/sequence\" class=\"code-anchor\">sequence</a>()</code> or a\n<code><a href=\"api/animations/transition\" class=\"code-anchor\">transition</a>()</code> call, does not continue to the next\ninstruction until all of the inner animation steps have completed.</p>\n\n</section>\n\n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/animations\n - api/animations/AnimationGroupMetadata\n - api/animations/AnimationMetadataType\n - api/animations/AnimationOptions\n - api/animations/animate\n - api/animations/sequence\n - api/animations/transition\n - api/forms/FormBuilder\n - guide/animations\n - guide/complex-animation-sequences\n - guide/reactive-forms\n-->\n<!-- links from this doc:\n - /api\n - api/animations\n - api/animations/AnimationGroupMetadata\n - api/animations/AnimationMetadata\n - api/animations/AnimationOptions\n - api/animations/animate\n - api/animations/group#group\n - api/animations/group#usage-notes\n - api/animations/keyframes\n - api/animations/sequence\n - api/animations/style\n - api/animations/transition\n - https://github.com/angular/angular/edit/master/packages/animations/src/animation_metadata.ts?message=docs(animations)%3A%20describe%20your%20change...#L668-L705\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/animation_metadata.ts#L668-L705\n-->"
|
|
} |