docs: update Angular CDK apis (#64642)

Updated Angular CDK api files.

PR Close #64642
This commit is contained in:
Angular Robot 2025-10-24 07:37:06 +00:00 committed by Kristiyan Kostadinov
parent ebdef35a6b
commit c02aa80c5e
6 changed files with 26 additions and 25 deletions

View file

@ -1,4 +1,4 @@
{
"branchName": "refs/heads/21.0.x",
"sha": "f6ac1da38b8d3f1f52df5c78162b3303bf82c413"
"sha": "21d4a3f8b6fbf58c471b0df00da53736580fcc59"
}

View file

@ -135,7 +135,6 @@
},
{
"name": "CdkDragStart",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -164,6 +163,7 @@
"description": "Event emitted when the user starts dragging a draggable.",
"jsdocTags": [],
"rawComment": "/** Event emitted when the user starts dragging a draggable. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-events.ts",
@ -246,7 +246,6 @@
},
{
"name": "CdkDragRelease",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -275,6 +274,7 @@
"description": "Event emitted when the user releases an item, before any animations have started.",
"jsdocTags": [],
"rawComment": "/** Event emitted when the user releases an item, before any animations have started. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-events.ts",
@ -923,7 +923,6 @@
},
{
"name": "CdkDragEnd",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -968,6 +967,7 @@
"description": "Event emitted when the user stops dragging a draggable.",
"jsdocTags": [],
"rawComment": "/** Event emitted when the user stops dragging a draggable. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-events.ts",
@ -977,7 +977,6 @@
},
{
"name": "DragDropConfig",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -1136,7 +1135,9 @@
"description": "Object that can be used to configure the drag\nitems and drop lists within a module or a component.",
"jsdocTags": [],
"rawComment": "/**\n * Object that can be used to configure the drag\n * items and drop lists within a module or a component.\n */",
"extends": "Partial<DragRefConfig>",
"extends": [
"Partial<DragRefConfig>"
],
"implements": [],
"source": {
"filePath": "src/cdk/drag-drop/directives/config.ts",
@ -1604,7 +1605,6 @@
},
{
"name": "DragRefConfig",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -1648,6 +1648,7 @@
"description": "Object that can be used to configure the behavior of DragRef.",
"jsdocTags": [],
"rawComment": "/** Object that can be used to configure the behavior of DragRef. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-ref.ts",
@ -2400,7 +2401,6 @@
},
{
"name": "CdkDragEnter",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -2441,6 +2441,7 @@
"description": "Event emitted when the user moves an item into a new drop container.",
"jsdocTags": [],
"rawComment": "/** Event emitted when the user moves an item into a new drop container. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-events.ts",
@ -2605,7 +2606,6 @@
},
{
"name": "CdkDragExit",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -2638,6 +2638,7 @@
"description": "Event emitted when the user removes an item from a\ndrop container by moving it into another one.",
"jsdocTags": [],
"rawComment": "/**\n * Event emitted when the user removes an item from a\n * drop container by moving it into another one.\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-events.ts",
@ -4571,7 +4572,6 @@
},
{
"name": "CdkDragDrop",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -4663,6 +4663,7 @@
"description": "Event emitted when the user drops a draggable item inside a drop container.",
"jsdocTags": [],
"rawComment": "/** Event emitted when the user drops a draggable item inside a drop container. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-events.ts",
@ -4672,7 +4673,6 @@
},
{
"name": "CdkDragMove",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -4725,6 +4725,7 @@
"description": "Event emitted as the user is dragging a draggable item.",
"jsdocTags": [],
"rawComment": "/** Event emitted as the user is dragging a draggable item. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-events.ts",
@ -4734,7 +4735,6 @@
},
{
"name": "Point",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -4758,6 +4758,7 @@
"description": "Point on the page or within an element.",
"jsdocTags": [],
"rawComment": "/** Point on the page or within an element. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-ref.ts",
@ -4781,7 +4782,6 @@
},
{
"name": "CdkDragSortEvent",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -4830,6 +4830,7 @@
"description": "Event emitted when the user swaps the position of two drag items.",
"jsdocTags": [],
"rawComment": "/** Event emitted when the user swaps the position of two drag items. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/drag-drop/drag-events.ts",

View file

@ -57,7 +57,6 @@
},
{
"name": "ElementDimensions",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -97,6 +96,7 @@
"description": "Dimensions for element size and its position relative to the viewport.",
"jsdocTags": [],
"rawComment": "/**\n * Dimensions for element size and its position relative to the viewport.\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/testing/element-dimensions.ts",
@ -106,7 +106,6 @@
},
{
"name": "AutoChangeDetectionStatus",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -132,6 +131,7 @@
"description": "The status of the test harness auto change detection. If not diabled test harnesses will\nautomatically trigger change detection after every action (such as a click) and before every read\n(such as getting the text of an element).",
"jsdocTags": [],
"rawComment": "/**\n * The status of the test harness auto change detection. If not diabled test harnesses will\n * automatically trigger change detection after every action (such as a click) and before every read\n * (such as getting the text of an element).\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "src/cdk/testing/change-detection.ts",
@ -141,7 +141,6 @@
},
{
"name": "ModifierKeys",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -189,6 +188,7 @@
"description": "Modifier keys that may be held while typing.",
"jsdocTags": [],
"rawComment": "/** Modifier keys that may be held while typing. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/testing/test-element.ts",
@ -2402,7 +2402,6 @@
},
{
"name": "TestElement",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -3177,6 +3176,7 @@
"description": "This acts as a common interface for DOM elements across both unit and e2e tests. It is the\ninterface through which the ComponentHarness interacts with the component's DOM.",
"jsdocTags": [],
"rawComment": "/**\n * This acts as a common interface for DOM elements across both unit and e2e tests. It is the\n * interface through which the ComponentHarness interacts with the component's DOM.\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/testing/test-element.ts",
@ -3222,7 +3222,6 @@
},
{
"name": "HarnessLoader",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -3675,6 +3674,7 @@
"description": "Interface used to load ComponentHarness objects. This interface is used by test authors to\ninstantiate `ComponentHarness`es.",
"jsdocTags": [],
"rawComment": "/**\n * Interface used to load ComponentHarness objects. This interface is used by test authors to\n * instantiate `ComponentHarness`es.\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "src/cdk/testing/component-harness.ts",
@ -4016,7 +4016,6 @@
},
{
"name": "TextOptions",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -4034,6 +4033,7 @@
"description": "Options that affect the text returned by `TestElement.text`.",
"jsdocTags": [],
"rawComment": "/**\n * Options that affect the text returned by `TestElement.text`.\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/testing/test-element.ts",
@ -4043,7 +4043,6 @@
},
{
"name": "LocatorFactory",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -4458,6 +4457,7 @@
"description": "Interface used to create asynchronous locator functions used find elements and component\nharnesses. This interface is used by `ComponentHarness` authors to create locator functions for\ntheir `ComponentHarness` subclass.",
"jsdocTags": [],
"rawComment": "/**\n * Interface used to create asynchronous locator functions used find elements and component\n * harnesses. This interface is used by `ComponentHarness` authors to create locator functions for\n * their `ComponentHarness` subclass.\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "src/cdk/testing/component-harness.ts",
@ -6112,7 +6112,6 @@
},
{
"name": "ComponentHarnessConstructor",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -6133,6 +6132,7 @@
"description": "Constructor for a ComponentHarness subclass. To be a valid ComponentHarnessConstructor, the\nclass must also have a static `hostSelector` property.",
"jsdocTags": [],
"rawComment": "/**\n * Constructor for a ComponentHarness subclass. To be a valid ComponentHarnessConstructor, the\n * class must also have a static `hostSelector` property.\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "src/cdk/testing/component-harness.ts",
@ -6142,7 +6142,6 @@
},
{
"name": "BaseHarnessFilters",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -6170,6 +6169,7 @@
"description": "A set of criteria that can be used to filter a list of `ComponentHarness` instances.",
"jsdocTags": [],
"rawComment": "/** A set of criteria that can be used to filter a list of `ComponentHarness` instances. */",
"extends": [],
"implements": [],
"source": {
"filePath": "src/cdk/testing/component-harness.ts",

View file

@ -6,7 +6,6 @@
"entries": [
{
"name": "ProtractorHarnessEnvironmentOptions",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -31,6 +30,7 @@
}
],
"rawComment": "/**\n * Options to configure the environment.\n * @deprecated\n * @breaking-change 13.0.0\n */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/testing/protractor/protractor-harness-environment.ts",

View file

@ -1123,7 +1123,6 @@
},
{
"name": "WebDriverHarnessEnvironmentOptions",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -1139,6 +1138,7 @@
"description": "Options to configure the environment.",
"jsdocTags": [],
"rawComment": "/** Options to configure the environment. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/testing/selenium-webdriver/selenium-web-driver-harness-environment.ts",

View file

@ -6,7 +6,6 @@
"entries": [
{
"name": "TestbedHarnessEnvironmentOptions",
"isAbstract": false,
"entryType": "interface",
"members": [
{
@ -22,6 +21,7 @@
"description": "Options to configure the environment.",
"jsdocTags": [],
"rawComment": "/** Options to configure the environment. */",
"extends": [],
"implements": [],
"source": {
"filePath": "/src/cdk/testing/testbed/testbed-harness-environment.ts",