@vaadin/icon 24.2.0-dev.f254716fe → 24.3.0-alpha1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/icon",
-  "version": "24.2.0-dev.f254716fe",
+  "version": "24.3.0-alpha1",
   "publishConfig": {
     "access": "public"
   },
@@ -35,19 +35,19 @@
   ],
   "dependencies": {
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "24.2.0-dev.f254716fe",
-    "@vaadin/vaadin-lumo-styles": "24.2.0-dev.f254716fe",
-    "@vaadin/vaadin-themable-mixin": "24.2.0-dev.f254716fe",
+    "@vaadin/component-base": "24.3.0-alpha1",
+    "@vaadin/vaadin-lumo-styles": "24.3.0-alpha1",
+    "@vaadin/vaadin-themable-mixin": "24.3.0-alpha1",
     "lit": "^2.0.0"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/testing-helpers": "^0.4.3",
+    "@vaadin/testing-helpers": "^0.5.0",
     "sinon": "^13.0.2"
   },
   "web-types": [
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "da54950b9f8c14c6451ede0d426e16a489c7fb9b"
+  "gitHead": "9ca6f3ca220a777e8eea181a1f5717e39a732240"
 }

package/src/vaadin-icon-font-size-mixin.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2023 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import type { Constructor } from '@open-wc/dedupe-mixin';
+
+/**
+ * Mixin which enables the font icon sizing fallback for browsers that do not support CSS Container Queries.
+ * The mixin does nothing if the browser supports CSS Container Query units for pseudo elements.
+ */
+export declare function IconFontSizeMixin<T extends Constructor<HTMLElement>>(
+  base: T,
+): Constructor<IconFontSizeMixinClass> & T;
+
+export declare class IconFontSizeMixinClass {}

package/src/vaadin-icon-font-size-mixin.js

@@ -0,0 +1,76 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2023 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { dedupingMixin } from '@polymer/polymer/lib/utils/mixin.js';
+import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import { needsFontIconSizingFallback } from './vaadin-icon-helpers.js';
+
+const usesFontIconSizingFallback = needsFontIconSizingFallback();
+
+if (usesFontIconSizingFallback) {
+  registerStyles(
+    'vaadin-icon',
+    css`
+      :host::after,
+      :host::before {
+        font-size: var(--_vaadin-font-icon-size);
+      }
+    `,
+    'vaadin-icon-font-size-mixin-styles',
+  );
+}
+
+/**
+ * Mixin which enables the font icon sizing fallback for browsers that do not support CSS Container Queries.
+ * The mixin does nothing if the browser supports CSS Container Query units for pseudo elements.
+ *
+ * @polymerMixin
+ */
+export const IconFontSizeMixin = dedupingMixin((superclass) =>
+  !usesFontIconSizingFallback
+    ? superclass
+    : class extends ResizeMixin(superclass) {
+        static get observers() {
+          return ['__iconFontSizeMixinfontChanged(iconClass, char, ligature)'];
+        }
+
+        /** @protected */
+        ready() {
+          super.ready();
+
+          // Update once initially to avoid a fouc
+          this.__updateFontIconSize();
+        }
+
+        /** @private */
+        __iconFontSizeMixinfontChanged(_iconClass, _char, _ligature) {
+          // Update when iconClass, char or ligature changes
+          this.__updateFontIconSize();
+        }
+
+        /**
+         * @protected
+         * @override
+         */
+        _onResize() {
+          // Update when the element is resized
+          this.__updateFontIconSize();
+        }
+
+        /**
+         * Updates the --_vaadin-font-icon-size CSS variable value if font icons are used.
+         *
+         * @private
+         */
+        __updateFontIconSize() {
+          if (this.char || this.iconClass || this.ligature) {
+            const { paddingTop, paddingBottom, height } = getComputedStyle(this);
+            const fontIconSize = parseFloat(height) - parseFloat(paddingTop) - parseFloat(paddingBottom);
+            this.style.setProperty('--_vaadin-font-icon-size', `${fontIconSize}px`);
+          }
+        }
+      },
+);

package/src/vaadin-icon-helpers.js

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright (c) 2016 - 2023 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+
+import { isSafari } from '@vaadin/component-base/src/browser-utils.js';
+
+/**
+ * Checks if the current browser supports CSS Container Query units for pseudo elements.
+ * i.e. if the fix for https://bugs.webkit.org/show_bug.cgi?id=253939 is available.
+ */
+export function supportsCQUnitsForPseudoElements() {
+  const testStyle = document.createElement('style');
+  testStyle.textContent = `
+    .vaadin-icon-test-element {
+      container-type: size;
+      height: 2px;
+      visibility: hidden;
+      position: fixed;
+    }
+
+    .vaadin-icon-test-element::before {
+      content: '';
+      display: block;
+      height: 100cqh;
+    `;
+  const testElement = document.createElement('div');
+  testElement.classList.add('vaadin-icon-test-element');
+
+  document.body.append(testStyle, testElement);
+  const { height } = getComputedStyle(testElement, '::before');
+  testStyle.remove();
+  testElement.remove();
+  return height === '2px';
+}
+
+/**
+ * Checks if the current browser needs a fallback for sizing font icons instead of relying on CSS Container Queries.
+ */
+export function needsFontIconSizingFallback() {
+  if (!CSS.supports('container-type: inline-size')) {
+    // The browser does not support CSS Container Queries at all.
+    return true;
+  }
+  if (!isSafari) {
+    // Browsers other than Safari support CSS Container Queries as expected.
+    return false;
+  }
+  // Check if the browser does not support CSS Container Query units for pseudo elements.
+  return !supportsCQUnitsForPseudoElements();
+}

package/src/vaadin-icon.d.ts

@@ -5,7 +5,9 @@
  */
 import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
+import { SlotStylesMixin } from '@vaadin/component-base/src/slot-styles-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import { IconFontSizeMixin } from './vaadin-icon-font-size-mixin.js';
 import type { IconSvgLiteral } from './vaadin-icon-svg.js';
 
 /**
@@ -47,7 +49,9 @@ import type { IconSvgLiteral } from './vaadin-icon-svg.js';
  * }
  * ```
  */
-declare class Icon extends ThemableMixin(ElementMixin(ControllerMixin(HTMLElement))) {
+declare class Icon extends ThemableMixin(
+  ElementMixin(ControllerMixin(SlotStylesMixin(IconFontSizeMixin(HTMLElement)))),
+) {
   /**
    * The name of the icon to use. The name should be of the form:
    * `iconset_name:icon_name`. When using `vaadin-icons` it is possible
@@ -57,6 +61,8 @@ declare class Icon extends ThemableMixin(ElementMixin(ControllerMixin(HTMLElemen
    * values provided by the corresponding `vaadin-iconset` element.
    *
    * See also [`name`](#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.
+   *
+   * @attr {string} icon
    */
   icon: string | null;
 
@@ -65,6 +71,50 @@ declare class Icon extends ThemableMixin(ElementMixin(ControllerMixin(HTMLElemen
    */
   svg: IconSvgLiteral | null;
 
+  /**
+   * The SVG source to be loaded as the icon. It can be:
+   * - an URL to a file containing the icon
+   * - an URL in the format "/path/to/file.svg#objectID", where the "objectID" refers to an ID attribute contained
+   *   inside the SVG referenced by the path. Note that the file needs to follow the same-origin policy.
+   * - a string in the format "data:image/svg+xml,<svg>...</svg>". You may need to use the "encodeURIComponent"
+   *   function for the SVG content passed
+   */
+  src: string | null;
+
+  /**
+   * The symbol identifier that references an ID of an element contained in the SVG element assigned to the
+   * `src` property
+   */
+  symbol: string | null;
+
+  /**
+   * Class names defining an icon font and/or a specific glyph inside an icon font.
+   *
+   * Example: "fa-solid fa-user"
+   *
+   * @attr {string} icon-class
+   */
+  iconClass: string | null;
+
+  /**
+   * A hexadecimal code point that specifies a glyph from an icon font.
+   *
+   * Example: "e001"
+   */
+  char: string | null;
+
+  /**
+   * A ligature name that specifies an icon from an icon font with support for ligatures.
+   *
+   * Example: "home".
+   */
+  ligature: string | null;
+
+  /**
+   * The font family to use for the font icon.
+   */
+  fontFamily: string | null;
+
   /**
    * The size of an icon, used to set the `viewBox` attribute.
    */

package/src/vaadin-icon.js

@@ -5,12 +5,17 @@
  */
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
 import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
+import { SlotStylesMixin } from '@vaadin/component-base/src/slot-styles-mixin.js';
 import { TooltipController } from '@vaadin/component-base/src/tooltip-controller.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
-import { ensureSvgLiteral, renderSvg } from './vaadin-icon-svg.js';
+import { IconFontSizeMixin } from './vaadin-icon-font-size-mixin.js';
+import { ensureSvgLiteral, renderSvg, unsafeSvgLiteral } from './vaadin-icon-svg.js';
 import { Iconset } from './vaadin-iconset.js';
 
+const srcCache = new Map();
+
 /**
  * `<vaadin-icon>` is a Web Component for displaying SVG icons.
  *
@@ -50,12 +55,15 @@ import { Iconset } from './vaadin-iconset.js';
  * }
  * ```
  *
+ * @customElement
  * @extends HTMLElement
  * @mixes ControllerMixin
  * @mixes ThemableMixin
  * @mixes ElementMixin
+ * @mixes SlotStylesMixin
+ * @mixes IconFontSizeMixin
  */
-class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement))) {
+class Icon extends ThemableMixin(ElementMixin(ControllerMixin(SlotStylesMixin(IconFontSizeMixin(PolymerElement))))) {
   static get template() {
     return html`
       <style>
@@ -68,6 +76,16 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
           width: 24px;
           height: 24px;
           fill: currentColor;
+          container-type: size;
+        }
+
+        :host::after,
+        :host::before {
+          line-height: 1;
+          font-size: 100cqh;
+          -webkit-font-smoothing: antialiased;
+          text-rendering: optimizeLegibility;
+          -moz-osx-font-smoothing: grayscale;
         }
 
         :host([hidden]) {
@@ -79,6 +97,14 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
           width: 100%;
           height: 100%;
         }
+
+        :host(:is([icon-class], [font-icon-content])) svg {
+          display: none;
+        }
+
+        :host([font-icon-content])::before {
+          content: attr(font-icon-content);
+        }
       </style>
       <svg
         version="1.1"
@@ -87,7 +113,12 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
         viewBox="[[__computeViewBox(size, __viewBox)]]"
         preserveAspectRatio="[[__computePAR(__defaultPAR, __preserveAspectRatio)]]"
         aria-hidden="true"
-      ></svg>
+      >
+        <g id="svg-group"></g>
+        <g id="use-group" visibility$="[[__computeVisibility(__useRef, svg)]]">
+          <use href$="[[__useRef]]" />
+        </g>
+      </svg>
 
       <slot name="tooltip"></slot>
     `;
@@ -108,9 +139,13 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
        * values provided by the corresponding `vaadin-iconset` element.
        *
        * See also [`name`](#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.
+       *
+       * @attr {string} icon
+       * @type {string}
        */
       icon: {
         type: String,
+        reflectToAttribute: true,
         observer: '__iconChanged',
       },
 
@@ -121,6 +156,75 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
         type: Object,
       },
 
+      /**
+       * The SVG source to be loaded as the icon. It can be:
+       * - an URL to a file containing the icon
+       * - an URL in the format "/path/to/file.svg#objectID", where the "objectID" refers to an ID attribute contained
+       *   inside the SVG referenced by the path. Note that the file needs to follow the same-origin policy.
+       * - a string in the format "data:image/svg+xml,<svg>...</svg>". You may need to use the "encodeURIComponent"
+       *   function for the SVG content passed
+       *
+       * @type {string}
+       */
+      src: {
+        type: String,
+      },
+
+      /**
+       * The symbol identifier that references an ID of an element contained in the SVG element assigned to the
+       * `src` property
+       *
+       * @type {string}
+       */
+      symbol: {
+        type: String,
+      },
+
+      /**
+       * Class names defining an icon font and/or a specific glyph inside an icon font.
+       *
+       * Example: "fa-solid fa-user"
+       *
+       * @attr {string} icon-class
+       * @type {string}
+       */
+      iconClass: {
+        type: String,
+        reflectToAttribute: true,
+      },
+
+      /**
+       * A hexadecimal code point that specifies a glyph from an icon font.
+       *
+       * Example: "e001"
+       *
+       * @type {string}
+       */
+      char: {
+        type: String,
+      },
+
+      /**
+       * A ligature name that specifies an icon from an icon font with support for ligatures.
+       *
+       * Example: "home".
+       *
+       * @type {string}
+       */
+      ligature: {
+        type: String,
+      },
+
+      /**
+       * The font family to use for the font icon.
+       *
+       * @type {string}
+       */
+      fontFamily: {
+        type: String,
+        observer: '__fontFamilyChanged',
+      },
+
       /**
        * The size of an icon, used to set the `viewBox` attribute.
        */
@@ -139,7 +243,10 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
       __preserveAspectRatio: String,
 
       /** @private */
-      __svgElement: Object,
+      __useRef: Object,
+
+      /** @private */
+      __svgElement: String,
 
       /** @private */
       __viewBox: String,
@@ -147,13 +254,42 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
   }
 
   static get observers() {
-    return ['__svgChanged(svg, __svgElement)'];
+    return ['__svgChanged(svg, __svgElement)', '__fontChanged(iconClass, char, ligature)', '__srcChanged(src, symbol)'];
+  }
+
+  static get observedAttributes() {
+    return [...super.observedAttributes, 'class'];
+  }
+
+  constructor() {
+    super();
+
+    this.__fetch = fetch.bind(window);
+  }
+
+  /** @protected */
+  get slotStyles() {
+    const tag = this.localName;
+    return [
+      `
+        ${tag}[icon-class] {
+          display: inline-flex;
+          vertical-align: middle;
+          font-size: inherit;
+        }
+      `,
+    ];
+  }
+
+  /** @private */
+  get __iconClasses() {
+    return this.iconClass ? this.iconClass.split(' ') : [];
   }
 
   /** @protected */
   ready() {
     super.ready();
-    this.__svgElement = this.shadowRoot.querySelector('svg');
+    this.__svgElement = this.shadowRoot.querySelector('#svg-group');
 
     this._tooltipController = new TooltipController(this);
     this.addController(this._tooltipController);
@@ -201,6 +337,59 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
     }
   }
 
+  /** @private */
+  async __srcChanged(src, symbol) {
+    if (!src) {
+      this.svg = null;
+      return;
+    }
+
+    // Need to add the "icon" attribute to avoid issues as described in
+    // https://github.com/vaadin/web-components/issues/6301
+    this.icon = '';
+
+    if (!src.startsWith('data:') && (symbol || src.includes('#'))) {
+      const [path, iconId] = src.split('#');
+      this.__useRef = `${path}#${symbol || iconId}`;
+    } else {
+      try {
+        if (!srcCache.has(src)) {
+          srcCache.set(
+            src,
+            this.__fetch(src, { mode: 'cors' }).then((data) => {
+              if (!data.ok) {
+                throw new Error('Error loading icon');
+              }
+              return data.text();
+            }),
+          );
+        }
+        const svgData = await srcCache.get(src);
+
+        if (!Icon.__domParser) {
+          Icon.__domParser = new DOMParser();
+        }
+        const parsedResponse = Icon.__domParser.parseFromString(svgData, 'text/html');
+
+        const svgElement = parsedResponse.querySelector('svg');
+        if (!svgElement) {
+          throw new Error(`SVG element not found on path: ${src}`);
+        }
+
+        this.svg = unsafeSvgLiteral(svgElement.innerHTML);
+
+        if (symbol) {
+          this.__useRef = `#${symbol}`;
+        }
+
+        this.__viewBox = svgElement.getAttribute('viewBox');
+      } catch (e) {
+        console.error(e);
+        this.svg = null;
+      }
+    }
+  }
+
   /** @private */
   __svgChanged(svg, svgElement) {
     if (!svgElement) {
@@ -215,12 +404,55 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement)))
     return preserveAspectRatio || defaultPAR;
   }
 
+  /** @private */
+  __computeVisibility(__useRef) {
+    return __useRef ? 'visible' : 'hidden';
+  }
+
   /** @private */
   __computeViewBox(size, viewBox) {
     return viewBox || `0 0 ${size} ${size}`;
   }
+
+  /** @private */
+  __fontChanged(iconClass, char, ligature) {
+    this.classList.remove(...(this.__addedIconClasses || []));
+    if (iconClass) {
+      this.__addedIconClasses = [...this.__iconClasses];
+      this.classList.add(...this.__addedIconClasses);
+    }
+
+    if (char) {
+      this.setAttribute('font-icon-content', char.length > 1 ? String.fromCodePoint(parseInt(char, 16)) : char);
+    } else if (ligature) {
+      this.setAttribute('font-icon-content', ligature);
+    } else {
+      this.removeAttribute('font-icon-content');
+    }
+
+    if ((iconClass || char || ligature) && !this.icon) {
+      // The "icon" attribute needs to be set on the host also when using font icons
+      // to avoid issues such as https://github.com/vaadin/web-components/issues/6301
+      this.icon = '';
+    }
+  }
+
+  /** @protected */
+  attributeChangedCallback(name, oldValue, newValue) {
+    super.attributeChangedCallback(name, oldValue, newValue);
+
+    // Make sure class list always contains all the font class names
+    if (name === 'class' && this.__iconClasses.some((className) => !this.classList.contains(className))) {
+      this.classList.add(...this.__iconClasses);
+    }
+  }
+
+  /** @private */
+  __fontFamilyChanged(fontFamily) {
+    this.style.fontFamily = `'${fontFamily}'`;
+  }
 }
 
-customElements.define(Icon.is, Icon);
+defineCustomElement(Icon);
 
 export { Icon };

package/src/vaadin-iconset.js

@@ -4,6 +4,7 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { PolymerElement } from '@polymer/polymer/polymer-element.js';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
 import { cloneSvgNode } from './vaadin-icon-svg.js';
 
@@ -37,6 +38,7 @@ function initIconsMap(iconset, name) {
 /**
  * `<vaadin-iconset>` is a Web Component for creating SVG icon collections.
  *
+ * @customElement
  * @extends HTMLElement
  * @mixes ElementMixin
  */
@@ -184,6 +186,6 @@ class Iconset extends ElementMixin(PolymerElement) {
   }
 }
 
-customElements.define(Iconset.is, Iconset);
+defineCustomElement(Iconset);
 
 export { Iconset };

package/web-types.json

@@ -0,0 +1,194 @@
+{
+  "$schema": "https://json.schemastore.org/web-types",
+  "name": "@vaadin/icon",
+  "version": "24.3.0-alpha1",
+  "description-markup": "markdown",
+  "contributions": {
+    "html": {
+      "elements": [
+        {
+          "name": "vaadin-iconset",
+          "description": "`<vaadin-iconset>` is a Web Component for creating SVG icon collections.",
+          "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.3.0-alpha1/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
+              "value": {
+                "type": [
+                  "string",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
+            {
+              "name": "size",
+              "description": "The size of an individual icon. Note that icons must be square.\n\nWhen using `vaadin-icon`, the size of the iconset will take precedence\nover the size defined by the user to ensure correct appearance.",
+              "value": {
+                "type": [
+                  "number",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
+            {
+              "name": "theme",
+              "description": "The theme variants to apply to the component.",
+              "value": {
+                "type": [
+                  "string",
+                  "null",
+                  "undefined"
+                ]
+              }
+            }
+          ],
+          "js": {
+            "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.3.0-alpha1/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
+                "value": {
+                  "type": [
+                    "string",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
+              {
+                "name": "size",
+                "description": "The size of an individual icon. Note that icons must be square.\n\nWhen using `vaadin-icon`, the size of the iconset will take precedence\nover the size defined by the user to ensure correct appearance.",
+                "value": {
+                  "type": [
+                    "number",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              }
+            ],
+            "events": []
+          }
+        },
+        {
+          "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.3.0-alpha1/#/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.3.0-alpha1/#/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": "class",
+              "description": "",
+              "value": {
+                "type": [
+                  ""
+                ]
+              }
+            },
+            {
+              "name": "theme",
+              "description": "The theme variants to apply to the component.",
+              "value": {
+                "type": [
+                  "string",
+                  "null",
+                  "undefined"
+                ]
+              }
+            }
+          ],
+          "js": {
+            "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.3.0-alpha1/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
+                "value": {
+                  "type": [
+                    "string"
+                  ]
+                }
+              },
+              {
+                "name": "svg",
+                "description": "The SVG icon wrapped in a Lit template literal.",
+                "value": {
+                  "type": [
+                    "Object",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
+              {
+                "name": "src",
+                "description": "The SVG source to be loaded as the icon. It can be:\n- an URL to a file containing the icon\n- an URL in the format \"/path/to/file.svg#objectID\", where the \"objectID\" refers to an ID attribute contained\n  inside the SVG referenced by the path. Note that the file needs to follow the same-origin policy.\n- a string in the format \"data:image/svg+xml,<svg>...</svg>\". You may need to use the \"encodeURIComponent\"\n  function for the SVG content passed",
+                "value": {
+                  "type": [
+                    "string"
+                  ]
+                }
+              },
+              {
+                "name": "symbol",
+                "description": "The symbol identifier that references an ID of an element contained in the SVG element assigned to the\n`src` property",
+                "value": {
+                  "type": [
+                    "string"
+                  ]
+                }
+              },
+              {
+                "name": "iconClass",
+                "description": "Class names defining an icon font and/or a specific glyph inside an icon font.\n\nExample: \"fa-solid fa-user\"",
+                "value": {
+                  "type": [
+                    "string"
+                  ]
+                }
+              },
+              {
+                "name": "char",
+                "description": "A hexadecimal code point that specifies a glyph from an icon font.\n\nExample: \"e001\"",
+                "value": {
+                  "type": [
+                    "string"
+                  ]
+                }
+              },
+              {
+                "name": "ligature",
+                "description": "A ligature name that specifies an icon from an icon font with support for ligatures.\n\nExample: \"home\".",
+                "value": {
+                  "type": [
+                    "string"
+                  ]
+                }
+              },
+              {
+                "name": "fontFamily",
+                "description": "The font family to use for the font icon.",
+                "value": {
+                  "type": [
+                    "string"
+                  ]
+                }
+              },
+              {
+                "name": "size",
+                "description": "The size of an icon, used to set the `viewBox` attribute.",
+                "value": {
+                  "type": [
+                    "number",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              }
+            ],
+            "events": []
+          }
+        }
+      ]
+    }
+  }
+}

package/web-types.lit.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "https://json.schemastore.org/web-types",
+  "name": "@vaadin/icon",
+  "version": "24.3.0-alpha1",
+  "description-markup": "markdown",
+  "framework": "lit",
+  "framework-config": {
+    "enable-when": {
+      "node-packages": [
+        "lit"
+      ]
+    }
+  },
+  "contributions": {
+    "html": {
+      "elements": [
+        {
+          "name": "vaadin-iconset",
+          "description": "`<vaadin-iconset>` is a Web Component for creating SVG icon collections.",
+          "extension": true,
+          "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.3.0-alpha1/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".size",
+              "description": "The size of an individual icon. Note that icons must be square.\n\nWhen using `vaadin-icon`, the size of the iconset will take precedence\nover the size defined by the user to ensure correct appearance.",
+              "value": {
+                "kind": "expression"
+              }
+            }
+          ]
+        },
+        {
+          "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.3.0-alpha1/#/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.3.0-alpha1/#/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.3.0-alpha1/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".svg",
+              "description": "The SVG icon wrapped in a Lit template literal.",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".src",
+              "description": "The SVG source to be loaded as the icon. It can be:\n- an URL to a file containing the icon\n- an URL in the format \"/path/to/file.svg#objectID\", where the \"objectID\" refers to an ID attribute contained\n  inside the SVG referenced by the path. Note that the file needs to follow the same-origin policy.\n- a string in the format \"data:image/svg+xml,<svg>...</svg>\". You may need to use the \"encodeURIComponent\"\n  function for the SVG content passed",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".symbol",
+              "description": "The symbol identifier that references an ID of an element contained in the SVG element assigned to the\n`src` property",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".iconClass",
+              "description": "Class names defining an icon font and/or a specific glyph inside an icon font.\n\nExample: \"fa-solid fa-user\"",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".char",
+              "description": "A hexadecimal code point that specifies a glyph from an icon font.\n\nExample: \"e001\"",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".ligature",
+              "description": "A ligature name that specifies an icon from an icon font with support for ligatures.\n\nExample: \"home\".",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".fontFamily",
+              "description": "The font family to use for the font icon.",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".size",
+              "description": "The size of an icon, used to set the `viewBox` attribute.",
+              "value": {
+                "kind": "expression"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  }
+}