@vaadin/icon 24.0.0-alpha8 → 24.0.0-beta1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/icon",
-  "version": "24.0.0-alpha8",
+  "version": "24.0.0-beta1",
   "publishConfig": {
     "access": "public"
   },
@@ -35,19 +35,19 @@
   ],
   "dependencies": {
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "24.0.0-alpha8",
-    "@vaadin/vaadin-lumo-styles": "24.0.0-alpha8",
-    "@vaadin/vaadin-themable-mixin": "24.0.0-alpha8",
+    "@vaadin/component-base": "24.0.0-beta1",
+    "@vaadin/vaadin-lumo-styles": "24.0.0-beta1",
+    "@vaadin/vaadin-themable-mixin": "24.0.0-beta1",
     "lit": "^2.0.0"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/testing-helpers": "^0.3.2",
+    "@vaadin/testing-helpers": "^0.4.0",
     "sinon": "^13.0.2"
   },
   "web-types": [
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "476752249bb12295c500980d98a3256ad3b22b73"
+  "gitHead": "c5b48921a62482746df8e46994b37e1490fec27e"
 }

package/src/vaadin-icon.js

@@ -11,8 +11,6 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
 import { ensureSvgLiteral, renderSvg } from './vaadin-icon-svg.js';
 import { Iconset } from './vaadin-iconset.js';
 
-const DEFAULT_ICONSET = 'vaadin';
-
 /**
  * `<vaadin-icon>` is a Web Component for displaying SVG icons.
  *
@@ -143,11 +141,6 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
     return ['__svgChanged(svg, __svgElement)'];
   }
 
-  constructor() {
-    super();
-    this.__onIconsetRegistered = this.__onIconsetRegistered.bind(this);
-  }
-
   /** @protected */
   ready() {
     super.ready();
@@ -157,48 +150,39 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
     this.addController(this._tooltipController);
   }
 
-  /** @private */
-  __getIconsetName(icon) {
-    if (!icon) {
-      return;
-    }
-
-    const parts = icon.split(':');
-    return parts[0] || DEFAULT_ICONSET;
-  }
-
-  /** @private */
-  __onIconsetRegistered(e) {
-    if (e.detail === this.__getIconsetName(this.icon)) {
-      this.__iconChanged(this.icon);
-    }
-  }
-
   /** @protected */
   connectedCallback() {
     super.connectedCallback();
-    document.addEventListener('vaadin-iconset-registered', this.__onIconsetRegistered);
+
+    Iconset.attachedIcons.add(this);
   }
 
   /** @protected */
   disconnectedCallback() {
     super.disconnectedCallback();
-    document.removeEventListener('vaadin-iconset-registered', this.__onIconsetRegistered);
+
+    Iconset.attachedIcons.delete(this);
+  }
+
+  /** @protected */
+  _applyIcon() {
+    const { svg, size, viewBox } = Iconset.getIconSvg(this.icon);
+
+    if (viewBox) {
+      this.__viewBox = viewBox;
+    }
+
+    if (size && size !== this.size) {
+      this.size = size;
+    }
+
+    this.svg = svg;
   }
 
   /** @private */
   __iconChanged(icon) {
     if (icon) {
-      const iconsetName = this.__getIconsetName(icon);
-      const iconset = Iconset.getIconset(iconsetName);
-      const { svg, size, viewBox } = iconset.applyIcon(icon);
-      if (viewBox) {
-        this.__viewBox = viewBox;
-      }
-      if (size !== this.size) {
-        this.size = size;
-      }
-      this.svg = svg;
+      this._applyIcon();
     } else {
       this.svg = ensureSvgLiteral(null);
     }

package/src/vaadin-iconset.d.ts

@@ -4,6 +4,7 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
+import type { Icon } from './vaadin-icon.js';
 import type { IconSvgLiteral } from './vaadin-icon-svg.js';
 
 /**
@@ -11,10 +12,26 @@ import type { IconSvgLiteral } from './vaadin-icon-svg.js';
  */
 declare class Iconset extends ElementMixin(HTMLElement) {
   /**
-   * Create an instance of the iconset.
+   * Set of the `vaadin-icon` instances in the DOM.
+   */
+  static attachedIcons(): Set<Icon>;
+
+  /**
+   * Returns an instance of the iconset by its name.
    */
   static getIconset(name: string): Iconset;
 
+  /**
+   * Register an iconset without adding to the DOM.
+   */
+  static register(name: string, size: number, template: HTMLTemplateElement): void;
+
+  /**
+   * Returns SVGTemplateResult for the `icon` ID matching `name` of the
+   * iconset, or `nothing` literal if there is no matching icon found.
+   */
+  static getIconSvg(icon: string, name?: string): { svg: IconSvgLiteral; size?: number; viewBox?: string | null };
+
   /**
    * The name of the iconset. Every iconset is required to have its own unique name.
    * All the SVG icons in the iconset must have IDs conforming to its name.
@@ -30,12 +47,6 @@ declare class Iconset extends ElementMixin(HTMLElement) {
    * over the size defined by the user to ensure correct appearance.
    */
   size: number;
-
-  /**
-   * Produce SVGTemplateResult for the element matching `name` in this
-   * iconset, or `undefined` if there is no matching element.
-   */
-  applyIcon(name: string): { svg: IconSvgLiteral; size: number; viewBox: string | null };
 }
 
 declare global {

package/src/vaadin-iconset.js

@@ -7,7 +7,32 @@ import { PolymerElement } from '@polymer/polymer/polymer-element.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
 import { cloneSvgNode } from './vaadin-icon-svg.js';
 
-const iconRegistry = {};
+const iconsetRegistry = {};
+
+const attachedIcons = new Set();
+
+function getIconId(id, name) {
+  return (id || '').replace(`${name}:`, '');
+}
+
+function getIconsetName(icon) {
+  if (!icon) {
+    return;
+  }
+
+  const parts = icon.split(':');
+
+  // Use "vaadin" as a fallback
+  return parts[0] || 'vaadin';
+}
+
+function initIconsMap(iconset, name) {
+  iconset._icons = [...iconset.querySelectorAll('[id]')].reduce((map, svg) => {
+    const key = getIconId(svg.id, name);
+    map[key] = svg;
+    return map;
+  }, {});
+}
 
 /**
  * `<vaadin-iconset>` is a Web Component for creating SVG icon collections.
@@ -51,18 +76,72 @@ class Iconset extends ElementMixin(PolymerElement) {
   }
 
   /**
-   * Create an instance of the iconset.
+   * Set of the `vaadin-icon` instances in the DOM.
+   *
+   * @return {Set<Icon>}
+   */
+  static get attachedIcons() {
+    return attachedIcons;
+  }
+
+  /**
+   * Returns an instance of the iconset by its name.
    *
    * @param {string} name
+   * @return {Iconset}
    */
   static getIconset(name) {
-    let iconset = iconRegistry[name];
-    if (!iconset) {
-      iconset = document.createElement('vaadin-iconset');
+    return iconsetRegistry[name];
+  }
+
+  /**
+   * Returns SVGTemplateResult for the `icon` ID matching `name` of the
+   * iconset, or `nothing` literal if there is no matching icon found.
+   *
+   * @param {string} icon
+   * @param {?string} name
+   */
+  static getIconSvg(icon, name) {
+    const iconsetName = name || getIconsetName(icon);
+    const iconset = this.getIconset(iconsetName);
+
+    if (!icon || !iconset) {
+      // Missing icon, return `nothing` literal.
+      return { svg: cloneSvgNode(null) };
+    }
+
+    const iconId = getIconId(icon, iconsetName);
+    const iconSvg = iconset._icons[iconId];
+
+    return {
+      svg: cloneSvgNode(iconSvg),
+      size: iconset.size,
+      viewBox: iconSvg ? iconSvg.getAttribute('viewBox') : null,
+    };
+  }
+
+  /**
+   * Register an iconset without adding to the DOM.
+   *
+   * @param {string} name
+   * @param {number} size
+   * @param {?HTMLTemplateElement} template
+   */
+  static register(name, size, template) {
+    if (!iconsetRegistry[name]) {
+      const iconset = document.createElement('vaadin-iconset');
+      iconset.appendChild(template.content.cloneNode(true));
+      iconsetRegistry[name] = iconset;
+
+      initIconsMap(iconset, name);
+
+      iconset.size = size;
       iconset.name = name;
-      iconRegistry[name] = iconset;
+
+      // Call this function manually instead of using observer
+      // to make it work without appending element to the DOM.
+      iconset.__nameChanged(name);
     }
-    return iconset;
   }
 
   /** @protected */
@@ -70,53 +149,36 @@ class Iconset extends ElementMixin(PolymerElement) {
     super.connectedCallback();
 
     this.style.display = 'none';
+
+    // Store reference and init icons.
+    const { name } = this;
+    iconsetRegistry[name] = this;
+    initIconsMap(this, name);
+    this.__updateIcons(name);
   }
 
   /**
-   * Produce SVGTemplateResult for the element matching `name` in this
-   * iconset, or `undefined` if there is no matching element.
+   * Update all the icons instances in the DOM.
    *
    * @param {string} name
+   * @private
    */
-  applyIcon(name) {
-    // Create the icon map on-demand, since the iconset itself has no discrete
-    // signal to know when it's children are fully parsed
-    if (!this._icons) {
-      this._icons = this.__createIconMap();
-    }
-    const icon = this._icons[this.__getIconId(name)];
-    return {
-      svg: cloneSvgNode(icon),
-      size: this.size,
-      viewBox: icon ? icon.getAttribute('viewBox') : null,
-    };
-  }
-
-  /**
-   * Create a map of child SVG elements by id.
-   */
-  __createIconMap() {
-    const icons = {};
-    this.querySelectorAll('[id]').forEach((icon) => {
-      icons[this.__getIconId(icon.id)] = icon;
+  __updateIcons(name) {
+    attachedIcons.forEach((element) => {
+      if (name === getIconsetName(element.icon)) {
+        element._applyIcon();
+      }
     });
-    return icons;
-  }
-
-  /** @private */
-  __getIconId(id) {
-    return (id || '').replace(`${this.name}:`, '');
   }
 
   /** @private */
   __nameChanged(name, oldName) {
     if (oldName) {
-      iconRegistry[name] = Iconset.getIconset(oldName);
-      delete iconRegistry[oldName];
+      iconsetRegistry[name] = iconsetRegistry[oldName];
+      delete iconsetRegistry[oldName];
     }
     if (name) {
-      iconRegistry[name] = this;
-      document.dispatchEvent(new CustomEvent('vaadin-iconset-registered', { detail: name }));
+      this.__updateIcons(name);
     }
   }
 }

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/icon",
-  "version": "24.0.0-alpha8",
+  "version": "24.0.0-beta1",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -12,7 +12,7 @@
           "attributes": [
             {
               "name": "name",
-              "description": "The name of the iconset. Every iconset is required to have its own unique name.\nAll the SVG icons in the iconset must have IDs conforming to its name.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
+              "description": "The name of the iconset. Every iconset is required to have its own unique name.\nAll the SVG icons in the iconset must have IDs conforming to its name.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
               "value": {
                 "type": [
                   "string",
@@ -48,7 +48,7 @@
             "properties": [
               {
                 "name": "name",
-                "description": "The name of the iconset. Every iconset is required to have its own unique name.\nAll the SVG icons in the iconset must have IDs conforming to its name.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
+                "description": "The name of the iconset. Every iconset is required to have its own unique name.\nAll the SVG icons in the iconset must have IDs conforming to its name.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
                 "value": {
                   "type": [
                     "string",
@@ -74,11 +74,11 @@
         },
         {
           "name": "vaadin-icon",
-          "description": "`<vaadin-icon>` is a Web Component for displaying SVG icons.\n\n### Icon property\n\nThe `<vaadin-icon>` component is designed to be used as a drop-in replacement for `<iron-icon>`.\nFor example, you can use it with `vaadin-icons` like this:\n\n```html\n<vaadin-icon icon=\"vaadin:angle-down\"></vaadin-icon>\n```\n\nAlternatively, you can also pick one of the Lumo icons:\n\n```html\n<vaadin-icon icon=\"lumo:user\"></vaadin-icon>\n```\n\n### Custom SVG icon\n\nAlternatively, instead of selecting an icon from an iconset by name, you can pass any custom `svg`\nliteral using the [`svg`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-icon#property-svg) property. In this case you can also\ndefine the size of the SVG `viewBox` using the [`size`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-icon#property-size) property:\n\n```js\nimport { html, svg } from 'lit';\n\n// in your component\nrender() {\n  const svgIcon = svg`<path d=\"M13 4v2l-5 5-5-5v-2l5 5z\"></path>`;\n  return html`\n    <vaadin-icon\n      .svg=\"${svgIcon}\"\n      size=\"16\"\n    ></vaadin-icon>\n  `;\n}\n```",
+          "description": "`<vaadin-icon>` is a Web Component for displaying SVG icons.\n\n### Icon property\n\nThe `<vaadin-icon>` component is designed to be used as a drop-in replacement for `<iron-icon>`.\nFor example, you can use it with `vaadin-icons` like this:\n\n```html\n<vaadin-icon icon=\"vaadin:angle-down\"></vaadin-icon>\n```\n\nAlternatively, you can also pick one of the Lumo icons:\n\n```html\n<vaadin-icon icon=\"lumo:user\"></vaadin-icon>\n```\n\n### Custom SVG icon\n\nAlternatively, instead of selecting an icon from an iconset by name, you can pass any custom `svg`\nliteral using the [`svg`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-icon#property-svg) property. In this case you can also\ndefine the size of the SVG `viewBox` using the [`size`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-icon#property-size) property:\n\n```js\nimport { html, svg } from 'lit';\n\n// in your component\nrender() {\n  const svgIcon = svg`<path d=\"M13 4v2l-5 5-5-5v-2l5 5z\"></path>`;\n  return html`\n    <vaadin-icon\n      .svg=\"${svgIcon}\"\n      size=\"16\"\n    ></vaadin-icon>\n  `;\n}\n```",
           "attributes": [
             {
               "name": "icon",
-              "description": "The name of the icon to use. The name should be of the form:\n`iconset_name:icon_name`. When using `vaadin-icons` it is possible\nto omit the first part and only use `icon_name` as a value.\n\nSetting the `icon` property updates the `svg` and `size` based on the\nvalues provided by the corresponding `vaadin-iconset` element.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
+              "description": "The name of the icon to use. The name should be of the form:\n`iconset_name:icon_name`. When using `vaadin-icons` it is possible\nto omit the first part and only use `icon_name` as a value.\n\nSetting the `icon` property updates the `svg` and `size` based on the\nvalues provided by the corresponding `vaadin-iconset` element.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
               "value": {
                 "type": [
                   "string",
@@ -114,7 +114,7 @@
             "properties": [
               {
                 "name": "icon",
-                "description": "The name of the icon to use. The name should be of the form:\n`iconset_name:icon_name`. When using `vaadin-icons` it is possible\nto omit the first part and only use `icon_name` as a value.\n\nSetting the `icon` property updates the `svg` and `size` based on the\nvalues provided by the corresponding `vaadin-iconset` element.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
+                "description": "The name of the icon to use. The name should be of the form:\n`iconset_name:icon_name`. When using `vaadin-icons` it is possible\nto omit the first part and only use `icon_name` as a value.\n\nSetting the `icon` property updates the `svg` and `size` based on the\nvalues provided by the corresponding `vaadin-iconset` element.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
                 "value": {
                   "type": [
                     "string",

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/icon",
-  "version": "24.0.0-alpha8",
+  "version": "24.0.0-beta1",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -21,7 +21,7 @@
           "attributes": [
             {
               "name": ".name",
-              "description": "The name of the iconset. Every iconset is required to have its own unique name.\nAll the SVG icons in the iconset must have IDs conforming to its name.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
+              "description": "The name of the iconset. Every iconset is required to have its own unique name.\nAll the SVG icons in the iconset must have IDs conforming to its name.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
               "value": {
                 "kind": "expression"
               }
@@ -37,12 +37,12 @@
         },
         {
           "name": "vaadin-icon",
-          "description": "`<vaadin-icon>` is a Web Component for displaying SVG icons.\n\n### Icon property\n\nThe `<vaadin-icon>` component is designed to be used as a drop-in replacement for `<iron-icon>`.\nFor example, you can use it with `vaadin-icons` like this:\n\n```html\n<vaadin-icon icon=\"vaadin:angle-down\"></vaadin-icon>\n```\n\nAlternatively, you can also pick one of the Lumo icons:\n\n```html\n<vaadin-icon icon=\"lumo:user\"></vaadin-icon>\n```\n\n### Custom SVG icon\n\nAlternatively, instead of selecting an icon from an iconset by name, you can pass any custom `svg`\nliteral using the [`svg`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-icon#property-svg) property. In this case you can also\ndefine the size of the SVG `viewBox` using the [`size`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-icon#property-size) property:\n\n```js\nimport { html, svg } from 'lit';\n\n// in your component\nrender() {\n  const svgIcon = svg`<path d=\"M13 4v2l-5 5-5-5v-2l5 5z\"></path>`;\n  return html`\n    <vaadin-icon\n      .svg=\"${svgIcon}\"\n      size=\"16\"\n    ></vaadin-icon>\n  `;\n}\n```",
+          "description": "`<vaadin-icon>` is a Web Component for displaying SVG icons.\n\n### Icon property\n\nThe `<vaadin-icon>` component is designed to be used as a drop-in replacement for `<iron-icon>`.\nFor example, you can use it with `vaadin-icons` like this:\n\n```html\n<vaadin-icon icon=\"vaadin:angle-down\"></vaadin-icon>\n```\n\nAlternatively, you can also pick one of the Lumo icons:\n\n```html\n<vaadin-icon icon=\"lumo:user\"></vaadin-icon>\n```\n\n### Custom SVG icon\n\nAlternatively, instead of selecting an icon from an iconset by name, you can pass any custom `svg`\nliteral using the [`svg`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-icon#property-svg) property. In this case you can also\ndefine the size of the SVG `viewBox` using the [`size`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-icon#property-size) property:\n\n```js\nimport { html, svg } from 'lit';\n\n// in your component\nrender() {\n  const svgIcon = svg`<path d=\"M13 4v2l-5 5-5-5v-2l5 5z\"></path>`;\n  return html`\n    <vaadin-icon\n      .svg=\"${svgIcon}\"\n      size=\"16\"\n    ></vaadin-icon>\n  `;\n}\n```",
           "extension": true,
           "attributes": [
             {
               "name": ".icon",
-              "description": "The name of the icon to use. The name should be of the form:\n`iconset_name:icon_name`. When using `vaadin-icons` it is possible\nto omit the first part and only use `icon_name` as a value.\n\nSetting the `icon` property updates the `svg` and `size` based on the\nvalues provided by the corresponding `vaadin-iconset` element.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha8/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
+              "description": "The name of the icon to use. The name should be of the form:\n`iconset_name:icon_name`. When using `vaadin-icons` it is possible\nto omit the first part and only use `icon_name` as a value.\n\nSetting the `icon` property updates the `svg` and `size` based on the\nvalues provided by the corresponding `vaadin-iconset` element.\n\nSee also [`name`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta1/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
               "value": {
                 "kind": "expression"
               }