readthedocs / readthedocs/ext-theme

Support shadow DOM with host stylesheets

Open
#684 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Improvement
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

Currently, all web components in the application are using light DOM instead of the shadow DOM. This means when the element is created, it uses itself as a base for all child elements, where web components through Lit and most other frameworks create a shadow DOM element and surface the child elements through the shadow DOM. This is what enables child slotting, which we currently cannot use with a light DOM approach.

There are a few ways around this, though in my quick attempts at it I have not noticed elements in the shadow DOM working as expected. These methods mostly involve copying the host document stylesheets into the LitElement.sheets property. I'm guessing this doesn't quite work due to timing and how the stylesheets are evaluated.

So, the goal will be a LitElement subclass that copies the host document stylesheets into sheets, so the elements in the custom element shadow DOM use the SUI stylesheets.

Some resources I was using:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how the project currently creates web components and how LitElement.sheets handles host document stylesheets, then consult the linked Lit and ShadyCSS resources. Done means a LitElement subclass copies the host stylesheets into the shadow DOM so SUI styles and child slotting work as expected.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, javascript
Domain
frontend, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.