Selection: getComposedRanges() Methode

options Optional

Ein Objekt mit den folgenden optionalen Eigenschaften:

shadowRoots Optional

Ein Array von ShadowRoot-Objekten. Wenn ein Auswahlendpunkt innerhalb einer der bereitgestellten Schattenwurzeln liegt, kann der Bereich Knoten innerhalb des entsprechenden Schatten-DOM-Baums zurückgeben. Andernfalls, wenn die Auswahl eine Schattengrenze überschreitet und die entsprechende ShadowRoot nicht bereitgestellt wird, wird der zurückgegebene Bereich angepasst, um das gesamte Host-Element für die Schattenwurzel einzuschließen.

Ein Array von StaticRange-Objekten, die die ausgewählten Bereiche innerhalb des komponierten (abgeflachten) Baums des Dokuments darstellen. Zum Zeitpunkt des Schreibens der Spezifikation wird erwartet, dass dieses Array nur ein Objekt enthält.

Dieses Beispiel zeigt, wie sich getComposedRanges() verhält, sowohl wenn Schattenwurzeln übergeben werden als auch wenn nicht, und vergleicht dies mit Selection.getRangeAt().

Es ermöglicht Ihnen, Text auszuwählen, der in verschiedenen Knoten im DOM und in offenen und geschlossenen Schattenwurzeln definiert ist, den Bereich für die Auswahl mit den verschiedenen Ansätzen zu kopieren und dann den Bereich erneut anzuwenden, um zu sehen, wie gut die ursprüngliche Auswahl funktioniert hat.

HTML

Das HTML definiert einige Textknoten mit <span>-Elementen, an die wir eine Schattenwurzel mit JavaScript anhängen werden. Wir fügen auch einige Buttons hinzu, um die Auswahl mit verschiedenen Methoden zu kopieren und anzuwenden.

<p>
  DOM Text One<span id="openHost"></span>DOM Text Two<span
    id="closedHost"></span
  >DOM Text Three
</p>

<button id="copySelection">Copy range not passing shadow roots</button>
<button id="copySelectionWithShadowRoots">
  Copy range passing shadow roots
</button>
<button id="applySelection">Apply selection</button>
<hr />
<button id="copySelectionRangeAt">Copy range with getRangeAt()</button>
<button id="applySelectionGetRangeAt">Apply selection</button>

CSS

Das CSS macht nichts Interessantes. Wir legen die Buttons einfach vertikal an, damit sie leichter zu lesen sind.

button {
  display: block;
}

#log {
  height: 20px;
  padding: 0.5rem;
  border: 1px solid black;
}

JavaScript

const logElement = document.querySelector("#log");
function log(text) {
  logElement.innerText = text;
}

Der Großteil der Arbeit wird im JavaScript erledigt. Zuerst protokollieren wir, ob getComposedRanges() nicht unterstützt wird, obwohl wir das restliche Beispiel nicht daran hindern, es zu verwenden.

if (!("getComposedRanges" in Selection.prototype)) {
  log("getComposedRanges() method not supported in this browser");
}

Dann erstellen wir eine offene und eine geschlossene Schattenwurzel und hängen sie an die zwei <span>-Elemente an, die wir im HTML erstellt haben. Diese enthalten einfachen fettgedruckten Text, sodass wir die Schattenknoten leicht identifizieren können, wenn das HTML gerendert wird.

let openRoot = openHost.attachShadow({ mode: "open" });
openRoot.innerHTML = `<b>Open Shadow DOM Text</b>`;

let closedRoot = closedHost.attachShadow({ mode: "closed" });
closedRoot.innerHTML = `<b>Closed Shadow DOM Text</b>`;

Als nächstes erstellen wir Code, um die ausgewählten Bereiche mit getComposedRanges() abzurufen, wenn die ersten beiden Buttons geklickt werden. Der erste Button ruft getComposedRanges() auf, ohne Schattenwurzeln zu übergeben, während der zweite beide Schattenwurzeln übergibt. In beiden Fällen wird der komponierte Bereich in einer Variablen gespeichert.

const copySelectionButton = document.querySelector("#copySelection");
let composedRangeSelection = null;
copySelectionButton.addEventListener("click", () => {
  composedRangeSelection = window.getSelection().getComposedRanges()[0];
  log(`Selection copied (no shadow roots passed)`);
});

const copySelectionWithShadowRootsButton = document.querySelector(
  "#copySelectionWithShadowRoots",
);
copySelectionWithShadowRootsButton.addEventListener("click", () => {
  composedRangeSelection = window
    .getSelection()
    .getComposedRanges({ shadowRoots: [openRoot, closedRoot] })[0];
  log(`Selection has been copied (shadow roots passed)`);
});

Der Handler für den "Auswahl anwenden"-Button ist unten gezeigt. Dieser ruft setBaseAndExtent() auf, um die aktuelle Auswahl festzulegen, indem die Knoten und Offsets aus dem gespeicherten Bereich übergeben werden.

const applySelectionButton = document.querySelector("#applySelection");
applySelectionButton.addEventListener("click", () => {
  if (composedRangeSelection) {
    window
      .getSelection()
      .setBaseAndExtent(
        composedRangeSelection.startContainer,
        composedRangeSelection.startOffset,
        composedRangeSelection.endContainer,
        composedRangeSelection.endOffset,
      );
    log(`Selection applied`);
  } else {
    log(`No selection to apply`);
  }
});

Der letzte Teil des Codes definiert Buttons, um den aktuellen Auswahlbereich mit Selection.getRangeAt() zu kopieren und dann die Auswahl erneut anzuwenden.

const copySelectionRangeAtButton = document.querySelector(
  "#copySelectionRangeAt",
);
let rangeSelection = null;
copySelectionRangeAtButton.addEventListener("click", () => {
  const selection = window.getSelection();
  if (selection.rangeCount > 0) {
    log(`Selection copied using getRangeAt()`);
    rangeSelection = selection.getRangeAt(0);
  } else {
    log(`No range selected`);
  }
});

const applySelectionGetRangeAtButton = document.querySelector(
  "#applySelectionGetRangeAt",
);
applySelectionGetRangeAtButton.addEventListener("click", () => {
  if (rangeSelection) {
    window
      .getSelection()
      .setBaseAndExtent(
        rangeSelection.startContainer,
        rangeSelection.startOffset,
        rangeSelection.endContainer,
        rangeSelection.endOffset,
      );
    log(`Selection applied`);
  } else {
    log(`No selection to apply`);
  }
});

<pre id="log"></pre>

Ergebnisse

Das laufende Beispiel wird unten gezeigt. Wählen Sie Text in der oberen Zeile aus, beginnend mit normalem Text und endend in einem fettgedruckten Abschnitt, sodass Sie Knoten vom DOM in eine Schattenwurzel ausgewählt haben. Wenn Sie "Bereich kopieren, Schattenwurzeln übergeben" und dann den "Auswahl anwenden"-Button auswählen, werden Sie feststellen, dass sich die Auswahl nicht ändert, da der Code Zugriff auf alle Knoten in der Schattenwurzel gegeben hat, selbst wenn sie geschlossen ist. Wenn Sie dann den Button "Bereich kopieren, Schattenwurzeln nicht übergeben" auswählen und dann anwenden, wird die Auswahl bis zum Ende des Texts in der Schattenwurzel erweitert. Dies liegt daran, dass die Auswahl neu abgegrenzt wird, um das Ende des Host-Knotens einzuschließen, da die getComposedRanges()-Methode keine Sichtbarkeit innerhalb des Schattenbaums hatte.

Testen Sie auch, was passiert, wenn Sie die "Bereich kopieren mit getRangeAt()" und "Auswahl anwenden"-Buttons verwenden. Sie sollten feststellen, dass der ausgewählte Bereich ziemlich willkürlich ist, wenn Sie in die Schattenwurzel übergehen, und es hängt davon ab, welchen Browser Sie verwenden.

• Selection, das Interface, zu dem es gehört.