diff --git a/adev/src/content/cdk/_build-info.json b/adev/src/content/cdk/_build-info.json index d01e29ef1cc..5ef951d5500 100644 --- 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": "079d772c49bd8170ee4bf67bfd4bd9705503ad0e" + "sha": "0b2cabc2994899bae15e40a1575abf85d3540abc" } \ No newline at end of file diff --git a/adev/src/content/cdk/cdk_drag_drop.json b/adev/src/content/cdk/cdk_drag_drop.json index f4d6a471819..5da91e47529 100755 --- a/adev/src/content/cdk/cdk_drag_drop.json +++ b/adev/src/content/cdk/cdk_drag_drop.json @@ -186,6 +186,254 @@ "endLine": 13 } }, + { + "name": "DragDrop", + "isAbstract": false, + "entryType": "undecorated_class", + "members": [ + { + "name": "createDrag", + "signatures": [ + { + "name": "createDrag", + "entryType": "function", + "description": "Turns an element into a draggable item.", + "generics": [ + { + "name": "T", + "default": "any" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "Element to which to attach the dragging functionality." + }, + { + "name": "param", + "comment": "Object used to configure the dragging behavior." + }, + { + "name": "deprecated", + "comment": "Use the `createDragRef` function that provides better tree shaking." + }, + { + "name": "breaking-change", + "comment": "23.0.0" + } + ], + "params": [ + { + "name": "element", + "description": "Element to which to attach the dragging functionality.", + "type": "any", + "isOptional": false, + "isRestParam": false + }, + { + "name": "config", + "description": "Object used to configure the dragging behavior.", + "type": "DragRefConfig | undefined", + "isOptional": true, + "isRestParam": false + } + ], + "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n * @deprecated Use the `createDragRef` function that provides better tree shaking.\n * @breaking-change 23.0.0\n */", + "returnType": "DragRef" + } + ], + "implementation": { + "params": [ + { + "name": "element", + "description": "Element to which to attach the dragging functionality.", + "type": "any", + "isOptional": false, + "isRestParam": false + }, + { + "name": "config", + "description": "Object used to configure the dragging behavior.", + "type": "DragRefConfig | undefined", + "isOptional": true, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "DragRef", + "generics": [ + { + "name": "T", + "default": "any" + } + ], + "name": "createDrag", + "description": "Turns an element into a draggable item.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "Element to which to attach the dragging functionality." + }, + { + "name": "param", + "comment": "Object used to configure the dragging behavior." + }, + { + "name": "deprecated", + "comment": "Use the `createDragRef` function that provides better tree shaking." + }, + { + "name": "breaking-change", + "comment": "23.0.0" + } + ], + "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n * @deprecated Use the `createDragRef` function that provides better tree shaking.\n * @breaking-change 23.0.0\n */" + }, + "entryType": "function", + "description": "Turns an element into a draggable item.", + "jsdocTags": [ + { + "name": "param", + "comment": "Element to which to attach the dragging functionality." + }, + { + "name": "param", + "comment": "Object used to configure the dragging behavior." + }, + { + "name": "deprecated", + "comment": "Use the `createDragRef` function that provides better tree shaking." + }, + { + "name": "breaking-change", + "comment": "23.0.0" + } + ], + "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n * @deprecated Use the `createDragRef` function that provides better tree shaking.\n * @breaking-change 23.0.0\n */", + "memberType": "method", + "memberTags": [] + }, + { + "name": "createDropList", + "signatures": [ + { + "name": "createDropList", + "entryType": "function", + "description": "Turns an element into a drop list.", + "generics": [ + { + "name": "T", + "default": "any" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "Element to which to attach the drop list functionality." + }, + { + "name": "deprecated", + "comment": "Use the `createDropListRef` function that provides better tree shaking." + }, + { + "name": "breaking-change", + "comment": "23.0.0" + } + ], + "params": [ + { + "name": "element", + "description": "Element to which to attach the drop list functionality.", + "type": "any", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n * @deprecated Use the `createDropListRef` function that provides better tree shaking.\n * @breaking-change 23.0.0\n */", + "returnType": "DropListRef" + } + ], + "implementation": { + "params": [ + { + "name": "element", + "description": "Element to which to attach the drop list functionality.", + "type": "any", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "DropListRef", + "generics": [ + { + "name": "T", + "default": "any" + } + ], + "name": "createDropList", + "description": "Turns an element into a drop list.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "Element to which to attach the drop list functionality." + }, + { + "name": "deprecated", + "comment": "Use the `createDropListRef` function that provides better tree shaking." + }, + { + "name": "breaking-change", + "comment": "23.0.0" + } + ], + "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n * @deprecated Use the `createDropListRef` function that provides better tree shaking.\n * @breaking-change 23.0.0\n */" + }, + "entryType": "function", + "description": "Turns an element into a drop list.", + "jsdocTags": [ + { + "name": "param", + "comment": "Element to which to attach the drop list functionality." + }, + { + "name": "deprecated", + "comment": "Use the `createDropListRef` function that provides better tree shaking." + }, + { + "name": "breaking-change", + "comment": "23.0.0" + } + ], + "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n * @deprecated Use the `createDropListRef` function that provides better tree shaking.\n * @breaking-change 23.0.0\n */", + "memberType": "method", + "memberTags": [] + } + ], + "generics": [], + "description": "Service that allows for drag-and-drop functionality to be attached to DOM elements.", + "jsdocTags": [ + { + "name": "deprecated", + "comment": "Use the `createDragRef` or `createDropListRef` function for better tree shaking.\nWill be removed in v23." + }, + { + "name": "breaking-change", + "comment": "23.0.0" + } + ], + "rawComment": "/**\n * Service that allows for drag-and-drop functionality to be attached to DOM elements.\n * @deprecated Use the `createDragRef` or `createDropListRef` function for better tree shaking.\n * Will be removed in v23.\n * @breaking-change 23.0.0\n */", + "implements": [], + "source": { + "filePath": "/src/cdk/drag-drop/drag-drop.ts", + "startLine": 19, + "endLine": 49 + } + }, { "name": "DragAxis", "type": "'x' | 'y'", @@ -375,197 +623,6 @@ "endLine": 42 } }, - { - "name": "DragDrop", - "isAbstract": false, - "entryType": "undecorated_class", - "members": [ - { - "name": "createDrag", - "signatures": [ - { - "name": "createDrag", - "entryType": "function", - "description": "Turns an element into a draggable item.", - "generics": [ - { - "name": "T", - "default": "any" - } - ], - "isNewType": false, - "jsdocTags": [ - { - "name": "param", - "comment": "Element to which to attach the dragging functionality." - }, - { - "name": "param", - "comment": "Object used to configure the dragging behavior." - } - ], - "params": [ - { - "name": "element", - "description": "Element to which to attach the dragging functionality.", - "type": "any", - "isOptional": false, - "isRestParam": false - }, - { - "name": "config", - "description": "Object used to configure the dragging behavior.", - "type": "DragRefConfig", - "isOptional": true, - "isRestParam": false - } - ], - "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */", - "returnType": "DragRef" - } - ], - "implementation": { - "params": [ - { - "name": "element", - "description": "Element to which to attach the dragging functionality.", - "type": "any", - "isOptional": false, - "isRestParam": false - }, - { - "name": "config", - "description": "Object used to configure the dragging behavior.", - "type": "DragRefConfig", - "isOptional": true, - "isRestParam": false - } - ], - "isNewType": false, - "returnType": "DragRef", - "generics": [ - { - "name": "T", - "default": "any" - } - ], - "name": "createDrag", - "description": "Turns an element into a draggable item.", - "entryType": "function", - "jsdocTags": [ - { - "name": "param", - "comment": "Element to which to attach the dragging functionality." - }, - { - "name": "param", - "comment": "Object used to configure the dragging behavior." - } - ], - "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */" - }, - "entryType": "function", - "description": "Turns an element into a draggable item.", - "jsdocTags": [ - { - "name": "param", - "comment": "Element to which to attach the dragging functionality." - }, - { - "name": "param", - "comment": "Object used to configure the dragging behavior." - } - ], - "rawComment": "/**\n * Turns an element into a draggable item.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */", - "memberType": "method", - "memberTags": [] - }, - { - "name": "createDropList", - "signatures": [ - { - "name": "createDropList", - "entryType": "function", - "description": "Turns an element into a drop list.", - "generics": [ - { - "name": "T", - "default": "any" - } - ], - "isNewType": false, - "jsdocTags": [ - { - "name": "param", - "comment": "Element to which to attach the drop list functionality." - } - ], - "params": [ - { - "name": "element", - "description": "Element to which to attach the drop list functionality.", - "type": "any", - "isOptional": false, - "isRestParam": false - } - ], - "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n */", - "returnType": "DropListRef" - } - ], - "implementation": { - "params": [ - { - "name": "element", - "description": "Element to which to attach the drop list functionality.", - "type": "any", - "isOptional": false, - "isRestParam": false - } - ], - "isNewType": false, - "returnType": "DropListRef", - "generics": [ - { - "name": "T", - "default": "any" - } - ], - "name": "createDropList", - "description": "Turns an element into a drop list.", - "entryType": "function", - "jsdocTags": [ - { - "name": "param", - "comment": "Element to which to attach the drop list functionality." - } - ], - "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n */" - }, - "entryType": "function", - "description": "Turns an element into a drop list.", - "jsdocTags": [ - { - "name": "param", - "comment": "Element to which to attach the drop list functionality." - } - ], - "rawComment": "/**\n * Turns an element into a drop list.\n * @param element Element to which to attach the drop list functionality.\n */", - "memberType": "method", - "memberTags": [] - } - ], - "generics": [], - "description": "Service that allows for drag-and-drop functionality to be attached to DOM elements.", - "jsdocTags": [], - "rawComment": "/**\n * Service that allows for drag-and-drop functionality to be attached to DOM elements.\n */", - "implements": [], - "source": { - "filePath": "/src/cdk/drag-drop/drag-drop.ts", - "startLine": 25, - "endLine": 69 - } - }, { "name": "CdkDragPlaceholder", "isAbstract": false, @@ -1606,59 +1663,6 @@ "endLine": 436 } }, - { - "name": "DragRefConfig", - "entryType": "interface", - "members": [ - { - "name": "dragStartThreshold", - "type": "number", - "memberType": "property", - "memberTags": [], - "description": "Minimum amount of pixels that the user should\ndrag, before the CDK initiates a drag sequence.", - "jsdocTags": [] - }, - { - "name": "pointerDirectionChangeThreshold", - "type": "number", - "memberType": "property", - "memberTags": [], - "description": "Amount the pixels the user should drag before the CDK\nconsiders them to have changed the drag direction.", - "jsdocTags": [] - }, - { - "name": "zIndex", - "type": "number | undefined", - "memberType": "property", - "memberTags": [ - "optional" - ], - "description": "`z-index` for the absolutely-positioned elements that are created by the drag item.", - "jsdocTags": [] - }, - { - "name": "parentDragRef", - "type": "DragRef | undefined", - "memberType": "property", - "memberTags": [ - "optional" - ], - "description": "Ref that the current drag item is nested in.", - "jsdocTags": [] - } - ], - "generics": [], - "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", - "startLine": 40, - "endLine": 58 - } - }, { "name": "DragDropRegistry", "isAbstract": false, @@ -2402,6 +2406,59 @@ "endLine": 336 } }, + { + "name": "DragRefConfig", + "entryType": "interface", + "members": [ + { + "name": "dragStartThreshold", + "type": "number", + "memberType": "property", + "memberTags": [], + "description": "Minimum amount of pixels that the user should\ndrag, before the CDK initiates a drag sequence.", + "jsdocTags": [] + }, + { + "name": "pointerDirectionChangeThreshold", + "type": "number", + "memberType": "property", + "memberTags": [], + "description": "Amount the pixels the user should drag before the CDK\nconsiders them to have changed the drag direction.", + "jsdocTags": [] + }, + { + "name": "zIndex", + "type": "number | undefined", + "memberType": "property", + "memberTags": [ + "optional" + ], + "description": "`z-index` for the absolutely-positioned elements that are created by the drag item.", + "jsdocTags": [] + }, + { + "name": "parentDragRef", + "type": "DragRef | undefined", + "memberType": "property", + "memberTags": [ + "optional" + ], + "description": "Ref that the current drag item is nested in.", + "jsdocTags": [] + } + ], + "generics": [], + "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", + "startLine": 43, + "endLine": 61 + } + }, { "name": "CdkDragEnter", "entryType": "interface", @@ -2649,6 +2706,792 @@ "endLine": 59 } }, + { + "name": "CDK_DROP_LIST", + "type": "any", + "entryType": "constant", + "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDropList`. It serves as\n * alternative token to the actual `CdkDropList` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", + "description": "Injection token that can be used to reference instances of `CdkDropList`. It serves as\nalternative token to the actual `CdkDropList` class which could cause unnecessary\nretention of the class and its directive metadata.", + "jsdocTags": [], + "source": { + "filePath": "/src/cdk/drag-drop/directives/drag.ts", + "startLine": 57, + "endLine": 57 + } + }, + { + "name": "createDropListRef", + "signatures": [ + { + "name": "createDropListRef", + "entryType": "function", + "description": "Creates a `DropListRef` for an element, turning it into a drop list.", + "generics": [ + { + "name": "T", + "default": "unknown" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "Injector used to resolve dependencies." + }, + { + "name": "param", + "comment": "Element to which to attach the drop list functionality." + } + ], + "params": [ + { + "name": "injector", + "description": "Injector used to resolve dependencies.", + "type": "Injector", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "Element to which to attach the drop list functionality.", + "type": "any", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Creates a `DropListRef` for an element, turning it into a drop list.\n * @param injector Injector used to resolve dependencies.\n * @param element Element to which to attach the drop list functionality.\n */", + "returnType": "DropListRef" + } + ], + "implementation": { + "params": [ + { + "name": "injector", + "description": "Injector used to resolve dependencies.", + "type": "Injector", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "Element to which to attach the drop list functionality.", + "type": "any", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "DropListRef", + "generics": [ + { + "name": "T", + "default": "unknown" + } + ], + "name": "createDropListRef", + "description": "Creates a `DropListRef` for an element, turning it into a drop list.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "Injector used to resolve dependencies." + }, + { + "name": "param", + "comment": "Element to which to attach the drop list functionality." + } + ], + "rawComment": "/**\n * Creates a `DropListRef` for an element, turning it into a drop list.\n * @param injector Injector used to resolve dependencies.\n * @param element Element to which to attach the drop list functionality.\n */" + }, + "entryType": "function", + "description": "Creates a `DropListRef` for an element, turning it into a drop list.", + "jsdocTags": [ + { + "name": "param", + "comment": "Injector used to resolve dependencies." + }, + { + "name": "param", + "comment": "Element to which to attach the drop list functionality." + } + ], + "rawComment": "/**\n * Creates a `DropListRef` for an element, turning it into a drop list.\n * @param injector Injector used to resolve dependencies.\n * @param element Element to which to attach the drop list functionality.\n */", + "source": { + "filePath": "/src/cdk/drag-drop/drop-list-ref.ts", + "startLine": 57, + "endLine": 68 + } + }, + { + "name": "CdkDrag", + "isAbstract": false, + "entryType": "undecorated_class", + "members": [ + { + "name": "element", + "type": "any", + "memberType": "property", + "memberTags": [], + "description": "", + "jsdocTags": [] + }, + { + "name": "dropContainer", + "type": "any", + "memberType": "property", + "memberTags": [], + "description": "", + "jsdocTags": [] + }, + { + "name": "data", + "type": "T", + "memberType": "property", + "memberTags": [], + "description": "Arbitrary data to attach to this drag instance.", + "jsdocTags": [] + }, + { + "name": "lockAxis", + "type": "DragAxis | null", + "memberType": "property", + "memberTags": [], + "description": "Locks the position of the dragged element along the specified axis.", + "jsdocTags": [] + }, + { + "name": "rootElementSelector", + "type": "string", + "memberType": "property", + "memberTags": [], + "description": "Selector that will be used to determine the root draggable element, starting from\nthe `cdkDrag` element and going up the DOM. Passing an alternate root element is useful\nwhen trying to enable dragging on an element that you might not have access to.", + "jsdocTags": [] + }, + { + "name": "boundaryElement", + "type": "any", + "memberType": "property", + "memberTags": [], + "description": "Node or selector that will be used to determine the element to which the draggable's\nposition will be constrained. If a string is passed in, it'll be used as a selector that\nwill be matched starting from the element's parent and going up the DOM until a match\nhas been found.", + "jsdocTags": [] + }, + { + "name": "dragStartDelay", + "type": "DragStartDelay", + "memberType": "property", + "memberTags": [], + "description": "Amount of milliseconds to wait after the user has put their\npointer down before starting to drag the element.", + "jsdocTags": [] + }, + { + "name": "freeDragPosition", + "type": "Point", + "memberType": "property", + "memberTags": [], + "description": "Sets the position of a `CdkDrag` that is outside of a drop container.\nCan be used to restore the element's position for a returning user.", + "jsdocTags": [] + }, + { + "name": "disabled", + "type": "boolean", + "memberType": "getter", + "memberTags": [], + "description": "Whether starting to drag this element is disabled.", + "jsdocTags": [] + }, + { + "name": "disabled", + "type": "boolean", + "memberType": "setter", + "memberTags": [], + "description": "", + "jsdocTags": [] + }, + { + "name": "constrainPosition", + "type": "DragConstrainPosition | undefined", + "memberType": "property", + "memberTags": [ + "optional" + ], + "description": "Function that can be used to customize the logic of how the position of the drag item\nis limited while it's being dragged. Gets called with a point containing the current position\nof the user's pointer on the page, a reference to the item being dragged and its dimensions.\nShould return a point describing where the item should be rendered.", + "jsdocTags": [] + }, + { + "name": "previewClass", + "type": "string | string[]", + "memberType": "property", + "memberTags": [], + "description": "Class to be added to the preview element.", + "jsdocTags": [] + }, + { + "name": "previewContainer", + "type": "any", + "memberType": "property", + "memberTags": [], + "description": "Configures the place into which the preview of the item will be inserted. Can be configured\nglobally through `CDK_DROP_LIST`. Possible values:\n- `global` - Preview will be inserted at the bottom of the ``. The advantage is that\nyou don't have to worry about `overflow: hidden` or `z-index`, but the item won't retain\nits inherited styles.\n- `parent` - Preview will be inserted into the parent of the drag item. The advantage is that\ninherited styles will be preserved, but it may be clipped by `overflow: hidden` or not be\nvisible due to `z-index`. Furthermore, the preview is going to have an effect over selectors\nlike `:nth-child` and some flexbox configurations.\n- `ElementRef | HTMLElement` - Preview will be inserted into a specific element.\nSame advantages and disadvantages as `parent`.", + "jsdocTags": [] + }, + { + "name": "scale", + "type": "number", + "memberType": "property", + "memberTags": [], + "description": "If the parent of the dragged element has a `scale` transform, it can throw off the\npositioning when the user starts dragging. Use this input to notify the CDK of the scale.", + "jsdocTags": [] + }, + { + "name": "started", + "type": "EventEmitter>", + "memberType": "property", + "memberTags": [ + "readonly" + ], + "description": "Emits when the user starts dragging the item.", + "jsdocTags": [] + }, + { + "name": "released", + "type": "EventEmitter>", + "memberType": "property", + "memberTags": [ + "readonly" + ], + "description": "Emits when the user has released a drag item, before any animations have started.", + "jsdocTags": [] + }, + { + "name": "ended", + "type": "EventEmitter>", + "memberType": "property", + "memberTags": [ + "readonly" + ], + "description": "Emits when the user stops dragging an item in the container.", + "jsdocTags": [] + }, + { + "name": "entered", + "type": "EventEmitter>", + "memberType": "property", + "memberTags": [ + "readonly" + ], + "description": "Emits when the user has moved the item into a new container.", + "jsdocTags": [] + }, + { + "name": "exited", + "type": "EventEmitter>", + "memberType": "property", + "memberTags": [ + "readonly" + ], + "description": "Emits when the user removes the item its container by dragging it into another container.", + "jsdocTags": [] + }, + { + "name": "dropped", + "type": "EventEmitter>", + "memberType": "property", + "memberTags": [ + "readonly" + ], + "description": "Emits when the user drops the item inside a container.", + "jsdocTags": [] + }, + { + "name": "moved", + "type": "Observable>", + "memberType": "property", + "memberTags": [ + "readonly" + ], + "description": "Emits as the user is dragging the item. Use with caution,\nbecause this event will fire for every pixel that the user has dragged.", + "jsdocTags": [] + }, + { + "name": "getPlaceholderElement", + "signatures": [ + { + "name": "getPlaceholderElement", + "entryType": "function", + "description": "Returns the element that is being used as a placeholder\nwhile the current element is being dragged.", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "/**\n * Returns the element that is being used as a placeholder\n * while the current element is being dragged.\n */", + "returnType": "HTMLElement" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "HTMLElement", + "generics": [], + "name": "getPlaceholderElement", + "description": "Returns the element that is being used as a placeholder\nwhile the current element is being dragged.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/**\n * Returns the element that is being used as a placeholder\n * while the current element is being dragged.\n */" + }, + "entryType": "function", + "description": "Returns the element that is being used as a placeholder\nwhile the current element is being dragged.", + "jsdocTags": [], + "rawComment": "/**\n * Returns the element that is being used as a placeholder\n * while the current element is being dragged.\n */", + "memberType": "method", + "memberTags": [] + }, + { + "name": "getRootElement", + "signatures": [ + { + "name": "getRootElement", + "entryType": "function", + "description": "Returns the root draggable element.", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "/** Returns the root draggable element. */", + "returnType": "HTMLElement" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "HTMLElement", + "generics": [], + "name": "getRootElement", + "description": "Returns the root draggable element.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Returns the root draggable element. */" + }, + "entryType": "function", + "description": "Returns the root draggable element.", + "jsdocTags": [], + "rawComment": "/** Returns the root draggable element. */", + "memberType": "method", + "memberTags": [] + }, + { + "name": "reset", + "signatures": [ + { + "name": "reset", + "entryType": "function", + "description": "Resets a standalone drag item to its initial position.", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "/** Resets a standalone drag item to its initial position. */", + "returnType": "void" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "void", + "generics": [], + "name": "reset", + "description": "Resets a standalone drag item to its initial position.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Resets a standalone drag item to its initial position. */" + }, + "entryType": "function", + "description": "Resets a standalone drag item to its initial position.", + "jsdocTags": [], + "rawComment": "/** Resets a standalone drag item to its initial position. */", + "memberType": "method", + "memberTags": [] + }, + { + "name": "resetToBoundary", + "signatures": [ + { + "name": "resetToBoundary", + "entryType": "function", + "description": "Resets drag item to end of boundary element.", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "/** Resets drag item to end of boundary element. */", + "returnType": "void" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "void", + "generics": [], + "name": "resetToBoundary", + "description": "Resets drag item to end of boundary element.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Resets drag item to end of boundary element. */" + }, + "entryType": "function", + "description": "Resets drag item to end of boundary element.", + "jsdocTags": [], + "rawComment": "/** Resets drag item to end of boundary element. */", + "memberType": "method", + "memberTags": [] + }, + { + "name": "getFreeDragPosition", + "signatures": [ + { + "name": "getFreeDragPosition", + "entryType": "function", + "description": "Gets the pixel coordinates of the draggable outside of a drop container.", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "/**\n * Gets the pixel coordinates of the draggable outside of a drop container.\n */", + "returnType": "Readonly" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "Readonly", + "generics": [], + "name": "getFreeDragPosition", + "description": "Gets the pixel coordinates of the draggable outside of a drop container.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/**\n * Gets the pixel coordinates of the draggable outside of a drop container.\n */" + }, + "entryType": "function", + "description": "Gets the pixel coordinates of the draggable outside of a drop container.", + "jsdocTags": [], + "rawComment": "/**\n * Gets the pixel coordinates of the draggable outside of a drop container.\n */", + "memberType": "method", + "memberTags": [] + }, + { + "name": "setFreeDragPosition", + "signatures": [ + { + "name": "setFreeDragPosition", + "entryType": "function", + "description": "Sets the current position in pixels the draggable outside of a drop container.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "New position to be set." + } + ], + "params": [ + { + "name": "value", + "description": "New position to be set.", + "type": "Point", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Sets the current position in pixels the draggable outside of a drop container.\n * @param value New position to be set.\n */", + "returnType": "void" + } + ], + "implementation": { + "params": [ + { + "name": "value", + "description": "New position to be set.", + "type": "Point", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "void", + "generics": [], + "name": "setFreeDragPosition", + "description": "Sets the current position in pixels the draggable outside of a drop container.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "New position to be set." + } + ], + "rawComment": "/**\n * Sets the current position in pixels the draggable outside of a drop container.\n * @param value New position to be set.\n */" + }, + "entryType": "function", + "description": "Sets the current position in pixels the draggable outside of a drop container.", + "jsdocTags": [ + { + "name": "param", + "comment": "New position to be set." + } + ], + "rawComment": "/**\n * Sets the current position in pixels the draggable outside of a drop container.\n * @param value New position to be set.\n */", + "memberType": "method", + "memberTags": [] + }, + { + "name": "ngAfterViewInit", + "signatures": [ + { + "name": "ngAfterViewInit", + "entryType": "function", + "description": "", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "", + "returnType": "void" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "void", + "generics": [], + "name": "ngAfterViewInit", + "description": "", + "entryType": "function", + "jsdocTags": [], + "rawComment": "" + }, + "entryType": "function", + "description": "", + "jsdocTags": [], + "rawComment": "", + "memberType": "method", + "memberTags": [] + }, + { + "name": "ngOnChanges", + "signatures": [ + { + "name": "ngOnChanges", + "entryType": "function", + "description": "", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [ + { + "name": "changes", + "description": "", + "type": "SimpleChanges", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "", + "returnType": "void" + } + ], + "implementation": { + "params": [ + { + "name": "changes", + "description": "", + "type": "SimpleChanges", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "void", + "generics": [], + "name": "ngOnChanges", + "description": "", + "entryType": "function", + "jsdocTags": [], + "rawComment": "" + }, + "entryType": "function", + "description": "", + "jsdocTags": [], + "rawComment": "", + "memberType": "method", + "memberTags": [] + }, + { + "name": "ngOnDestroy", + "signatures": [ + { + "name": "ngOnDestroy", + "entryType": "function", + "description": "", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "", + "returnType": "void" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "void", + "generics": [], + "name": "ngOnDestroy", + "description": "", + "entryType": "function", + "jsdocTags": [], + "rawComment": "" + }, + "entryType": "function", + "description": "", + "jsdocTags": [], + "rawComment": "", + "memberType": "method", + "memberTags": [] + } + ], + "generics": [ + { + "name": "T", + "default": "any" + } + ], + "description": "Element that can be moved inside a CdkDropList container.", + "jsdocTags": [], + "rawComment": "/** Element that can be moved inside a CdkDropList container. */", + "implements": [ + "AfterViewInit", + "OnChanges", + "OnDestroy" + ], + "source": { + "filePath": "/src/cdk/drag-drop/directives/drag.ts", + "startLine": 60, + "endLine": 617 + } + }, + { + "name": "DragConstrainPosition", + "type": "(\n userPointerPosition: Point,\n dragRef: DragRef,\n dimensions: DOMRect,\n pickupPositionInElement: Point,\n) => Point", + "entryType": "type_alias", + "generics": [], + "rawComment": "/** Function that can be used to constrain the position of a dragged element. */", + "description": "Function that can be used to constrain the position of a dragged element.", + "jsdocTags": [], + "members": [], + "source": { + "filePath": "/src/cdk/drag-drop/drag-ref.ts", + "startLine": 64, + "endLine": 69 + } + }, + { + "name": "CdkDragDrop", + "entryType": "interface", + "members": [ + { + "name": "previousIndex", + "type": "number", + "memberType": "property", + "memberTags": [], + "description": "Index of the item when it was picked up.", + "jsdocTags": [] + }, + { + "name": "currentIndex", + "type": "number", + "memberType": "property", + "memberTags": [], + "description": "Current index of the item.", + "jsdocTags": [] + }, + { + "name": "item", + "type": "CdkDrag", + "memberType": "property", + "memberTags": [], + "description": "Item that is being dropped.", + "jsdocTags": [] + }, + { + "name": "container", + "type": "CdkDropList", + "memberType": "property", + "memberTags": [], + "description": "Container in which the item was dropped.", + "jsdocTags": [] + }, + { + "name": "previousContainer", + "type": "CdkDropList", + "memberType": "property", + "memberTags": [], + "description": "Container from which the item was picked up. Can be the same as the `container`.", + "jsdocTags": [] + }, + { + "name": "isPointerOverContainer", + "type": "boolean", + "memberType": "property", + "memberTags": [], + "description": "Whether the user's pointer was over the container when the item was dropped.", + "jsdocTags": [] + }, + { + "name": "distance", + "type": "{ x: number; y: number; }", + "memberType": "property", + "memberTags": [], + "description": "Distance in pixels that the user has dragged since the drag sequence started.", + "jsdocTags": [] + }, + { + "name": "dropPoint", + "type": "{ x: number; y: number; }", + "memberType": "property", + "memberTags": [], + "description": "Position where the pointer was when the item was dropped", + "jsdocTags": [] + }, + { + "name": "event", + "type": "MouseEvent | TouchEvent", + "memberType": "property", + "memberTags": [], + "description": "Native event that caused the drop event.", + "jsdocTags": [] + } + ], + "generics": [ + { + "name": "T" + }, + { + "name": "O", + "default": "T" + }, + { + "name": "I", + "default": "any" + } + ], + "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", + "startLine": 62, + "endLine": 81 + } + }, { "name": "DropListRef", "isAbstract": false, @@ -3988,691 +4831,8 @@ "implements": [], "source": { "filePath": "/src/cdk/drag-drop/drop-list-ref.ts", - "startLine": 55, - "endLine": 787 - } - }, - { - "name": "CDK_DROP_LIST", - "type": "any", - "entryType": "constant", - "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDropList`. It serves as\n * alternative token to the actual `CdkDropList` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", - "description": "Injection token that can be used to reference instances of `CdkDropList`. It serves as\nalternative token to the actual `CdkDropList` class which could cause unnecessary\nretention of the class and its directive metadata.", - "jsdocTags": [], - "source": { - "filePath": "/src/cdk/drag-drop/directives/drag.ts", - "startLine": 58, - "endLine": 58 - } - }, - { - "name": "CdkDrag", - "isAbstract": false, - "entryType": "undecorated_class", - "members": [ - { - "name": "element", - "type": "any", - "memberType": "property", - "memberTags": [], - "description": "", - "jsdocTags": [] - }, - { - "name": "dropContainer", - "type": "any", - "memberType": "property", - "memberTags": [], - "description": "", - "jsdocTags": [] - }, - { - "name": "data", - "type": "T", - "memberType": "property", - "memberTags": [], - "description": "Arbitrary data to attach to this drag instance.", - "jsdocTags": [] - }, - { - "name": "lockAxis", - "type": "DragAxis | null", - "memberType": "property", - "memberTags": [], - "description": "Locks the position of the dragged element along the specified axis.", - "jsdocTags": [] - }, - { - "name": "rootElementSelector", - "type": "string", - "memberType": "property", - "memberTags": [], - "description": "Selector that will be used to determine the root draggable element, starting from\nthe `cdkDrag` element and going up the DOM. Passing an alternate root element is useful\nwhen trying to enable dragging on an element that you might not have access to.", - "jsdocTags": [] - }, - { - "name": "boundaryElement", - "type": "any", - "memberType": "property", - "memberTags": [], - "description": "Node or selector that will be used to determine the element to which the draggable's\nposition will be constrained. If a string is passed in, it'll be used as a selector that\nwill be matched starting from the element's parent and going up the DOM until a match\nhas been found.", - "jsdocTags": [] - }, - { - "name": "dragStartDelay", - "type": "DragStartDelay", - "memberType": "property", - "memberTags": [], - "description": "Amount of milliseconds to wait after the user has put their\npointer down before starting to drag the element.", - "jsdocTags": [] - }, - { - "name": "freeDragPosition", - "type": "Point", - "memberType": "property", - "memberTags": [], - "description": "Sets the position of a `CdkDrag` that is outside of a drop container.\nCan be used to restore the element's position for a returning user.", - "jsdocTags": [] - }, - { - "name": "disabled", - "type": "boolean", - "memberType": "getter", - "memberTags": [], - "description": "Whether starting to drag this element is disabled.", - "jsdocTags": [] - }, - { - "name": "disabled", - "type": "boolean", - "memberType": "setter", - "memberTags": [], - "description": "", - "jsdocTags": [] - }, - { - "name": "constrainPosition", - "type": "DragConstrainPosition | undefined", - "memberType": "property", - "memberTags": [ - "optional" - ], - "description": "Function that can be used to customize the logic of how the position of the drag item\nis limited while it's being dragged. Gets called with a point containing the current position\nof the user's pointer on the page, a reference to the item being dragged and its dimensions.\nShould return a point describing where the item should be rendered.", - "jsdocTags": [] - }, - { - "name": "previewClass", - "type": "string | string[]", - "memberType": "property", - "memberTags": [], - "description": "Class to be added to the preview element.", - "jsdocTags": [] - }, - { - "name": "previewContainer", - "type": "any", - "memberType": "property", - "memberTags": [], - "description": "Configures the place into which the preview of the item will be inserted. Can be configured\nglobally through `CDK_DROP_LIST`. Possible values:\n- `global` - Preview will be inserted at the bottom of the ``. The advantage is that\nyou don't have to worry about `overflow: hidden` or `z-index`, but the item won't retain\nits inherited styles.\n- `parent` - Preview will be inserted into the parent of the drag item. The advantage is that\ninherited styles will be preserved, but it may be clipped by `overflow: hidden` or not be\nvisible due to `z-index`. Furthermore, the preview is going to have an effect over selectors\nlike `:nth-child` and some flexbox configurations.\n- `ElementRef | HTMLElement` - Preview will be inserted into a specific element.\nSame advantages and disadvantages as `parent`.", - "jsdocTags": [] - }, - { - "name": "scale", - "type": "number", - "memberType": "property", - "memberTags": [], - "description": "If the parent of the dragged element has a `scale` transform, it can throw off the\npositioning when the user starts dragging. Use this input to notify the CDK of the scale.", - "jsdocTags": [] - }, - { - "name": "started", - "type": "EventEmitter>", - "memberType": "property", - "memberTags": [ - "readonly" - ], - "description": "Emits when the user starts dragging the item.", - "jsdocTags": [] - }, - { - "name": "released", - "type": "EventEmitter>", - "memberType": "property", - "memberTags": [ - "readonly" - ], - "description": "Emits when the user has released a drag item, before any animations have started.", - "jsdocTags": [] - }, - { - "name": "ended", - "type": "EventEmitter>", - "memberType": "property", - "memberTags": [ - "readonly" - ], - "description": "Emits when the user stops dragging an item in the container.", - "jsdocTags": [] - }, - { - "name": "entered", - "type": "EventEmitter>", - "memberType": "property", - "memberTags": [ - "readonly" - ], - "description": "Emits when the user has moved the item into a new container.", - "jsdocTags": [] - }, - { - "name": "exited", - "type": "EventEmitter>", - "memberType": "property", - "memberTags": [ - "readonly" - ], - "description": "Emits when the user removes the item its container by dragging it into another container.", - "jsdocTags": [] - }, - { - "name": "dropped", - "type": "EventEmitter>", - "memberType": "property", - "memberTags": [ - "readonly" - ], - "description": "Emits when the user drops the item inside a container.", - "jsdocTags": [] - }, - { - "name": "moved", - "type": "Observable>", - "memberType": "property", - "memberTags": [ - "readonly" - ], - "description": "Emits as the user is dragging the item. Use with caution,\nbecause this event will fire for every pixel that the user has dragged.", - "jsdocTags": [] - }, - { - "name": "getPlaceholderElement", - "signatures": [ - { - "name": "getPlaceholderElement", - "entryType": "function", - "description": "Returns the element that is being used as a placeholder\nwhile the current element is being dragged.", - "generics": [], - "isNewType": false, - "jsdocTags": [], - "params": [], - "rawComment": "/**\n * Returns the element that is being used as a placeholder\n * while the current element is being dragged.\n */", - "returnType": "HTMLElement" - } - ], - "implementation": { - "params": [], - "isNewType": false, - "returnType": "HTMLElement", - "generics": [], - "name": "getPlaceholderElement", - "description": "Returns the element that is being used as a placeholder\nwhile the current element is being dragged.", - "entryType": "function", - "jsdocTags": [], - "rawComment": "/**\n * Returns the element that is being used as a placeholder\n * while the current element is being dragged.\n */" - }, - "entryType": "function", - "description": "Returns the element that is being used as a placeholder\nwhile the current element is being dragged.", - "jsdocTags": [], - "rawComment": "/**\n * Returns the element that is being used as a placeholder\n * while the current element is being dragged.\n */", - "memberType": "method", - "memberTags": [] - }, - { - "name": "getRootElement", - "signatures": [ - { - "name": "getRootElement", - "entryType": "function", - "description": "Returns the root draggable element.", - "generics": [], - "isNewType": false, - "jsdocTags": [], - "params": [], - "rawComment": "/** Returns the root draggable element. */", - "returnType": "HTMLElement" - } - ], - "implementation": { - "params": [], - "isNewType": false, - "returnType": "HTMLElement", - "generics": [], - "name": "getRootElement", - "description": "Returns the root draggable element.", - "entryType": "function", - "jsdocTags": [], - "rawComment": "/** Returns the root draggable element. */" - }, - "entryType": "function", - "description": "Returns the root draggable element.", - "jsdocTags": [], - "rawComment": "/** Returns the root draggable element. */", - "memberType": "method", - "memberTags": [] - }, - { - "name": "reset", - "signatures": [ - { - "name": "reset", - "entryType": "function", - "description": "Resets a standalone drag item to its initial position.", - "generics": [], - "isNewType": false, - "jsdocTags": [], - "params": [], - "rawComment": "/** Resets a standalone drag item to its initial position. */", - "returnType": "void" - } - ], - "implementation": { - "params": [], - "isNewType": false, - "returnType": "void", - "generics": [], - "name": "reset", - "description": "Resets a standalone drag item to its initial position.", - "entryType": "function", - "jsdocTags": [], - "rawComment": "/** Resets a standalone drag item to its initial position. */" - }, - "entryType": "function", - "description": "Resets a standalone drag item to its initial position.", - "jsdocTags": [], - "rawComment": "/** Resets a standalone drag item to its initial position. */", - "memberType": "method", - "memberTags": [] - }, - { - "name": "resetToBoundary", - "signatures": [ - { - "name": "resetToBoundary", - "entryType": "function", - "description": "Resets drag item to end of boundary element.", - "generics": [], - "isNewType": false, - "jsdocTags": [], - "params": [], - "rawComment": "/** Resets drag item to end of boundary element. */", - "returnType": "void" - } - ], - "implementation": { - "params": [], - "isNewType": false, - "returnType": "void", - "generics": [], - "name": "resetToBoundary", - "description": "Resets drag item to end of boundary element.", - "entryType": "function", - "jsdocTags": [], - "rawComment": "/** Resets drag item to end of boundary element. */" - }, - "entryType": "function", - "description": "Resets drag item to end of boundary element.", - "jsdocTags": [], - "rawComment": "/** Resets drag item to end of boundary element. */", - "memberType": "method", - "memberTags": [] - }, - { - "name": "getFreeDragPosition", - "signatures": [ - { - "name": "getFreeDragPosition", - "entryType": "function", - "description": "Gets the pixel coordinates of the draggable outside of a drop container.", - "generics": [], - "isNewType": false, - "jsdocTags": [], - "params": [], - "rawComment": "/**\n * Gets the pixel coordinates of the draggable outside of a drop container.\n */", - "returnType": "Readonly" - } - ], - "implementation": { - "params": [], - "isNewType": false, - "returnType": "Readonly", - "generics": [], - "name": "getFreeDragPosition", - "description": "Gets the pixel coordinates of the draggable outside of a drop container.", - "entryType": "function", - "jsdocTags": [], - "rawComment": "/**\n * Gets the pixel coordinates of the draggable outside of a drop container.\n */" - }, - "entryType": "function", - "description": "Gets the pixel coordinates of the draggable outside of a drop container.", - "jsdocTags": [], - "rawComment": "/**\n * Gets the pixel coordinates of the draggable outside of a drop container.\n */", - "memberType": "method", - "memberTags": [] - }, - { - "name": "setFreeDragPosition", - "signatures": [ - { - "name": "setFreeDragPosition", - "entryType": "function", - "description": "Sets the current position in pixels the draggable outside of a drop container.", - "generics": [], - "isNewType": false, - "jsdocTags": [ - { - "name": "param", - "comment": "New position to be set." - } - ], - "params": [ - { - "name": "value", - "description": "New position to be set.", - "type": "Point", - "isOptional": false, - "isRestParam": false - } - ], - "rawComment": "/**\n * Sets the current position in pixels the draggable outside of a drop container.\n * @param value New position to be set.\n */", - "returnType": "void" - } - ], - "implementation": { - "params": [ - { - "name": "value", - "description": "New position to be set.", - "type": "Point", - "isOptional": false, - "isRestParam": false - } - ], - "isNewType": false, - "returnType": "void", - "generics": [], - "name": "setFreeDragPosition", - "description": "Sets the current position in pixels the draggable outside of a drop container.", - "entryType": "function", - "jsdocTags": [ - { - "name": "param", - "comment": "New position to be set." - } - ], - "rawComment": "/**\n * Sets the current position in pixels the draggable outside of a drop container.\n * @param value New position to be set.\n */" - }, - "entryType": "function", - "description": "Sets the current position in pixels the draggable outside of a drop container.", - "jsdocTags": [ - { - "name": "param", - "comment": "New position to be set." - } - ], - "rawComment": "/**\n * Sets the current position in pixels the draggable outside of a drop container.\n * @param value New position to be set.\n */", - "memberType": "method", - "memberTags": [] - }, - { - "name": "ngAfterViewInit", - "signatures": [ - { - "name": "ngAfterViewInit", - "entryType": "function", - "description": "", - "generics": [], - "isNewType": false, - "jsdocTags": [], - "params": [], - "rawComment": "", - "returnType": "void" - } - ], - "implementation": { - "params": [], - "isNewType": false, - "returnType": "void", - "generics": [], - "name": "ngAfterViewInit", - "description": "", - "entryType": "function", - "jsdocTags": [], - "rawComment": "" - }, - "entryType": "function", - "description": "", - "jsdocTags": [], - "rawComment": "", - "memberType": "method", - "memberTags": [] - }, - { - "name": "ngOnChanges", - "signatures": [ - { - "name": "ngOnChanges", - "entryType": "function", - "description": "", - "generics": [], - "isNewType": false, - "jsdocTags": [], - "params": [ - { - "name": "changes", - "description": "", - "type": "SimpleChanges", - "isOptional": false, - "isRestParam": false - } - ], - "rawComment": "", - "returnType": "void" - } - ], - "implementation": { - "params": [ - { - "name": "changes", - "description": "", - "type": "SimpleChanges", - "isOptional": false, - "isRestParam": false - } - ], - "isNewType": false, - "returnType": "void", - "generics": [], - "name": "ngOnChanges", - "description": "", - "entryType": "function", - "jsdocTags": [], - "rawComment": "" - }, - "entryType": "function", - "description": "", - "jsdocTags": [], - "rawComment": "", - "memberType": "method", - "memberTags": [] - }, - { - "name": "ngOnDestroy", - "signatures": [ - { - "name": "ngOnDestroy", - "entryType": "function", - "description": "", - "generics": [], - "isNewType": false, - "jsdocTags": [], - "params": [], - "rawComment": "", - "returnType": "void" - } - ], - "implementation": { - "params": [], - "isNewType": false, - "returnType": "void", - "generics": [], - "name": "ngOnDestroy", - "description": "", - "entryType": "function", - "jsdocTags": [], - "rawComment": "" - }, - "entryType": "function", - "description": "", - "jsdocTags": [], - "rawComment": "", - "memberType": "method", - "memberTags": [] - } - ], - "generics": [ - { - "name": "T", - "default": "any" - } - ], - "description": "Element that can be moved inside a CdkDropList container.", - "jsdocTags": [], - "rawComment": "/** Element that can be moved inside a CdkDropList container. */", - "implements": [ - "AfterViewInit", - "OnChanges", - "OnDestroy" - ], - "source": { - "filePath": "/src/cdk/drag-drop/directives/drag.ts", - "startLine": 61, - "endLine": 619 - } - }, - { - "name": "DragConstrainPosition", - "type": "(\n userPointerPosition: Point,\n dragRef: DragRef,\n dimensions: DOMRect,\n pickupPositionInElement: Point,\n) => Point", - "entryType": "type_alias", - "generics": [], - "rawComment": "/** Function that can be used to constrain the position of a dragged element. */", - "description": "Function that can be used to constrain the position of a dragged element.", - "jsdocTags": [], - "members": [], - "source": { - "filePath": "/src/cdk/drag-drop/drag-ref.ts", - "startLine": 61, - "endLine": 66 - } - }, - { - "name": "CdkDragDrop", - "entryType": "interface", - "members": [ - { - "name": "previousIndex", - "type": "number", - "memberType": "property", - "memberTags": [], - "description": "Index of the item when it was picked up.", - "jsdocTags": [] - }, - { - "name": "currentIndex", - "type": "number", - "memberType": "property", - "memberTags": [], - "description": "Current index of the item.", - "jsdocTags": [] - }, - { - "name": "item", - "type": "CdkDrag", - "memberType": "property", - "memberTags": [], - "description": "Item that is being dropped.", - "jsdocTags": [] - }, - { - "name": "container", - "type": "CdkDropList", - "memberType": "property", - "memberTags": [], - "description": "Container in which the item was dropped.", - "jsdocTags": [] - }, - { - "name": "previousContainer", - "type": "CdkDropList", - "memberType": "property", - "memberTags": [], - "description": "Container from which the item was picked up. Can be the same as the `container`.", - "jsdocTags": [] - }, - { - "name": "isPointerOverContainer", - "type": "boolean", - "memberType": "property", - "memberTags": [], - "description": "Whether the user's pointer was over the container when the item was dropped.", - "jsdocTags": [] - }, - { - "name": "distance", - "type": "{ x: number; y: number; }", - "memberType": "property", - "memberTags": [], - "description": "Distance in pixels that the user has dragged since the drag sequence started.", - "jsdocTags": [] - }, - { - "name": "dropPoint", - "type": "{ x: number; y: number; }", - "memberType": "property", - "memberTags": [], - "description": "Position where the pointer was when the item was dropped", - "jsdocTags": [] - }, - { - "name": "event", - "type": "MouseEvent | TouchEvent", - "memberType": "property", - "memberTags": [], - "description": "Native event that caused the drop event.", - "jsdocTags": [] - } - ], - "generics": [ - { - "name": "T" - }, - { - "name": "O", - "default": "T" - }, - { - "name": "I", - "default": "any" - } - ], - "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", - "startLine": 62, - "endLine": 81 + "startLine": 73, + "endLine": 805 } }, { @@ -4766,8 +4926,8 @@ "implements": [], "source": { "filePath": "/src/cdk/drag-drop/drag-ref.ts", - "startLine": 102, - "endLine": 105 + "startLine": 105, + "endLine": 108 } }, { @@ -4781,8 +4941,8 @@ "members": [], "source": { "filePath": "/src/cdk/drag-drop/drag-ref.ts", - "startLine": 125, - "endLine": 125 + "startLine": 128, + "endLine": 128 } }, { @@ -4843,6 +5003,135 @@ "endLine": 112 } }, + { + "name": "createDragRef", + "signatures": [ + { + "name": "createDragRef", + "entryType": "function", + "description": "Creates a `DragRef` for an element, turning it into a draggable item.", + "generics": [ + { + "name": "T", + "default": "unknown" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "Injector used to resolve dependencies." + }, + { + "name": "param", + "comment": "Element to which to attach the dragging functionality." + }, + { + "name": "param", + "comment": "Object used to configure the dragging behavior." + } + ], + "params": [ + { + "name": "injector", + "description": "Injector used to resolve dependencies.", + "type": "Injector", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "Element to which to attach the dragging functionality.", + "type": "any", + "isOptional": false, + "isRestParam": false + }, + { + "name": "config", + "description": "Object used to configure the dragging behavior.", + "type": "DragRefConfig", + "isOptional": true, + "isRestParam": false + } + ], + "rawComment": "/**\n * Creates a `DragRef` for an element, turning it into a draggable item.\n * @param injector Injector used to resolve dependencies.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */", + "returnType": "DragRef" + } + ], + "implementation": { + "params": [ + { + "name": "injector", + "description": "Injector used to resolve dependencies.", + "type": "Injector", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "Element to which to attach the dragging functionality.", + "type": "any", + "isOptional": false, + "isRestParam": false + }, + { + "name": "config", + "description": "Object used to configure the dragging behavior.", + "type": "DragRefConfig", + "isOptional": true, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "DragRef", + "generics": [ + { + "name": "T", + "default": "unknown" + } + ], + "name": "createDragRef", + "description": "Creates a `DragRef` for an element, turning it into a draggable item.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "Injector used to resolve dependencies." + }, + { + "name": "param", + "comment": "Element to which to attach the dragging functionality." + }, + { + "name": "param", + "comment": "Object used to configure the dragging behavior." + } + ], + "rawComment": "/**\n * Creates a `DragRef` for an element, turning it into a draggable item.\n * @param injector Injector used to resolve dependencies.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */" + }, + "entryType": "function", + "description": "Creates a `DragRef` for an element, turning it into a draggable item.", + "jsdocTags": [ + { + "name": "param", + "comment": "Injector used to resolve dependencies." + }, + { + "name": "param", + "comment": "Element to which to attach the dragging functionality." + }, + { + "name": "param", + "comment": "Object used to configure the dragging behavior." + } + ], + "rawComment": "/**\n * Creates a `DragRef` for an element, turning it into a draggable item.\n * @param injector Injector used to resolve dependencies.\n * @param element Element to which to attach the dragging functionality.\n * @param config Object used to configure the dragging behavior.\n */", + "source": { + "filePath": "/src/cdk/drag-drop/drag-ref.ts", + "startLine": 136, + "endLine": 157 + } + }, { "name": "DragRef", "isAbstract": false, @@ -5971,8 +6260,8 @@ "implements": [], "source": { "filePath": "/src/cdk/drag-drop/drag-ref.ts", - "startLine": 130, - "endLine": 1631 + "startLine": 162, + "endLine": 1663 } } ], @@ -5981,6 +6270,22 @@ "InjectionToken", "@angular/core" ], + [ + "Injectable", + "@angular/core" + ], + [ + "ElementRef", + "@angular/core" + ], + [ + "inject", + "@angular/core" + ], + [ + "Injector", + "@angular/core" + ], [ "Directive", "@angular/core" @@ -6001,30 +6306,6 @@ "TemplateRef", "@angular/core" ], - [ - "inject", - "@angular/core" - ], - [ - "Injectable", - "@angular/core" - ], - [ - "NgZone", - "@angular/core" - ], - [ - "ElementRef", - "@angular/core" - ], - [ - "RendererFactory2", - "@angular/core" - ], - [ - "DOCUMENT", - "@angular/core" - ], [ "NgModule", "@angular/core" @@ -6045,22 +6326,6 @@ "ChangeDetectorRef", "@angular/core" ], - [ - "EmbeddedViewRef", - "@angular/core" - ], - [ - "Renderer2", - "@angular/core" - ], - [ - "ViewContainerRef", - "@angular/core" - ], - [ - "signal", - "@angular/core" - ], [ "ChangeDetectionStrategy", "@angular/core" @@ -6073,6 +6338,14 @@ "ListenerOptions", "@angular/core" ], + [ + "NgZone", + "@angular/core" + ], + [ + "RendererFactory2", + "@angular/core" + ], [ "ViewEncapsulation", "@angular/core" @@ -6081,6 +6354,26 @@ "WritableSignal", "@angular/core" ], + [ + "signal", + "@angular/core" + ], + [ + "DOCUMENT", + "@angular/core" + ], + [ + "EmbeddedViewRef", + "@angular/core" + ], + [ + "Renderer2", + "@angular/core" + ], + [ + "ViewContainerRef", + "@angular/core" + ], [ "OnChanges", "@angular/core" @@ -6093,10 +6386,6 @@ "afterNextRender", "@angular/core" ], - [ - "Injector", - "@angular/core" - ], [ "numberAttribute", "@angular/core" @@ -6113,6 +6402,10 @@ "DragStartDelay", "@angular/cdk/drag-drop" ], + [ + "DragDrop", + "@angular/cdk/drag-drop" + ], [ "DragAxis", "@angular/cdk/drag-drop" @@ -6145,10 +6438,6 @@ "CdkDropListGroup", "@angular/cdk/drag-drop" ], - [ - "DragDrop", - "@angular/cdk/drag-drop" - ], [ "CdkDragPlaceholder", "@angular/cdk/drag-drop" @@ -6190,11 +6479,11 @@ "@angular/cdk/drag-drop" ], [ - "DragRefConfig", + "DragDropRegistry", "@angular/cdk/drag-drop" ], [ - "DragDropRegistry", + "DragRefConfig", "@angular/cdk/drag-drop" ], [ @@ -6210,11 +6499,11 @@ "@angular/cdk/drag-drop" ], [ - "DropListRef", + "CDK_DROP_LIST", "@angular/cdk/drag-drop" ], [ - "CDK_DROP_LIST", + "createDropListRef", "@angular/cdk/drag-drop" ], [ @@ -6229,6 +6518,10 @@ "CdkDragDrop", "@angular/cdk/drag-drop" ], + [ + "DropListRef", + "@angular/cdk/drag-drop" + ], [ "CdkDragMove", "@angular/cdk/drag-drop" @@ -6245,6 +6538,10 @@ "CdkDragSortEvent", "@angular/cdk/drag-drop" ], + [ + "createDragRef", + "@angular/cdk/drag-drop" + ], [ "DragRef", "@angular/cdk/drag-drop" @@ -6269,6 +6566,18 @@ "DragStartDelay", "@angular/cdk/drag-drop" ], + [ + "DragDrop", + "@angular/cdk/drag-drop" + ], + [ + "DragDrop.createDrag", + "@angular/cdk/drag-drop" + ], + [ + "DragDrop.createDropList", + "@angular/cdk/drag-drop" + ], [ "DragAxis", "@angular/cdk/drag-drop" @@ -6317,18 +6626,6 @@ "CdkDropListGroup.ngOnDestroy", "@angular/cdk/drag-drop" ], - [ - "DragDrop", - "@angular/cdk/drag-drop" - ], - [ - "DragDrop.createDrag", - "@angular/cdk/drag-drop" - ], - [ - "DragDrop.createDropList", - "@angular/cdk/drag-drop" - ], [ "CdkDragPlaceholder", "@angular/cdk/drag-drop" @@ -6585,26 +6882,6 @@ "CdkDropList.ngOnDestroy", "@angular/cdk/drag-drop" ], - [ - "DragRefConfig", - "@angular/cdk/drag-drop" - ], - [ - "DragRefConfig.dragStartThreshold", - "@angular/cdk/drag-drop" - ], - [ - "DragRefConfig.pointerDirectionChangeThreshold", - "@angular/cdk/drag-drop" - ], - [ - "DragRefConfig.zIndex", - "@angular/cdk/drag-drop" - ], - [ - "DragRefConfig.parentDragRef", - "@angular/cdk/drag-drop" - ], [ "DragDropRegistry", "@angular/cdk/drag-drop" @@ -6665,6 +6942,26 @@ "DragDropRegistry.ngOnDestroy", "@angular/cdk/drag-drop" ], + [ + "DragRefConfig", + "@angular/cdk/drag-drop" + ], + [ + "DragRefConfig.dragStartThreshold", + "@angular/cdk/drag-drop" + ], + [ + "DragRefConfig.pointerDirectionChangeThreshold", + "@angular/cdk/drag-drop" + ], + [ + "DragRefConfig.zIndex", + "@angular/cdk/drag-drop" + ], + [ + "DragRefConfig.parentDragRef", + "@angular/cdk/drag-drop" + ], [ "CdkDragEnter", "@angular/cdk/drag-drop" @@ -6697,150 +6994,14 @@ "CdkDragExit.item", "@angular/cdk/drag-drop" ], - [ - "DropListRef", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.constructor", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.element", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.disabled", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.sortingDisabled", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.lockAxis", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.autoScrollDisabled", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.autoScrollStep", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.hasAnchor", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.enterPredicate", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.sortPredicate", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.beforeStarted", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.entered", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.exited", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.dropped", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.sorted", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.receivingStarted", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.receivingStopped", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.data", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.dispose", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.isDragging", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.start", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.enter", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.exit", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.drop", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.withItems", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.withDirection", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.connectedTo", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.withOrientation", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.withScrollableParents", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.withElementContainer", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.getScrollableParents", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.getItemIndex", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.getItemAtIndex", - "@angular/cdk/drag-drop" - ], - [ - "DropListRef.isReceiving", - "@angular/cdk/drag-drop" - ], [ "CDK_DROP_LIST", "@angular/cdk/drag-drop" ], + [ + "createDropListRef", + "@angular/cdk/drag-drop" + ], [ "CdkDrag", "@angular/cdk/drag-drop" @@ -7009,6 +7170,146 @@ "CdkDragDrop.event", "@angular/cdk/drag-drop" ], + [ + "DropListRef", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.constructor", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.element", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.disabled", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.sortingDisabled", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.lockAxis", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.autoScrollDisabled", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.autoScrollStep", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.hasAnchor", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.enterPredicate", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.sortPredicate", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.beforeStarted", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.entered", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.exited", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.dropped", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.sorted", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.receivingStarted", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.receivingStopped", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.data", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.dispose", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.isDragging", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.start", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.enter", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.exit", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.drop", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.withItems", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.withDirection", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.connectedTo", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.withOrientation", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.withScrollableParents", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.withElementContainer", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.getScrollableParents", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.getItemIndex", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.getItemAtIndex", + "@angular/cdk/drag-drop" + ], + [ + "DropListRef.isReceiving", + "@angular/cdk/drag-drop" + ], [ "CdkDragMove", "@angular/cdk/drag-drop" @@ -7069,6 +7370,10 @@ "CdkDragSortEvent.item", "@angular/cdk/drag-drop" ], + [ + "createDragRef", + "@angular/cdk/drag-drop" + ], [ "DragRef", "@angular/cdk/drag-drop"