chromium/third_party/blink/renderer/core/dom/part_root.idl

// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// https://crbug.com/1453291
// https://github.com/WICG/webcomponents/blob/gh-pages/proposals/DOM-Parts.md


[RuntimeEnabled=DOMPartsAPI,Exposed=Window]
interface mixin PartRootMixin {
  // Retrieve the parts list for this PartRoot, always in tree order breaking
  // ties for a Node using the order Parts were constructed.
  sequence<Part> getParts();
  // Retrieve the Nodes corresponding to the NodeParts returned by getParts(),
  // without building the Part objects.
  [RuntimeEnabled=DOMPartsAPIMinimal] sequence<Node> getNodePartNodes();
  // Retrieve the pairs of previous/next Nodes corresponding to the
  // ChildNodeParts returned by getParts(), without building the Part objects.
  // Nodes are paired, so for 3 ChildNodeParts, 6 Nodes will be returned.
  [RuntimeEnabled=DOMPartsAPIMinimal] sequence<Node> getChildNodePartNodes();
  // This clones the PartRoot, and also clones the Node tree itself, starting
  // at the RootContainer. In the case of a DocumentPartRoot, the entire
  // document tree is cloned. In the case of a ChildPartRoot, only the children
  // between `previous_node` and `next_node` are included, inclusive. The
  // `clone()` method returns the cloned PartRoot.
  [RaisesException] PartRoot clone();
  // Return the root container for the PartRoot, which is the Document or
  // DocumentFragment for a DocumentPartRoot, or the parent ContainerNode of
  // a ChildNodePart.
  readonly attribute Node rootContainer;
};

DocumentPartRoot includes PartRootMixin;
ChildNodePart includes PartRootMixin;

typedef (DocumentPartRoot or ChildNodePart) PartRoot;