matthewp / template-shadowroot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Declarative Shadow DOM Ponyfill

Declarative Shadow DOM for SSR

A ponyfill of the API described by Mason Freed at https://github.com/mfreed7/declarative-shadow-dom.

Overview

This package provides a function, hydrateShadowRoots, that converts <template> elements with a shadowroot attribute into ShadowRoots on the template's parent element.

This allows HTML with shadow roots to be serialized to plain HTML, and the serialized shadow roots "rehydrated" (separate from component hydration) on the client.

<template shadowroot> elements are transformed bottom up so that in the case where they're nested, all elements within the declarative shadow tree stay inert until they have all been moved from their <template shadowroot> elements.

If native support for <template shadowroot> is present, hydrateShadowRoots does nothing when called.

Known limitations

  • Does not currently look into imperatively created shadow roots.
  • The mutation observer implementation
    • May not work properly in the face of streaming HTML parsing. Needs investigation.
    • Will not notice imperatively created <template shadowroot> elements inside of other shadow roots.
  • Not enough benchmarks, and benchmarks of insufficient quality to be confident of good performance.

About

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:TypeScript 78.1%Language:HTML 11.7%Language:JavaScript 10.3%