feat(adopted-stylesheets): Tweaked docs.

phase2 · Feb 6, 2024 · 12be159 · 12be159
1 parent ce0cacf
commit 12be159
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 60 deletions.
diff --git a/packages/controllers/adopted-stylesheets/README.md b/packages/controllers/adopted-stylesheets/README.md
@@ -38,64 +38,56 @@ The `AdoptedStylesheets` controller provides the following methods:
 
 ## Usage
 
-Here are examples of how to use the `AdoptedStylesheets` controller in a component:
+Here is an example of how to use the `AdoptedStylesheets` controller in a component. Samples will show incorporating two stylesheets, one to the `document` (global) and one to the `shadowRoot` (encapsulated). 
 
-### Sample 1: Attach a stylesheet to `document`
+### Importing the package
 
 ```typescript
 import { AdoptedStylesheets } from '@phase2/outline-adopted-stylesheets-controller';
-import { css, CSSResult, LitElement } from 'lit';
-import globalStyles from './global-styles';
-
-class MyComponent extends LitElement {
-  AdoptedStylesheets: AdoptedStylesheets;
-
-  connectedCallback() {
-    super.connectedCallback();
-    this.AdoptedStylesheets = new AdoptedStylesheets(globalStyles, document);
-    this.addController(this.AdoptedStylesheets);
-  }
-}
 ```
 
-### Sample 2: Attach a stylesheet to `this.shadowRoot`
+### Importing your stylesheet(s)
 
 ```typescript
-import { AdoptedStylesheets } from '@phase2/outline-adopted-stylesheets-controller';
-import { css, CSSResult, LitElement } from 'lit';
-import encapsulatedStyles from './encapsulated-styles';
+import globalStyles from './styles/global-styles.css?inline';
+import encapsulatedStyles from './styles/encapsulated-styles.css?inline';
+```
+
+In the snippet above, you'll notice that we're importing stylesheets directly into our component using the `?inline` flag. This is a feature provided by modern bundlers like Vite and Webpack. The `?inline` flag tells the bundler to import the contents of the CSS file as a string, which can then be used directly in our JavaScript or TypeScript code.
 
-class MyComponent extends LitElement {
-  AdoptedStylesheets: AdoptedStylesheets;
+### Attaching a global stylesheet
 
-  connectedCallback() {
-    super.connectedCallback();
-    this.AdoptedStylesheets = new AdoptedStylesheets(encapsulatedStyles, this.shadowRoot);
-    this.addController(this.AdoptedStylesheets);
-  }
+```typescript
+export class MyComponent extends LitElement {
+
+  GlobalStylesheets: AdoptedStylesheets | undefined = new AdoptedStylesheets(
+    this,
+    globalStyles,
+    document,
+  );
+
+  EncapsulatedStylesheets: AdoptedStylesheets | undefined;
 }
 ```
 
-### Sample 3: Attach stylesheets to both `document` and `this.shadowRoot`
+Above, the definition of `GlobalStylesheets` is calling the controller, and attaching immediately upon execution. Read on to understand why `EncapsulatedStylesheets` must be assigned differently.
+
+### Attaching an encapsulated stylesheet via `createRenderRoot`
+
+Because of the methods by which Adopted Stylesheets work, we must ensure that we have a `shadowRoot` prior to attaching styles to it. While this may seem overly verbose compared to using `static styles`, however, `static styles` is a Lit-ism, and then has us using the "Lit way" to attach our encapsulated styles, and "this way" to attach global ones. This consolidation is purposeful to ensure we are utilizing the same, modern, browser standards based methods when possible.
 
 ```typescript
-import { AdoptedStylesheets } from '@phase2/outline-adopted-stylesheets-controller';
-import { css, CSSResult, LitElement } from 'lit';
-import globalStyles from './global-styles';
-import encapsulatedStyles from './encapsulated-styles';
-
-class MyComponent extends LitElement {
-  GlobalStylesheets: AdoptedStylesheets;
-  EncapsulatedStylesheets: AdoptedStylesheets;
-
-  connectedCallback() {
-    super.connectedCallback();
-    this.GlobalStylesheets = new AdoptedStylesheets(globalStyles, document);
-    this.addController(this.GlobalStylesheets);
-    this.EncapsulatedStylesheets = new AdoptedStylesheets(encapsulatedStyles, this.shadowRoot);
-    this.addController(this.EncapsulatedStylesheets);
-  }
+createRenderRoot() {
+  const root = super.createRenderRoot();
+  this.EncapsulatedStylesheets = this.shadowRoot
+    ? new AdoptedStylesheets(this, encapsulatedStyles, this.shadowRoot)
+    : undefined;
+  return root;
 }
 ```
 
-In the provided examples, the `connectedCallback` method is utilized. This method is invoked whenever the element is inserted into the DOM. Within this method, an instance of `AdoptedStylesheets` is created and added as a controller. This is a more efficient approach than creating the instance and adding the controller within the `constructor`. The reason for this is that it delays these operations until the element is actually inserted into the DOM. If there are many such elements that are created but not immediately added to the DOM, this approach can significantly improve the startup performance of your application. Therefore, the `connectedCallback` method is a crucial part of managing the lifecycle of a web component, especially when dealing with adopted stylesheets.
+The `createRenderRoot` method is used here for a very specific reason. In Lit, the `createRenderRoot` method is used to specify the container to which the template is rendered. By default, Lit renders the template into the component's Shadow DOM. This is done by returning `this.shadowRoot` in the `createRenderRoot` method, which is the default behavior.
+
+In this specific case, we are using `createRenderRoot` to adopt stylesheets into the shadow root of the component. This is done by creating a new instance of the `AdoptedStyleSheets` class and assigning it to `this.EncapsulatedStylesheets`. The `AdoptedStyleSheets` class is a controller that manages CSS stylesheets that are adopted into the document or a shadow root. By adopting the stylesheets into the shadow root, we ensure that the styles are scoped to this component and do not leak out to the rest of the page.
+
+This could not be achieved with other lifecycle methods in Lit. The `createRenderRoot` method is the only method that gives us direct access to the shadow root before the template is rendered, which is necessary for adopting the stylesheets. Other lifecycle methods like `connectedCallback`, `disconnectedCallback`, `updated`, `firstUpdated`, etc., are called at different stages of the component's lifecycle and do not give us the opportunity to adopt the stylesheets into the shadow root before the template is rendered.
diff --git a/packages/controllers/adopted-stylesheets/src/adopted-stylesheets.ts b/packages/controllers/adopted-stylesheets/src/adopted-stylesheets.ts
@@ -1,45 +1,75 @@
-import { ReactiveController, CSSResult } from 'lit';
+import { ReactiveController, ReactiveControllerHost } from 'lit';
 
 /**
- * `AdoptedStyleSheets` is a class that implements the `ReactiveController` interface from the `lit` library.
+ * `AdoptedStylesheets` is a class that implements the `ReactiveController` interface from the `lit` library.
  * This class is used to manage CSS stylesheets that are adopted into the document or a shadow root.
  *
- * @property {Map<string, CSSStyleSheet>} styleSheetMap - A static map that stores CSS stylesheets. The key is the CSS text and the value is the corresponding CSSStyleSheet object.
  * @property {CSSStyleSheet} adoptedSheet - The CSSStyleSheet object that is adopted into the document or a shadow root.
  * @property {Document | ShadowRoot} root - The root where the stylesheet will be adopted.
  */
-export class AdoptedStyleSheets implements ReactiveController {
+export class AdoptedStylesheets implements ReactiveController {
+  /**
+   * A static map that stores CSSStyleSheet objects by their CSS text.
+   * This allows for reuse of CSSStyleSheet objects across multiple instances of the class.
+   * @type {Map<string, CSSStyleSheet>}
+   */
   private static styleSheetMap = new Map<string, CSSStyleSheet>();
+
+  /**
+   * The CSSStyleSheet object that is adopted into the document or a shadow root.
+   * @type {CSSStyleSheet}
+   */
   private adoptedSheet: CSSStyleSheet;
+
+  /**
+   * The root where the stylesheet will be adopted.
+   * This can be either the document or a shadow root.
+   * @type {Document | ShadowRoot}
+   */
   private root: Document | ShadowRoot;
 
+  /**
+   * The host that this controller is associated with.
+   * @type {ReactiveControllerHost}
+   */
+  private host: ReactiveControllerHost;
+
   /**
    * The constructor for the `AdoptedStyleSheets` class.
    *
-   * @param {CSSResult} globalStyles - A `CSSResult` object that contains the CSS styles to be adopted.
+   * @param {ReactiveControllerHost} host - The host that this controller is associated with.
+   * @param {string} cssText - A string that contains the CSS styles to be adopted.
    * @param {Document | ShadowRoot} root - The root where the stylesheet will be adopted.
    */
-  constructor(globalStyles: CSSResult, root: Document | ShadowRoot) {
-    if (!root) {
-      throw new Error('Root must not be null or undefined');
-    }
-    const cssText = globalStyles.cssText;
-    if (!AdoptedStyleSheets.styleSheetMap.has(cssText)) {
+  constructor(
+    host: ReactiveControllerHost,
+    cssText: string,
+    root: Document | ShadowRoot
+  ) {
+    this.host = host;
+    this.host.addController(this);
+    this.root = root;
+
+    if (!AdoptedStylesheets.styleSheetMap.has(cssText)) {
       const newSheet = new CSSStyleSheet();
-      newSheet.replaceSync(cssText);
-      AdoptedStyleSheets.styleSheetMap.set(cssText, newSheet);
+      newSheet.replace(cssText).catch(error => {
+        console.error('Failed to replace CSS text:', error);
+      });
+      AdoptedStylesheets.styleSheetMap.set(cssText, newSheet);
     }
     this.adoptedSheet =
-      AdoptedStyleSheets.styleSheetMap.get(cssText) || new CSSStyleSheet();
-    this.root = root;
+      AdoptedStylesheets.styleSheetMap.get(cssText) || new CSSStyleSheet();
   }
 
   /**
    * The `hostConnected` method is called when the host element is connected to the DOM.
    * This method adopts the CSSStyleSheet object into the root's adopted stylesheets if it's not already included.
    */
   hostConnected() {
-    if (!this.root.adoptedStyleSheets.includes(this.adoptedSheet)) {
+    if (
+      this.root &&
+      !this.root.adoptedStyleSheets.includes(this.adoptedSheet)
+    ) {
       this.root.adoptedStyleSheets = [
         ...this.root.adoptedStyleSheets,
         this.adoptedSheet,
@@ -52,7 +82,7 @@ export class AdoptedStyleSheets implements ReactiveController {
    * This method removes the CSSStyleSheet object from the root's adopted stylesheets if it's included.
    */
   hostDisconnected() {
-    if (this.root.adoptedStyleSheets.includes(this.adoptedSheet)) {
+    if (this.root && this.root.adoptedStyleSheets.includes(this.adoptedSheet)) {
       this.root.adoptedStyleSheets = this.root.adoptedStyleSheets.filter(
         sheet => sheet !== this.adoptedSheet
       );