@m3e/core 1.0.0-rc.1 → 1.0.0-rc.2

package/dist/html-custom-data.json

@@ -28,7 +28,7 @@
     },
     {
       "name": "m3e-elevation",
-      "description": "Visually depicts elevation using a shadow.\n---\n\n\n### **CSS Properties:**\n - **--m3e-elevation-color** - Color used to depict elevation. _(default: undefined)_\n- **--m3e-elevation-lift-duration** - Duration when lifting. _(default: undefined)_\n- **--m3e-elevation-lift-easing** - Easing curve when lifting. _(default: undefined)_\n- **--m3e-elevation-settle-duration** - Duration when settling. _(default: undefined)_\n- **--m3e-elevation-settle-easing** - Easing curve when settling. _(default: undefined)_\n- **--m3e-elevation-level** - Elevation when resting (box-shadow). _(default: undefined)_\n- **--m3e-elevation-hover-level** - Elevation on hover (box-shadow). _(default: undefined)_\n- **--m3e-elevation-focus-level** - Elevation on focus (box-shadow). _(default: undefined)_\n- **--m3e-elevation-pressed-level** - Elevation on pressed (box-shadow). _(default: undefined)_",
+      "description": "Visually depicts elevation using a shadow.\n---\n\n\n### **Methods:**\n - **attach(control: _HTMLElement_): _void_** - Attaches the element to an interactive control.\n- **detach(): _void_** - Detaches the element from its current interactive control.\n\n### **CSS Properties:**\n - **--m3e-elevation-color** - Color used to depict elevation. _(default: undefined)_\n- **--m3e-elevation-lift-duration** - Duration when lifting. _(default: undefined)_\n- **--m3e-elevation-lift-easing** - Easing curve when lifting. _(default: undefined)_\n- **--m3e-elevation-settle-duration** - Duration when settling. _(default: undefined)_\n- **--m3e-elevation-settle-easing** - Easing curve when settling. _(default: undefined)_\n- **--m3e-elevation-level** - Elevation when resting (box-shadow). _(default: undefined)_\n- **--m3e-elevation-hover-level** - Elevation on hover (box-shadow). _(default: undefined)_\n- **--m3e-elevation-focus-level** - Elevation on focus (box-shadow). _(default: undefined)_\n- **--m3e-elevation-pressed-level** - Elevation on pressed (box-shadow). _(default: undefined)_",
       "attributes": [
         {
           "name": "disabled",
@@ -50,7 +50,7 @@
     },
     {
       "name": "m3e-focus-ring",
-      "description": "A focus ring used to depict a strong focus indicator.\n---\n\n\n### **Methods:**\n - **show(): _void_** - Launches a manual focus ring.\n- **hide(): _void_** - Hides the focus ring.\n\n### **CSS Properties:**\n - **--m3e-focus-ring-color** - The color of the focus ring. _(default: undefined)_\n- **--m3e-focus-ring-duration** - The duration of the focus ring animation. _(default: undefined)_\n- **--m3e-focus-ring-growth-factor** - The factor by which the focus ring grows. _(default: undefined)_\n- **--m3e-focus-ring-thickness** - The thickness of the focus ring. _(default: undefined)_\n- **--m3e-focus-ring-visibility** - The visibility of the focus ring. _(default: undefined)_",
+      "description": "A focus ring used to depict a strong focus indicator.\n---\n\n\n### **Methods:**\n - **show(): _void_** - Launches a manual focus ring.\n- **hide(): _void_** - Hides the focus ring.\n- **attach(control: _HTMLElement_): _void_** - Attaches the element to an interactive control.\n- **detach(): _void_** - Detaches the element from its current interactive control.\n\n### **CSS Properties:**\n - **--m3e-focus-ring-color** - The color of the focus ring. _(default: undefined)_\n- **--m3e-focus-ring-duration** - The duration of the focus ring animation. _(default: undefined)_\n- **--m3e-focus-ring-growth-factor** - The factor by which the focus ring grows. _(default: undefined)_\n- **--m3e-focus-ring-thickness** - The thickness of the focus ring. _(default: undefined)_\n- **--m3e-focus-ring-visibility** - The visibility of the focus ring. _(default: undefined)_",
       "attributes": [
         {
           "name": "disabled",
@@ -62,7 +62,11 @@
           "description": "Whether the focus ring animates inward instead of outward.",
           "values": []
         },
-        { "name": "for", "values": [] }
+        {
+          "name": "for",
+          "description": "The identifier of the interactive control to which this element is attached.",
+          "values": []
+        }
       ],
       "references": []
     },
@@ -107,7 +111,7 @@
     },
     {
       "name": "m3e-ripple",
-      "description": "Connects user input to screen reactions using ripples.\n---\n\n\n### **Methods:**\n - **show(x: _number_, y: _number_, persistent: _boolean_): _void_** - Launches a manual ripple.\n- **hide(): _void_** - Manually hides the ripple.\n\n### **CSS Properties:**\n - **--m3e-ripple-color** - The color of the ripple. _(default: undefined)_\n- **--m3e-ripple-enter-duration** - The duration for the enter animation (expansion from point of contact). _(default: undefined)_\n- **--m3e-ripple-exit-duration** - The duration for the exit animation (fade-out). _(default: undefined)_\n- **--m3e-ripple-opacity** - The opacity of the ripple. _(default: undefined)_\n- **--m3e-ripple-scale-factor** - The factor by which to scale the ripple. _(default: undefined)_\n- **--m3e-ripple-shape** - The shape of the ripple. _(default: undefined)_",
+      "description": "Connects user input to screen reactions using ripples.\n---\n\n\n### **Methods:**\n - **show(x: _number_, y: _number_, persistent: _boolean_): _void_** - Launches a manual ripple.\n- **hide(): _void_** - Manually hides the ripple.\n- **attach(control: _HTMLElement_): _void_** - Attaches the element to an interactive control.\n- **detach(): _void_** - Detaches the element from its current interactive control.\n\n### **CSS Properties:**\n - **--m3e-ripple-color** - The color of the ripple. _(default: undefined)_\n- **--m3e-ripple-enter-duration** - The duration for the enter animation (expansion from point of contact). _(default: undefined)_\n- **--m3e-ripple-exit-duration** - The duration for the exit animation (fade-out). _(default: undefined)_\n- **--m3e-ripple-opacity** - The opacity of the ripple. _(default: undefined)_\n- **--m3e-ripple-scale-factor** - The factor by which to scale the ripple. _(default: undefined)_\n- **--m3e-ripple-shape** - The shape of the ripple. _(default: undefined)_",
       "attributes": [
         {
           "name": "centered",
@@ -178,14 +182,18 @@
     },
     {
       "name": "m3e-state-layer",
-      "description": "Provides focus and hover state layer treatment for an interactive element.\n---\n\n\n### **Methods:**\n - **show(state: _\"hover\" | \"focused\"_): _void_** - Launches a manual state layer.\n- **hide(state: _\"hover\" | \"focused\"_): _void_** - Hides the state layer.\n\n### **CSS Properties:**\n - **--m3e-state-layer-duration** - Duration of state layer changes. _(default: undefined)_\n- **--m3e-state-layer-easing** - Easing curve of state layer changes. _(default: undefined)_\n- **--m3e-state-layer-focus-color** - Color on hover. _(default: undefined)_\n- **--m3e-state-layer-focus-opacity** - Opacity on focus. _(default: undefined)_\n- **--m3e-state-layer-hover-color** - Color on hover. _(default: undefined)_\n- **--m3e-state-layer-hover-opacity** - Opacity on hover. _(default: undefined)_",
+      "description": "Provides focus and hover state layer treatment for an interactive element.\n---\n\n\n### **Methods:**\n - **show(state: _\"hover\" | \"focused\"_): _void_** - Launches a manual state layer.\n- **hide(state: _\"hover\" | \"focused\"_): _void_** - Hides the state layer.\n- **attach(control: _HTMLElement_): _void_** - Attaches the element to an interactive control.\n- **detach(): _void_** - Detaches the element from its current interactive control.\n\n### **CSS Properties:**\n - **--m3e-state-layer-duration** - Duration of state layer changes. _(default: undefined)_\n- **--m3e-state-layer-easing** - Easing curve of state layer changes. _(default: undefined)_\n- **--m3e-state-layer-focus-color** - Color on hover. _(default: undefined)_\n- **--m3e-state-layer-focus-opacity** - Opacity on focus. _(default: undefined)_\n- **--m3e-state-layer-hover-color** - Color on hover. _(default: undefined)_\n- **--m3e-state-layer-hover-opacity** - Opacity on hover. _(default: undefined)_",
       "attributes": [
         {
           "name": "disabled",
           "description": "Whether hover and focus event will not trigger the state layer. State layers can still\r\nbe controlled manually using the `show` and `hide` methods.",
           "values": []
         },
-        { "name": "for", "values": [] }
+        {
+          "name": "for",
+          "description": "The identifier of the interactive control to which this element is attached.",
+          "values": []
+        }
       ],
       "references": []
     },