@vaadin/icon 24.2.0-alpha14 → 24.2.0-alpha15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/icon",
-  "version": "24.2.0-alpha14",
+  "version": "24.2.0-alpha15",
   "publishConfig": {
     "access": "public"
   },
@@ -35,9 +35,9 @@
   ],
   "dependencies": {
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "24.2.0-alpha14",
-    "@vaadin/vaadin-lumo-styles": "24.2.0-alpha14",
-    "@vaadin/vaadin-themable-mixin": "24.2.0-alpha14",
+    "@vaadin/component-base": "24.2.0-alpha15",
+    "@vaadin/vaadin-lumo-styles": "24.2.0-alpha15",
+    "@vaadin/vaadin-themable-mixin": "24.2.0-alpha15",
     "lit": "^2.0.0"
   },
   "devDependencies": {
@@ -49,5 +49,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "203a2fda8d879db6ee8bccd7cf5b915de3e5008b"
+  "gitHead": "043dbb1c2513685a98354921876d35fa18bca7a2"
 }

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

@@ -34,7 +34,7 @@ export const IconFontSizeMixin = dedupingMixin((superclass) =>
     ? superclass
     : class extends ResizeMixin(superclass) {
         static get observers() {
-          return ['__iconFontSizeMixinfontChanged(font, char)'];
+          return ['__iconFontSizeMixinfontChanged(font, char, ligature)'];
         }
 
         /** @protected */
@@ -46,7 +46,7 @@ export const IconFontSizeMixin = dedupingMixin((superclass) =>
         }
 
         /** @private */
-        __iconFontSizeMixinfontChanged(font, char) {
+        __iconFontSizeMixinfontChanged(_font, _char, _ligature) {
           // Update when font or char changes
           this.__updateFontIconSize();
         }
@@ -66,7 +66,7 @@ export const IconFontSizeMixin = dedupingMixin((superclass) =>
          * @private
          */
         __updateFontIconSize() {
-          if (this.char || this.font) {
+          if (this.char || this.font || 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.d.ts

@@ -89,13 +89,19 @@ declare class Icon extends ThemableMixin(
   font: string | null;
 
   /**
-   * The specific glyph from a font to use as an icon.
-   * Can be a code point or a ligature name.
+   * A hexadecimal code point that specifies a glyph from an icon font.
    *
-   * @attr {string} char
+   * 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.
    */

package/src/vaadin-icon.js

@@ -92,12 +92,12 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(SlotStylesMixin(Ic
           height: 100%;
         }
 
-        :host(:is([font], [char])) svg {
+        :host(:is([font], [font-icon-content])) svg {
           display: none;
         }
 
-        :host([char])::before {
-          content: attr(char);
+        :host([font-icon-content])::before {
+          content: attr(font-icon-content);
         }
       </style>
       <svg
@@ -169,15 +169,25 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(SlotStylesMixin(Ic
       },
 
       /**
-       * The specific glyph from a font to use as an icon.
-       * Can be a code point or a ligature name.
+       * A hexadecimal code point that specifies a glyph from an icon font.
+       *
+       * Example: "e001"
        *
-       * @attr {string} char
        * @type {string}
        */
       char: {
         type: String,
-        reflectToAttribute: true,
+      },
+
+      /**
+       * A ligature name that specifies an icon from an icon font with support for ligatures.
+       *
+       * Example: "home".
+       *
+       * @type {string}
+       */
+      ligature: {
+        type: String,
       },
 
       /**
@@ -216,7 +226,11 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(SlotStylesMixin(Ic
   }
 
   static get observers() {
-    return ['__svgChanged(svg, __svgElement)', '__fontChanged(font, char)', '__srcChanged(src)'];
+    return ['__svgChanged(svg, __svgElement)', '__fontChanged(font, char, ligature)', '__srcChanged(src)'];
+  }
+
+  static get observedAttributes() {
+    return [...super.observedAttributes, 'class'];
   }
 
   constructor() {
@@ -239,6 +253,11 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(SlotStylesMixin(Ic
     ];
   }
 
+  /** @private */
+  get __fontClasses() {
+    return this.font ? this.font.split(' ') : [];
+  }
+
   /** @protected */
   ready() {
     super.ready();
@@ -351,23 +370,41 @@ class Icon extends ThemableMixin(ElementMixin(ControllerMixin(SlotStylesMixin(Ic
   }
 
   /** @private */
-  __fontChanged(font, char) {
+  __fontChanged(font, char, ligature) {
     this.classList.remove(...(this.__addedFontClasses || []));
     if (font) {
-      this.__addedFontClasses = font.split(' ');
+      this.__addedFontClasses = [...this.__fontClasses];
       this.classList.add(...this.__addedFontClasses);
     }
 
-    if ((font || char) && !this.icon) {
+    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 ((font || 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.__fontClasses.some((className) => !this.classList.contains(className))) {
+      this.classList.add(...this.__fontClasses);
+    }
+  }
+
   /** @private */
   __fontFamilyChanged(fontFamily) {
-    this.style.fontFamily = fontFamily;
+    this.style.fontFamily = `'${fontFamily}'`;
   }
 }
 

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/icon",
-  "version": "24.2.0-alpha14",
+  "version": "24.2.0-alpha15",
   "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.2.0-alpha14/#/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.2.0-alpha15/#/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.2.0-alpha14/#/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.2.0-alpha15/#/elements/vaadin-icon#property-name) property of `vaadin-icon`.",
                 "value": {
                   "type": [
                     "string",
@@ -74,63 +74,14 @@
         },
         {
           "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.2.0-alpha14/#/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.2.0-alpha14/#/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.2.0-alpha15/#/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.2.0-alpha15/#/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.2.0-alpha14/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
+              "name": "class",
+              "description": "",
               "value": {
                 "type": [
-                  "string"
-                ]
-              }
-            },
-            {
-              "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",
-                  "null",
-                  "undefined"
-                ]
-              }
-            },
-            {
-              "name": "font",
-              "description": "Class names defining an icon font and/or a specific glyph inside an icon font.",
-              "value": {
-                "type": [
-                  "string"
-                ]
-              }
-            },
-            {
-              "name": "char",
-              "description": "The specific glyph from a font to use as an icon.\nCan be a code point or a ligature name.",
-              "value": {
-                "type": [
-                  "string"
-                ]
-              }
-            },
-            {
-              "name": "font-family",
-              "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"
+                  ""
                 ]
               }
             },
@@ -150,7 +101,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.2.0-alpha14/#/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.2.0-alpha15/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
                 "value": {
                   "type": [
                     "string"
@@ -190,7 +141,16 @@
               },
               {
                 "name": "char",
-                "description": "The specific glyph from a font to use as an icon.\nCan be a code point or a ligature name.",
+                "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"

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/icon",
-  "version": "24.2.0-alpha14",
+  "version": "24.2.0-alpha15",
   "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.2.0-alpha14/#/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.2.0-alpha15/#/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.2.0-alpha14/#/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.2.0-alpha14/#/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.2.0-alpha15/#/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.2.0-alpha15/#/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.2.0-alpha14/#/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.2.0-alpha15/#/elements/vaadin-iconset#property-name) property of `vaadin-iconset`.",
               "value": {
                 "kind": "expression"
               }
@@ -70,7 +70,14 @@
             },
             {
               "name": ".char",
-              "description": "The specific glyph from a font to use as an icon.\nCan be a code point or a ligature name.",
+              "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"
               }