@vaadin/context-menu 23.1.0-beta1 → 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/context-menu",
-  "version": "23.1.0-beta1",
+  "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"
   ],
@@ -35,19 +37,20 @@
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "23.1.0-beta1",
-    "@vaadin/item": "23.1.0-beta1",
-    "@vaadin/list-box": "23.1.0-beta1",
-    "@vaadin/vaadin-lumo-styles": "23.1.0-beta1",
-    "@vaadin/vaadin-material-styles": "23.1.0-beta1",
-    "@vaadin/vaadin-overlay": "23.1.0-beta1",
-    "@vaadin/vaadin-themable-mixin": "23.1.0-beta1"
+    "@vaadin/component-base": "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-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-beta1",
+    "@vaadin/polymer-legacy-adapter": "23.1.0-beta2",
     "@vaadin/testing-helpers": "^0.3.2",
     "sinon": "^13.0.2"
   },
-  "gitHead": "8be43cf83102a6b9ccf309687446e590ce0164e8"
+  "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 { ContextMenu, ContextMenuRendererContext } from '../vaadin-context-menu.js';
+
+export type ContextMenuLitRenderer = (context: ContextMenuRendererContext, menu: ContextMenu) => TemplateResult;
+
+export class ContextMenuRendererDirective extends LitRendererDirective<ContextMenu, ContextMenuLitRenderer> {
+  /**
+   * Adds the renderer callback to the context-menu.
+   */
+  addRenderer(): void;
+
+  /**
+   * Runs the renderer callback on the context-menu.
+   */
+  runRenderer(): void;
+
+  /**
+   * Removes the renderer callback from the context-menu.
+   */
+  removeRenderer(): void;
+}
+
+/**
+ * A Lit directive for populating the content of the context-menu.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the context-menu
+ * 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-context-menu
+ *   ${contextMenuRenderer((context, menu) => html`...`)}
+ * ></vaadin-context-menu>`
+ * ```
+ *
+ * @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 contextMenuRenderer(
+  renderer: ContextMenuLitRenderer,
+  dependencies?: unknown,
+): DirectiveResult<typeof ContextMenuRendererDirective>;

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 ContextMenuRendererDirective extends LitRendererDirective {
+  /**
+   * Adds the renderer callback to the context-menu.
+   */
+  addRenderer() {
+    this.element.renderer = (root, contextMenu, context) => {
+      this.renderRenderer(root, context, contextMenu);
+    };
+  }
+
+  /**
+   * Runs the renderer callback on the context-menu.
+   */
+  runRenderer() {
+    this.element.requestContentUpdate();
+  }
+
+  /**
+   * Removes the renderer callback from the context-menu.
+   */
+  removeRenderer() {
+    this.element.renderer = null;
+  }
+}
+
+/**
+ * A Lit directive for populating the content of the context-menu.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the context-menu
+ * 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-context-menu
+ *   ${contextMenuRenderer((context, menu) => html`...`)}
+ * ></vaadin-context-menu>`
+ * ```
+ *
+ * @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 contextMenuRenderer = directive(ContextMenuRendererDirective);

package/src/vaadin-context-menu.js

@@ -274,7 +274,7 @@ class ContextMenu extends ControllerMixin(ElementMixin(ThemePropertyMixin(ItemsM
        */
       listenOn: {
         type: Object,
-        value: function () {
+        value() {
           return this;
         },
       },
@@ -430,12 +430,12 @@ class ContextMenu extends ControllerMixin(ElementMixin(ThemePropertyMixin(ItemsM
 
   /** @private */
   _setListenOnUserSelect(value) {
-    // note: these styles don't seem to work in Firefox on iOS.
+    // Note: these styles don't seem to work in Firefox on iOS.
     this.listenOn.style.webkitTouchCallout = value;
     this.listenOn.style.webkitUserSelect = value; // Chrome, Safari, Firefox
     this.listenOn.style.userSelect = value;
 
-    // note: because user-selection is disabled on the overlay
+    // Note: because user-selection is disabled on the overlay
     // before opening the menu the text could be already selected
     // so we need to clear that selection
     document.getSelection().removeAllRanges();

package/src/vaadin-contextmenu-event.js

@@ -20,21 +20,21 @@ register({
     sourceEvent: null,
   },
 
-  reset: function () {
+  reset() {
     this.info.sourceEvent = null;
     this._cancelTimer();
     this.info.touchJob = null;
     this.info.touchStartCoords = null;
   },
 
-  _cancelTimer: function () {
+  _cancelTimer() {
     if (this._timerId) {
       clearTimeout(this._timerId);
       delete this._fired;
     }
   },
 
-  touchstart: function (e) {
+  touchstart(e) {
     this.info.sourceEvent = e;
     this.info.touchStartCoords = {
       x: e.changedTouches[0].clientX,
@@ -53,14 +53,14 @@ register({
           this.fire(t, ct.clientX, ct.clientY);
         }
 
-        // needed to prevent any 'tap' gesture events from firing
+        // Needed to prevent any 'tap' gesture events from firing
         // which could potentially cancel/close the overlay.
         prevent('tap');
       }
-    }, 500); // default setting for Android and iOS.
+    }, 500); // Default setting for Android and iOS.
   },
 
-  touchmove: function (e) {
+  touchmove(e) {
     const moveThreshold = 15;
     const touchStartCoords = this.info.touchStartCoords;
     if (
@@ -71,14 +71,14 @@ register({
     }
   },
 
-  touchend: function (e) {
+  touchend(e) {
     if (this._fired) {
       e.preventDefault();
     }
     this._cancelTimer();
   },
 
-  contextmenu: function (e) {
+  contextmenu(e) {
     if (!e.shiftKey) {
       this.info.sourceEvent = e;
       this.fire(e.target, e.clientX, e.clientY);
@@ -86,14 +86,14 @@ register({
     }
   },
 
-  fire: function (target, x, y) {
+  fire(target, x, y) {
     // NOTE(web-padawan): the code below is copied from `Polymer.Gestures._fire`,
     // which is not exported from `gestures.js` module for Polymer 3.
     const sourceEvent = this.info.sourceEvent;
     const ev = new Event('vaadin-contextmenu', { bubbles: true, cancelable: true, composed: true });
     ev.detail = { x, y, sourceEvent };
     target.dispatchEvent(ev);
-    // forward `preventDefault` in a clean way
+    // Forward `preventDefault` in a clean way
     if (ev.defaultPrevented && sourceEvent && sourceEvent.preventDefault) {
       sourceEvent.preventDefault();
     }

package/src/vaadin-contextmenu-items-mixin.js

@@ -139,7 +139,7 @@ export const ItemsMixin = (superClass) =>
     __forwardFocus() {
       const overlay = this.$.overlay;
       const child = overlay.getFirstChild();
-      // if parent item is not focused, do not focus submenu
+      // If parent item is not focused, do not focus submenu
       if (overlay.parentOverlay) {
         const parent = overlay.parentOverlay.querySelector('[expanded]');
         if (parent && parent.hasAttribute('focused') && child) {