@vaadin/select 23.1.0-alpha3 → 23.1.0-beta2

package/lit.d.ts

@@ -0,0 +1 @@
+export * from './src/lit/renderer-directives.js';

package/lit.js

@@ -0,0 +1 @@
+export * from './src/lit/renderer-directives.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/select",
-  "version": "23.1.0-alpha3",
+  "version": "23.1.0-beta2",
   "publishConfig": {
     "access": "public"
   },
@@ -22,6 +22,8 @@
   "files": [
     "src",
     "theme",
+    "lit.js",
+    "lit.d.ts",
     "vaadin-*.d.ts",
     "vaadin-*.js"
   ],
@@ -34,24 +36,25 @@
   ],
   "dependencies": {
     "@polymer/polymer": "^3.2.0",
-    "@vaadin/button": "23.1.0-alpha3",
-    "@vaadin/component-base": "23.1.0-alpha3",
-    "@vaadin/field-base": "23.1.0-alpha3",
-    "@vaadin/input-container": "23.1.0-alpha3",
-    "@vaadin/item": "23.1.0-alpha3",
-    "@vaadin/list-box": "23.1.0-alpha3",
-    "@vaadin/vaadin-list-mixin": "23.1.0-alpha3",
-    "@vaadin/vaadin-lumo-styles": "23.1.0-alpha3",
-    "@vaadin/vaadin-material-styles": "23.1.0-alpha3",
-    "@vaadin/vaadin-overlay": "23.1.0-alpha3",
-    "@vaadin/vaadin-themable-mixin": "23.1.0-alpha3"
+    "@vaadin/button": "23.1.0-beta2",
+    "@vaadin/component-base": "23.1.0-beta2",
+    "@vaadin/field-base": "23.1.0-beta2",
+    "@vaadin/input-container": "23.1.0-beta2",
+    "@vaadin/item": "23.1.0-beta2",
+    "@vaadin/list-box": "23.1.0-beta2",
+    "@vaadin/lit-renderer": "23.1.0-beta2",
+    "@vaadin/vaadin-list-mixin": "23.1.0-beta2",
+    "@vaadin/vaadin-lumo-styles": "23.1.0-beta2",
+    "@vaadin/vaadin-material-styles": "23.1.0-beta2",
+    "@vaadin/vaadin-overlay": "23.1.0-beta2",
+    "@vaadin/vaadin-themable-mixin": "23.1.0-beta2"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/polymer-legacy-adapter": "23.1.0-alpha3",
+    "@vaadin/polymer-legacy-adapter": "23.1.0-beta2",
     "@vaadin/testing-helpers": "^0.3.2",
     "lit": "^2.0.0",
     "sinon": "^13.0.2"
   },
-  "gitHead": "8c9e64e8dfa158dd52a9bf6da351ff038c88ca85"
+  "gitHead": "f11f9245a0b5e6bf912725a501c27c24b74e7c8d"
 }

package/src/lit/renderer-directives.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @license
+ * Copyright (c) 2017 - 2022 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { TemplateResult } from 'lit';
+import { DirectiveResult } from 'lit/directive.js';
+import { LitRendererDirective } from '@vaadin/lit-renderer';
+import { Select } from '../vaadin-select.js';
+
+export type SelectLitRenderer = (select: Select) => TemplateResult;
+
+export class SelectRendererDirective extends LitRendererDirective<Select, SelectLitRenderer> {
+  /**
+   * Adds the renderer callback to the select.
+   */
+  addRenderer(): void;
+
+  /**
+   * Runs the renderer callback on the select.
+   */
+  runRenderer(): void;
+
+  /**
+   * Removes the renderer callback from the select.
+   */
+  removeRenderer(): void;
+}
+
+/**
+ * A Lit directive for populating the content of the `<vaadin-select-overlay>` element.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the select
+ * via the `renderer` property. The renderer is called once to populate the content when assigned
+ * and whenever a single dependency or an array of dependencies changes.
+ * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
+ *
+ * Dependencies can be a single value or an array of values.
+ * Values are checked against previous values with strict equality (`===`),
+ * so the check won't detect nested property changes inside objects or arrays.
+ * When dependencies are provided as an array, each item is checked against the previous value
+ * at the same index with strict equality. Nested arrays are also checked only by strict
+ * equality.
+ *
+ * Example of usage:
+ * ```js
+ * `<vaadin-select
+ *   ${selectRenderer((select) => html`...`)}
+ * ></vaadin-select>`
+ * ```
+ *
+ * @param renderer the renderer callback that returns a Lit template.
+ * @param dependencies a single dependency or an array of dependencies
+ *                     which trigger a re-render when changed.
+ */
+export declare function selectRenderer(
+  renderer: SelectLitRenderer,
+  dependencies?: unknown,
+): DirectiveResult<typeof SelectRendererDirective>;

package/src/lit/renderer-directives.js

@@ -0,0 +1,60 @@
+/**
+ * @license
+ * Copyright (c) 2017 - 2022 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { directive } from 'lit/directive.js';
+import { LitRendererDirective } from '@vaadin/lit-renderer';
+
+export class SelectRendererDirective extends LitRendererDirective {
+  /**
+   * Adds the renderer callback to the select.
+   */
+  addRenderer() {
+    this.element.renderer = (root, select) => {
+      this.renderRenderer(root, select);
+    };
+  }
+
+  /**
+   * Runs the renderer callback on the select.
+   */
+  runRenderer() {
+    this.element.requestContentUpdate();
+  }
+
+  /**
+   * Removes the renderer callback from the select.
+   */
+  removeRenderer() {
+    this.element.renderer = null;
+  }
+}
+
+/**
+ * A Lit directive for populating the content of the `<vaadin-select-overlay>` element.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the select
+ * via the `renderer` property. The renderer is called once to populate the content when assigned
+ * and whenever a single dependency or an array of dependencies changes.
+ * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
+ *
+ * Dependencies can be a single value or an array of values.
+ * Values are checked against previous values with strict equality (`===`),
+ * so the check won't detect nested property changes inside objects or arrays.
+ * When dependencies are provided as an array, each item is checked against the previous value
+ * at the same index with strict equality. Nested arrays are also checked only by strict
+ * equality.
+ *
+ * Example of usage:
+ * ```js
+ * `<vaadin-select
+ *   ${selectRenderer((select) => html`...`)}
+ * ></vaadin-select>`
+ * ```
+ *
+ * @param renderer the renderer callback that returns a Lit template.
+ * @param dependencies a single dependency or an array of dependencies
+ *                     which trigger a re-render when changed.
+ */
+export const selectRenderer = directive(SelectRendererDirective);

package/src/vaadin-select-overlay.js

@@ -15,7 +15,7 @@ registerStyles(
       justify-content: flex-start;
     }
   `,
-  { moduleId: 'vaadin-select-overlay-styles' }
+  { moduleId: 'vaadin-select-overlay-styles' },
 );
 
 /**

package/src/vaadin-select.d.ts

@@ -255,13 +255,13 @@ declare class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixi
   addEventListener<K extends keyof SelectEventMap>(
     type: K,
     listener: (this: Select, ev: SelectEventMap[K]) => void,
-    options?: boolean | AddEventListenerOptions
+    options?: boolean | AddEventListenerOptions,
   ): void;
 
   removeEventListener<K extends keyof SelectEventMap>(
     type: K,
     listener: (this: Select, ev: SelectEventMap[K]) => void,
-    options?: boolean | EventListenerOptions
+    options?: boolean | EventListenerOptions,
   ): void;
 }
 

package/src/vaadin-select.js

@@ -208,7 +208,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
        */
       items: {
         type: Array,
-        observer: '__itemsChanged'
+        observer: '__itemsChanged',
       },
 
       /**
@@ -220,7 +220,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
         value: false,
         notify: true,
         reflectToAttribute: true,
-        observer: '_openedChanged'
+        observer: '_openedChanged',
       },
 
       /**
@@ -252,14 +252,14 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
         type: String,
         value: '',
         notify: true,
-        observer: '_valueChanged'
+        observer: '_valueChanged',
       },
 
       /**
        * The name of this element.
        */
       name: {
-        type: String
+        type: String,
       },
 
       /**
@@ -270,7 +270,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
        * DOM content is empty.
        */
       placeholder: {
-        type: String
+        type: String,
       },
 
       /**
@@ -280,7 +280,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
       readonly: {
         type: Boolean,
         value: false,
-        reflectToAttribute: true
+        reflectToAttribute: true,
       },
 
       /** @private */
@@ -288,7 +288,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
 
       /** @private */
       _phoneMediaQuery: {
-        value: '(max-width: 420px), (max-height: 420px)'
+        value: '(max-width: 420px), (max-height: 420px)',
       },
 
       /** @private */
@@ -298,7 +298,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
       _inputContainer: Object,
 
       /** @private */
-      _items: Object
+      _items: Object,
     };
   }
 
@@ -307,7 +307,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
       '_updateAriaExpanded(opened)',
       '_updateAriaRequired(required)',
       '_updateSelectedItem(value, _items, placeholder)',
-      '_rendererChanged(renderer, _overlayElement)'
+      '_rendererChanged(renderer, _overlayElement)',
     ];
   }
 
@@ -319,7 +319,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
         const button = document.createElement('vaadin-select-value-button');
         button.setAttribute('aria-haspopup', 'listbox');
         return button;
-      }
+      },
     };
   }
 
@@ -375,7 +375,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
     this.addController(
       new MediaQueryController(this._phoneMediaQuery, (matches) => {
         this._phone = matches;
-      })
+      }),
     );
 
     processTemplates(this);
@@ -450,7 +450,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
           this.__userInteraction = true;
           this.opened = false;
         },
-        true
+        true,
       );
 
       menuElement.setAttribute('role', 'listbox');
@@ -535,7 +535,7 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
 
       this._overlayElement.style.setProperty(
         '--vaadin-select-text-field-width',
-        this._inputContainer.offsetWidth + 'px'
+        `${this._inputContainer.offsetWidth}px`,
       );
 
       // Preserve focus-ring to restore it later
@@ -593,12 +593,12 @@ class Select extends DelegateFocusMixin(FieldMixin(SlotMixin(ElementMixin(Themab
       labelItem = selected.cloneNode(true);
     }
 
-    // store reference to the original item
+    // Store reference to the original item
     labelItem._sourceItem = selected;
 
     this.__appendValueItemElement(labelItem);
 
-    // ensure the item gets proper styles
+    // Ensure the item gets proper styles
     labelItem.selected = true;
   }
 

package/theme/lumo/vaadin-select-styles.js

@@ -76,7 +76,7 @@ registerStyles(
       background-color: transparent;
     }
   `,
-  { moduleId: 'lumo-select-value-button' }
+  { moduleId: 'lumo-select-value-button' },
 );
 
 const selectOverlay = css`

package/theme/material/vaadin-select-styles.js

@@ -58,7 +58,7 @@ registerStyles(
       background-color: transparent;
     }
   `,
-  { moduleId: 'material-select-value-button' }
+  { moduleId: 'material-select-value-button' },
 );
 
 const selectOverlay = css`