docs: update Angular CDK apis (angular#61874)

angular-robot · pkozlowski-opensource · commit fa2af076d270 · 2025-06-05T10:50:57.000+02:00
Updated Angular CDK api files. PR Close angular#61874
diff --git a/adev/src/content/cdk/_build-info.json b/adev/src/content/cdk/_build-info.json
@@ -1,4 +1,4 @@
 {
   "branchName": "refs/heads/main",
-  "sha": "e1fad0e3bf8090180cb2a966ac7d5a094ddc6a7c"
+  "sha": "2b8a4860d0941dc2c38f1db0d7f9ca8ffed407d0"
 }
diff --git a/adev/src/content/cdk/cdk_drag_drop.json b/adev/src/content/cdk/cdk_drag_drop.json
@@ -1371,6 +1371,14 @@
           "description": "Selector that will be used to resolve an alternate element container for the drop list.\nPassing an alternate container is useful for the cases where one might not have control\nover the parent node of the draggable items within the list (e.g. due to content projection).\nThis allows for usages like:\n\n```\n<div cdkDropList cdkDropListElementContainer=\".inner\">\n  <div class=\"inner\">\n    <div cdkDrag></div>\n  </div>\n</div>\n```",
           "jsdocTags": []
         },
+        {
+          "name": "hasAnchor",
+          "type": "boolean",
+          "memberType": "property",
+          "memberTags": [],
+          "description": "By default when an item leaves its initial container, its placeholder will be transferred\nto the new container. If that's not desirable for your use case, you can enable this option\nwhich will clone the placeholder and leave it inside the original container. If the item is\nreturned to the initial container, the anchor element will be removed automatically.\n\nThe cloned placeholder can be styled by targeting the `cdk-drag-anchor` class.\n\nThis option is useful in combination with `cdkDropListSortingDisabled` to implement copying\nbehavior in a drop list.",
+          "jsdocTags": []
+        },
         {
           "name": "dropped",
           "type": "EventEmitter<CdkDragDrop<T, any, any>>",
@@ -1591,7 +1599,7 @@
       "source": {
         "filePath": "/src/cdk/drag-drop/directives/drop-list.ts",
         "startLine": 36,
-        "endLine": 423
+        "endLine": 438
       }
     },
     {
@@ -2747,6 +2755,14 @@
           "description": "Number of pixels to scroll for each frame when auto-scrolling an element.",
           "jsdocTags": []
         },
+        {
+          "name": "hasAnchor",
+          "type": "boolean",
+          "memberType": "property",
+          "memberTags": [],
+          "description": "Whether the items in the list should leave an anchor node when leaving the initial container.",
+          "jsdocTags": []
+        },
         {
           "name": "enterPredicate",
           "type": "(drag: DragRef<any>, drop: DropListRef<any>) => boolean",
@@ -3858,6 +3874,70 @@
           "memberType": "method",
           "memberTags": []
         },
+        {
+          "name": "getItemAtIndex",
+          "signatures": [
+            {
+              "name": "getItemAtIndex",
+              "entryType": "function",
+              "description": "Gets the item at a specific index.",
+              "generics": [],
+              "isNewType": false,
+              "jsdocTags": [
+                {
+                  "name": "param",
+                  "comment": "Index at which to retrieve the item."
+                }
+              ],
+              "params": [
+                {
+                  "name": "index",
+                  "description": "Index at which to retrieve the item.",
+                  "type": "number",
+                  "isOptional": false,
+                  "isRestParam": false
+                }
+              ],
+              "rawComment": "/**\n   * Gets the item at a specific index.\n   * @param index Index at which to retrieve the item.\n   */",
+              "returnType": "DragRef<any> | null"
+            }
+          ],
+          "implementation": {
+            "params": [
+              {
+                "name": "index",
+                "description": "Index at which to retrieve the item.",
+                "type": "number",
+                "isOptional": false,
+                "isRestParam": false
+              }
+            ],
+            "isNewType": false,
+            "returnType": "DragRef<any> | null",
+            "generics": [],
+            "name": "getItemAtIndex",
+            "description": "Gets the item at a specific index.",
+            "entryType": "function",
+            "jsdocTags": [
+              {
+                "name": "param",
+                "comment": "Index at which to retrieve the item."
+              }
+            ],
+            "rawComment": "/**\n   * Gets the item at a specific index.\n   * @param index Index at which to retrieve the item.\n   */"
+          },
+          "entryType": "function",
+          "description": "Gets the item at a specific index.",
+          "jsdocTags": [
+            {
+              "name": "param",
+              "comment": "Index at which to retrieve the item."
+            }
+          ],
+          "rawComment": "/**\n   * Gets the item at a specific index.\n   * @param index Index at which to retrieve the item.\n   */",
+          "memberType": "method",
+          "memberTags": []
+        },
         {
           "name": "isReceiving",
           "signatures": [
@@ -3905,7 +3985,7 @@
       "source": {
         "filePath": "/src/cdk/drag-drop/drop-list-ref.ts",
         "startLine": 55,
-        "endLine": 772
+        "endLine": 787
       }
     },
     {
@@ -4681,8 +4761,8 @@
       "implements": [],
       "source": {
         "filePath": "/src/cdk/drag-drop/drag-ref.ts",
-        "startLine": 99,
-        "endLine": 102
+        "startLine": 102,
+        "endLine": 105
       }
     },
     {
@@ -4695,8 +4775,8 @@
       "jsdocTags": [],
       "source": {
         "filePath": "/src/cdk/drag-drop/drag-ref.ts",
-        "startLine": 122,
-        "endLine": 122
+        "startLine": 125,
+        "endLine": 125
       }
     },
     {
@@ -5885,8 +5965,8 @@
       "implements": [],
       "source": {
         "filePath": "/src/cdk/drag-drop/drag-ref.ts",
-        "startLine": 127,
-        "endLine": 1588
+        "startLine": 130,
+        "endLine": 1631
       }
     }
   ],
@@ -6463,6 +6543,10 @@
       "CdkDropList.elementContainerSelector",
       "@angular/cdk/drag-drop"
     ],
+    [
+      "CdkDropList.hasAnchor",
+      "@angular/cdk/drag-drop"
+    ],
     [
       "CdkDropList.dropped",
       "@angular/cdk/drag-drop"
@@ -6639,6 +6723,10 @@
       "DropListRef.autoScrollStep",
       "@angular/cdk/drag-drop"
     ],
+    [
+      "DropListRef.hasAnchor",
+      "@angular/cdk/drag-drop"
+    ],
     [
       "DropListRef.enterPredicate",
       "@angular/cdk/drag-drop"
@@ -6735,6 +6823,10 @@
       "DropListRef.getItemIndex",
       "@angular/cdk/drag-drop"
     ],
+    [
+      "DropListRef.getItemAtIndex",
+      "@angular/cdk/drag-drop"
+    ],
     [
       "DropListRef.isReceiving",
       "@angular/cdk/drag-drop"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"branchName": "refs/heads/main",`
`3`		`- "sha": "e1fad0e3bf8090180cb2a966ac7d5a094ddc6a7c"`
	`3`	`+ "sha": "2b8a4860d0941dc2c38f1db0d7f9ca8ffed407d0"`
`4`	`4`	`}`