@vaadin/lit-renderer 24.2.0-alpha4 → 24.2.0-alpha5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/lit-renderer",
-  "version": "24.2.0-alpha4",
+  "version": "24.2.0-alpha5",
   "publishConfig": {
     "access": "public"
   },
@@ -34,8 +34,8 @@
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/testing-helpers": "^0.4.2",
+    "@vaadin/testing-helpers": "^0.4.3",
     "sinon": "^13.0.2"
   },
-  "gitHead": "aaf7c5ebfea62628210eead4229be1718ac6b129"
+  "gitHead": "73db22a5e8993e3ce48d1e6540d30eff9cb5c257"
 }

package/src/lit-renderer.d.ts

@@ -3,10 +3,16 @@
  * Copyright (c) 2016 - 2023 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import type { ElementPart, nothing, RenderOptions, TemplateResult } from 'lit';
+import type { ElementPart, noChange, nothing, RenderOptions, TemplateResult } from 'lit';
 import { AsyncDirective } from 'lit/async-directive.js';
 
-export type LitRenderer = (...args: any[]) => TemplateResult;
+// Opinionated union of types allowed to be returned from Lit renderers.
+// Theoretically Lit allows to render pretty much everything, but in practice
+// these seem the mose useful ones, without allowing developers to return things
+// like objects or dates that probably don't render the way they expect.
+export type LitRendererResult = TemplateResult | string | typeof noChange | typeof nothing | null;
+
+export type LitRenderer = (...args: any[]) => LitRendererResult;
 
 export abstract class LitRendererDirective<E extends Element, R extends LitRenderer> extends AsyncDirective {
   protected host: RenderOptions['host'];

package/src/lit-renderer.js

@@ -77,6 +77,10 @@ export class LitRendererDirective extends AsyncDirective {
 
   /** @protected */
   renderRenderer(container, ...args) {
+    // Note that a renderer result is not necessarily a `TemplateResult`
+    // instance, as Lit allows returning any value from a renderer. The concrete
+    // list of types we allow as render results is defined in the Typescript
+    // `LitRendererResult` type.
     const templateResult = this.renderer.call(this.host, ...args);
     render(templateResult, container, { host: this.host });
   }