docs(src): update jsdocs code

waldronmatt · Apr 8, 2024 · 5f4a816 · 5f4a816
1 parent 2da0c9a
commit 5f4a816
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 18 deletions.
diff --git a/packages/lit-override/src/components/lit-override-component.ts b/packages/lit-override/src/components/lit-override-component.ts
@@ -9,10 +9,10 @@ import { property } from 'lit/decorators.js';
  *
  * A shell component for overriding styles and markup.
  *
- * @fires connected-callback - when `emitConnectedCallback` is `true`
+ * @fires connected-callback when `emitConnectedCallback` is `true`
  * @property {boolean} emitConnectedCallback - Set prop to use `connected-callback` event. Defaults to `false`.
- * @param {string} id unique identifier that points to the id of a `template` element. Defaults to empty string.
- * @slot `<slot></slot>` fallback rendering behavior if `<template>` element is not found
+ * @property {string} id - unique identifier that points to the id of a `template` element. Defaults to empty string.
+ * @slot `<slot></slot>` is rendered as fallback if `<template>` element is not found
  */
 export class LitOverride extends EmitConnectedCallback(LitElement) {
   @property({ reflect: true, type: String })

diff --git a/packages/lit-override/src/controllers/adopted-stylesheets-converter.ts b/packages/lit-override/src/controllers/adopted-stylesheets-converter.ts
@@ -8,11 +8,11 @@ interface AdoptedStyleSheetsConverterParams {
 /**
  * AdoptedStyleSheetsConverter
  *
- * A custom controller that detects a `style` tag inside a `template` element from
- * the light DOM and then converts and adds it to the component's `adoptedStyleSheets` array.
+ * Detects a `style` tag inside a `template` element from the light DOM, converts the styles,
+ * and adds it to the component's `adoptedStyleSheets`.
  *
- * @param {boolean} clearStyles replace or preserve original styles. Defaults to `false`.
- * @param {string} id unique identifier that points to the id of a `template` element. Defaults to empty string.
+ * @param clearStyles replace or preserve original styles. Defaults to `false`.
+ * @param id unique identifier that points to the id of a `template` element. Defaults to empty string.
  */
 export class AdoptedStyleSheetsConverter implements ReactiveController {
   host: ReactiveControllerHost;
@@ -40,6 +40,10 @@ export class AdoptedStyleSheetsConverter implements ReactiveController {
     this.removeComponentStyleTag();
   }
 
+  private getTemplateElement(): HTMLTemplateElement | null {
+    return document.querySelector(`template${this.id ? '#' + this.id : ''}`) || document.querySelector('template');
+  }
+
   private removeComponentStyleTag() {
     if (!this._template) {
       return;
@@ -54,10 +58,6 @@ export class AdoptedStyleSheetsConverter implements ReactiveController {
     shadowRoot.removeChild(styleElement);
   }
 
-  private getTemplateElement(): HTMLTemplateElement | null {
-    return document.querySelector(`template${this.id ? '#' + this.id : ''}`) || document.querySelector('template');
-  }
-
   private handleAdoptedStyleSheets(styleElement: HTMLStyleElement) {
     const litElement = this.host as LitElement;
     const shadowRoot = litElement.renderRoot as ShadowRoot;

diff --git a/packages/lit-override/src/directives/template-content-with-fallback.ts b/packages/lit-override/src/directives/template-content-with-fallback.ts
@@ -46,8 +46,8 @@ class TemplateContentWithFallbackDirective extends Directive {
  * Will fallback to your component's markup provided as an argument.
  *
  *
- * @param {TemplateResult} fallback renders markup if a `template` element is not found. Defaults to `<slot></slot>`.
- * @param {string} id unique identifier that points to the id of a `template` element. Defaults to empty string.
+ * @param fallback renders markup if a `template` element is not found. Defaults to `<slot></slot>`.
+ * @param id unique identifier that points to the id of a `template` element. Defaults to empty string.
  */
 // @ts-expect-error - ignore typing error
 export const templateContentWithFallback = directive(TemplateContentWithFallbackDirective);

diff --git a/packages/lit-override/src/mixins/emit-connected-callback.ts b/packages/lit-override/src/mixins/emit-connected-callback.ts
@@ -11,8 +11,7 @@ export declare class EmitConnectedCallbackInterface {
 /**
  * LitOverrideMixin
  *
- * A mixin that enables your component to emit `connected-callback` if
- * `emitConnectedCallback` prop is set.
+ * Enables your component to emit `connected-callback` if `emitConnectedCallback` prop is set.
  *
  * @fires connected-callback when `emitConnectedCallback` is `true`
  * @property {boolean} emitConnectedCallback - Set prop to use `connected-callback` event. Defaults to `false`.

diff --git a/packages/lit-override/src/utils/markup.ts b/packages/lit-override/src/utils/markup.ts
@@ -8,9 +8,6 @@ import { LitElement, TemplateResult } from 'lit';
  *
  * **Note**: Only static markdown is supported.
  *
- * **Note**: This utility clears DOM nodes which can cause performance bottlenecks if there are a lot
- * of components and/or existing DOM elements. Use cautiously.
- *
  */
 export const injectTemplate = (elements: NodeListOf<Element> | Array<Element>, template: TemplateResult): void => {
   if (!elements || !elements.length || !template) {