KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

De DOM bewerken met Range

Knip, voeg in en verwijder DOM-inhoud. Leer hoe je de grenzen van een bereik instelt, hoe je het tot één punt terugbrengt en wat `cloneRange()` kopieert.

Versie: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

range.extractContents() → DocumentFragment
range.insertNode(newNode) → undefined
range.deleteContents() → undefined
range.setStartAfter(referenceNode) → undefined
range.collapse() → undefined
range.collapse(toStart) → undefined
range.cloneRange() → Range

Een Range is een dynamisch DOM-bereik met een begin- en een eindgrens. Elke grens bestaat uit een containerknooppunt en een offset. In een tekstknooppunt telt de offset UTF-16-code-eenheden; in een element telt die de voorafgaande kindknooppunten, niet alleen de kindelementen. Range hoort bij de DOM, niet bij ECMAScript 2024; de uitvoeromgeving moet een DOM aanbieden.

extractContents() verwijdert de inhoud van het bereik en geeft een DocumentFragment terug. Knooppunten die er volledig in liggen worden verplaatst, geselecteerde tekstdelen worden gekopieerd en elementen die er gedeeltelijk in liggen worden zo nodig gekloond om de structuur te behouden. deleteContents() verwijdert de inhoud zonder een fragment terug te geven (undefined). Beide methoden brengen het bereik terug tot één punt. Is het al tot één punt teruggebracht, dan geeft extractie een leeg fragment terug en doet verwijderen niets.

insertNode(newNode) voegt in bij de begingrens zonder de inhoud van het bereik te vervangen. Ligt de grens in een tekstknooppunt, dan wordt dat daar gesplitst. Bij een DocumentFragment worden de kinderen verplaatst en blijft het fragment leeg achter. Invoegen kan een tot één punt teruggebracht bereik uitbreiden. Een ongeldige boomstructuur kan HierarchyRequestError veroorzaken. Invoegen maakt inhoud niet veilig: zet niet-vertrouwde platte tekst in een tekstknooppunt in plaats van die als HTML te parsen.

setStartAfter(referenceNode) zet het begin direct na het referentieknooppunt, in het bovenliggende knooppunt. Heeft het referentieknooppunt geen ouder, dan volgt InvalidNodeTypeError. Ligt het nieuwe begin na het einde of in een andere boom, dan verhuist ook het einde naar dat punt. collapse(true) brengt het bereik terug tot het begin; collapse(false) en collapse() tot het einde. Deze twee methoden en insertNode() geven undefined terug.

cloneRange() geeft een afzonderlijke Range met aanvankelijk dezelfde grenzen terug, zonder knooppunten te kopiëren. Een grens van het ene bereik instellen verplaatst het andere bereik niet rechtstreeks, maar beide blijven dynamisch: DOM-mutaties kunnen de grenzen van beide aanpassen. De kloon is geen momentopname van de inhoud.

Voorbeelden

<!doctype html>
<meta charset="utf-8">
<title>Editing the DOM with Range</title>
<script>
(() => {
  const source = document.createElement('p');
  const target = document.createElement('p');
  const item = document.createElement('em');
  item.textContent = 'B';
  source.append('A', item, 'C');
  target.textContent = 'XY';

  const cut = document.createRange();
  cut.selectNode(item);
  const copy = cut.cloneRange();
  copy.collapse(true);
  console.log(`before: ${cut.toString()} / ${copy.collapsed}`);

  const fragment = cut.extractContents();
  const edit = document.createRange();
  edit.setStart(target.firstChild, 1);
  edit.collapse(true);
  edit.insertNode(fragment);
  console.log(`moved: ${source.textContent} / ${target.textContent} / ${fragment.childNodes.length}`);

  edit.setStartAfter(item);
  edit.collapse(true);
  edit.setEnd(target, target.childNodes.length);
  edit.deleteContents();
  console.log(`final: ${target.textContent} / ${edit.collapsed}`);
})();
</script>

Resultaat

before: B / true
moved: AC / XBY / 0
final: XB / true

Sla het voorbeeld op als HTML-bestand, open het in een browser en bekijk de uitvoer in de ontwikkelaarsconsole. Als je de kopie tot één punt terugbrengt, blijft `B` in het oorspronkelijke bereik. Het uitgeknipte knooppunt komt tussen `X` en `Y`, het fragment raakt leeg en vervolgens wordt `Y` verwijderd.

Gerelateerde lessen

  • JavaScript · Les 33 · Gemiddeld · Versie: 3

Bronnen