@momentum-design/components 0.0.28 → 0.0.29

package/dist/custom-elements.json

@@ -44,12 +44,12 @@
             },
             {
               "kind": "field",
-              "name": "scale",
+              "name": "size",
               "type": {
                 "text": "number | undefined"
               },
               "description": "Scale of the avatar",
-              "attribute": "scale"
+              "attribute": "size"
             },
             {
               "kind": "method",
@@ -85,12 +85,12 @@
               "fieldName": "src"
             },
             {
-              "name": "scale",
+              "name": "size",
               "type": {
                 "text": "number | undefined"
               },
               "description": "Scale of the avatar",
-              "fieldName": "scale"
+              "fieldName": "size"
             }
           ],
           "superclass": {
@@ -141,12 +141,12 @@
             },
             {
               "kind": "field",
-              "name": "scale",
+              "name": "size",
               "type": {
                 "text": "number | undefined"
               },
               "description": "Scale of the badge (works in combination with length unit)\n\nDefault: `1`",
-              "attribute": "scale"
+              "attribute": "size"
             },
             {
               "kind": "field",
@@ -203,12 +203,12 @@
               "fieldName": "type"
             },
             {
-              "name": "scale",
+              "name": "size",
               "type": {
                 "text": "number | undefined"
               },
               "description": "Scale of the badge (works in combination with length unit)\n\nDefault: `1`",
-              "fieldName": "scale"
+              "fieldName": "size"
             },
             {
               "name": "length-unit",
@@ -262,7 +262,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Icon component, which has to be mounted inside of a `IconProvider`\ncomponent.\n\nThe `IconProvider` component defines where icons should be consumed from (`url`).\nThis `Icon` component accepts the `name` attribute, which will be\nthe file name of the icon to be loaded from the given `url`.\n\nOnce fetched, the icon will be mounted. If fetching wasn't successful,\nnothing will be shown.\n\nThe `scale` attribute allows scaling the icon based on the provided\n`length-unit` attribute (which will either come from the IconProvider or\ncould be overridden per icon). For example:\nif `scale = 1` and `length-unit = 'em'`, the size of the icon will be\n`width: 1em; height: 1em`.\n\nFor accessibility the `role` and `aria-label` of the icon can be set.",
+          "description": "Icon component, which has to be mounted inside of a `IconProvider`\ncomponent.\n\nThe `IconProvider` component defines where icons should be consumed from (`url`).\nThis `Icon` component accepts the `name` attribute, which will be\nthe file name of the icon to be loaded from the given `url`.\n\nOnce fetched, the icon will be mounted. If fetching wasn't successful,\nnothing will be shown.\n\nThe `size` attribute allows sizing the icon based on the provided\n`length-unit` attribute (which will either come from the IconProvider or\ncould be overridden per icon). For example:\nif `size = 1` and `length-unit = 'em'`, the size of the icon will be\n`width: 1em; height: 1em`.\n\nFor accessibility the `role` and `aria-label` of the icon can be set.",
           "name": "Icon",
           "members": [
             {
@@ -281,6 +281,14 @@
               },
               "privacy": "private"
             },
+            {
+              "kind": "field",
+              "name": "sizeFromContext",
+              "type": {
+                "text": "number | undefined"
+              },
+              "privacy": "private"
+            },
             {
               "kind": "field",
               "name": "name",
@@ -293,12 +301,12 @@
             },
             {
               "kind": "field",
-              "name": "scale",
+              "name": "size",
               "type": {
                 "text": "number | undefined"
               },
-              "description": "Scale of the icon (works in combination with length unit)",
-              "attribute": "scale"
+              "description": "Size of the icon (works in combination with length unit)",
+              "attribute": "size"
             },
             {
               "kind": "field",
@@ -306,7 +314,7 @@
               "type": {
                 "text": "string | undefined"
               },
-              "description": "Length unit attribute for overridding length-unit from `IconProvider`",
+              "description": "Length unit attribute for overriding length-unit from `IconProvider`",
               "attribute": "length-unit"
             },
             {
@@ -332,7 +340,8 @@
             {
               "kind": "field",
               "name": "iconProviderContext",
-              "privacy": "private"
+              "privacy": "private",
+              "readonly": true
             },
             {
               "kind": "method",
@@ -355,6 +364,12 @@
               "kind": "method",
               "name": "setAriaLabelOnIcon",
               "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "computedIconSize",
+              "privacy": "private",
+              "readonly": true
             }
           ],
           "attributes": [
@@ -367,19 +382,19 @@
               "fieldName": "name"
             },
             {
-              "name": "scale",
+              "name": "size",
               "type": {
                 "text": "number | undefined"
               },
-              "description": "Scale of the icon (works in combination with length unit)",
-              "fieldName": "scale"
+              "description": "Size of the icon (works in combination with length unit)",
+              "fieldName": "size"
             },
             {
               "name": "length-unit",
               "type": {
                 "text": "string | undefined"
               },
-              "description": "Length unit attribute for overridding length-unit from `IconProvider`",
+              "description": "Length unit attribute for overriding length-unit from `IconProvider`",
               "fieldName": "lengthUnit"
             },
             {
@@ -406,7 +421,7 @@
             "module": "/src/models"
           },
           "tagName": "mdc-icon",
-          "jsDoc": "/**\n * Icon component, which has to be mounted inside of a `IconProvider`\n * component.\n *\n * The `IconProvider` component defines where icons should be consumed from (`url`).\n * This `Icon` component accepts the `name` attribute, which will be\n * the file name of the icon to be loaded from the given `url`.\n *\n * Once fetched, the icon will be mounted. If fetching wasn't successful,\n * nothing will be shown.\n *\n * The `scale` attribute allows scaling the icon based on the provided\n * `length-unit` attribute (which will either come from the IconProvider or\n * could be overridden per icon). For example:\n * if `scale = 1` and `length-unit = 'em'`, the size of the icon will be\n * `width: 1em; height: 1em`.\n *\n * For accessibility the `role` and `aria-label` of the icon can be set.\n *\n * @tag mdc-icon\n * @tagname mdc-icon\n */",
+          "jsDoc": "/**\n * Icon component, which has to be mounted inside of a `IconProvider`\n * component.\n *\n * The `IconProvider` component defines where icons should be consumed from (`url`).\n * This `Icon` component accepts the `name` attribute, which will be\n * the file name of the icon to be loaded from the given `url`.\n *\n * Once fetched, the icon will be mounted. If fetching wasn't successful,\n * nothing will be shown.\n *\n * The `size` attribute allows sizing the icon based on the provided\n * `length-unit` attribute (which will either come from the IconProvider or\n * could be overridden per icon). For example:\n * if `size = 1` and `length-unit = 'em'`, the size of the icon will be\n * `width: 1em; height: 1em`.\n *\n * For accessibility the `role` and `aria-label` of the icon can be set.\n *\n * @tag mdc-icon\n * @tagname mdc-icon\n */",
           "customElement": true
         }
       ],
@@ -460,12 +475,23 @@
               "kind": "field",
               "name": "lengthUnit",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
               "description": "Length unit used for sizing of icons, default: 'em'",
               "attribute": "length-unit",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "size",
+              "type": {
+                "text": "number | undefined"
+              },
+              "default": "DEFAULTS.LENGTH_UNIT_SIZE[DEFAULTS.LENGTH_UNIT]",
+              "description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
+              "attribute": "size",
+              "reflects": true
+            },
             {
               "kind": "method",
               "name": "updateValuesInContext",
@@ -502,10 +528,19 @@
             {
               "name": "length-unit",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
               "description": "Length unit used for sizing of icons, default: 'em'",
               "fieldName": "lengthUnit"
+            },
+            {
+              "name": "size",
+              "type": {
+                "text": "number | undefined"
+              },
+              "default": "DEFAULTS.LENGTH_UNIT_SIZE[DEFAULTS.LENGTH_UNIT]",
+              "description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
+              "fieldName": "size"
             }
           ],
           "superclass": {

package/dist/react/icon/index.d.ts

@@ -10,10 +10,10 @@ import Component from '../../components/icon';
  * Once fetched, the icon will be mounted. If fetching wasn't successful,
  * nothing will be shown.
  *
- * The `scale` attribute allows scaling the icon based on the provided
+ * The `size` attribute allows sizing the icon based on the provided
  * `length-unit` attribute (which will either come from the IconProvider or
  * could be overridden per icon). For example:
- * if `scale = 1` and `length-unit = 'em'`, the size of the icon will be
+ * if `size = 1` and `length-unit = 'em'`, the size of the icon will be
  * `width: 1em; height: 1em`.
  *
  * For accessibility the `role` and `aria-label` of the icon can be set.

package/dist/react/icon/index.js

@@ -16,10 +16,10 @@ const icon_constants_1 = require("../../components/icon/icon.constants");
  * Once fetched, the icon will be mounted. If fetching wasn't successful,
  * nothing will be shown.
  *
- * The `scale` attribute allows scaling the icon based on the provided
+ * The `size` attribute allows sizing the icon based on the provided
  * `length-unit` attribute (which will either come from the IconProvider or
  * could be overridden per icon). For example:
- * if `scale = 1` and `length-unit = 'em'`, the size of the icon will be
+ * if `size = 1` and `length-unit = 'em'`, the size of the icon will be
  * `width: 1em; height: 1em`.
  *
  * For accessibility the `role` and `aria-label` of the icon can be set.

package/package.json

@@ -31,5 +31,5 @@
     "@momentum-design/icons": "*",
     "@momentum-design/tokens": "*"
   },
-  "version": "0.0.28"
+  "version": "0.0.29"
 }