@m3e/radio-group 1.0.0-rc.2 → 1.0.0-rc.4

package/dist/custom-elements.json

@@ -77,6 +77,22 @@
             {
               "description": "Icon color when radio is disabled.",
               "name": "--m3e-radio-disabled-icon-color"
+            },
+            {
+              "description": "Fallback hover color used when the radio is invalid and touched.",
+              "name": "--m3e-radio-error-hover-color"
+            },
+            {
+              "description": "Fallback focus color used when the radio is invalid and touched.",
+              "name": "--m3e-radio-error-focus-color"
+            },
+            {
+              "description": "Fallback ripple color used when the radio is invalid and touched.",
+              "name": "--m3e-radio-error-ripple-color"
+            },
+            {
+              "description": "Fallback icon color used when the radio is invalid and touched.",
+              "name": "--m3e-radio-error-icon-color"
             }
           ],
           "members": [
@@ -165,14 +181,52 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "#notifySelectionChange",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "formAssociated",
+              "static": true,
+              "readonly": true,
+              "default": "true",
+              "description": "Indicates that this custom element participates in form submission, validation, and form state restoration.",
+              "type": {
+                "text": "boolean"
+              },
+              "inheritedFrom": {
+                "name": "AttachInternals",
+                "module": "../core/src/shared/mixins/AttachInternals.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "[_eventHandler]",
               "privacy": "private",
               "readonly": true,
               "inheritedFrom": {
-                "name": "Labelled",
-                "module": "../core/src/shared/mixins/Labelled.ts"
+                "name": "Touched",
+                "module": "../core/src/shared/mixins/Touched.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "labels",
+              "type": {
+                "text": "NodeListOf<HTMLLabelElement>"
+              },
+              "readonly": true,
+              "description": "The label elements that the element is associated with.",
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
               }
             },
             {
@@ -298,48 +352,6 @@
                 "module": "../core/src/shared/mixins/Checked.ts"
               }
             },
-            {
-              "kind": "field",
-              "name": "formAssociated",
-              "static": true,
-              "readonly": true,
-              "default": "true",
-              "description": "Indicates that this custom element participates in form submission, validation, and form state restoration.",
-              "type": {
-                "text": "boolean"
-              },
-              "inheritedFrom": {
-                "name": "AttachInternals",
-                "module": "../core/src/shared/mixins/AttachInternals.ts"
-              }
-            },
-            {
-              "kind": "field",
-              "name": "labels",
-              "type": {
-                "text": "NodeListOf<HTMLLabelElement>"
-              },
-              "description": "The label elements that the element is associated with.",
-              "readonly": true,
-              "inheritedFrom": {
-                "name": "Labelled",
-                "module": "../core/src/shared/mixins/Labelled.ts"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "[_updateLabels]",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "inheritedFrom": {
-                "name": "Labelled",
-                "module": "../core/src/shared/mixins/Labelled.ts"
-              }
-            },
             {
               "kind": "field",
               "name": "#keyUpHandler",
@@ -385,6 +397,67 @@
                 "module": "../core/src/shared/mixins/Focusable.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "[_defaultValue]",
+              "type": {
+                "text": "unknown"
+              },
+              "privacy": "private",
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "[_defaultIndeterminate]",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "[_formDisabled]",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "form",
+              "type": {
+                "text": "HTMLFormElement | null"
+              },
+              "description": "The `HTMLFormElement` associated with this element.",
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "name",
+              "description": "The name that identifies the element when submitting the associated form.",
+              "attribute": "name",
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "disabled",
@@ -399,6 +472,42 @@
                 "module": "../core/src/shared/mixins/Disabled.ts"
               }
             },
+            {
+              "kind": "method",
+              "name": "formDisabledCallback",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "disabled",
+                  "type": {
+                    "text": "boolean"
+                  }
+                }
+              ],
+              "description": "Called when the element is disabled or enabled via its form association.",
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "formResetCallback",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Called when the associated form is reset.",
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "[_internals]",
@@ -466,6 +575,19 @@
                 "module": "../core/src/shared/mixins/Disabled.ts"
               }
             },
+            {
+              "name": "name",
+              "description": "The name that identifies the element when submitting the associated form.",
+              "fieldName": "name",
+              "inheritedFrom": {
+                "name": "FormAssociated",
+                "module": "../core/src/shared/mixins/FormAssociated.ts"
+              }
+            },
+            {
+              "description": "Whether the element is required.",
+              "name": "required"
+            },
             {
               "description": "A string representing the value of the radio.",
               "name": "value",
@@ -477,6 +599,10 @@
             }
           ],
           "mixins": [
+            {
+              "name": "Labelled",
+              "package": "@m3e/core"
+            },
             {
               "name": "Dirty",
               "package": "@m3e/core"
@@ -490,15 +616,15 @@
               "package": "@m3e/core"
             },
             {
-              "name": "Labelled",
+              "name": "KeyboardClick",
               "package": "@m3e/core"
             },
             {
-              "name": "KeyboardClick",
+              "name": "Focusable",
               "package": "@m3e/core"
             },
             {
-              "name": "Focusable",
+              "name": "FormAssociated",
               "package": "@m3e/core"
             },
             {
@@ -547,26 +673,8 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "A container for a set of radio buttons that enforces single selection.",
+          "description": "A container for a set of radio buttons.",
           "name": "M3eRadioGroupElement",
-          "cssProperties": [
-            {
-              "description": "Fallback hover color used when the radio is invalid and touched.",
-              "name": "--m3e-radio-error-hover-color"
-            },
-            {
-              "description": "Fallback focus color used when the radio is invalid and touched.",
-              "name": "--m3e-radio-error-focus-color"
-            },
-            {
-              "description": "Fallback ripple color used when the radio is invalid and touched.",
-              "name": "--m3e-radio-error-ripple-color"
-            },
-            {
-              "description": "Fallback icon color used when the radio is invalid and touched.",
-              "name": "--m3e-radio-error-icon-color"
-            }
-          ],
           "slots": [
             {
               "description": "Renders the radio buttons of the group.",
@@ -586,7 +694,7 @@
               "type": {
                 "text": "readonly M3eRadioElement[]"
               },
-              "description": "The radio buttons in the group.",
+              "description": "The radios in the group.",
               "readonly": true
             },
             {
@@ -607,6 +715,62 @@
               "description": "The selected value of the radio group.",
               "readonly": true
             },
+            {
+              "kind": "method",
+              "name": "markAsTouched",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Marks the element as touched.",
+              "inheritedFrom": {
+                "name": "Touched",
+                "module": "../core/src/shared/mixins/Touched.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "markAsUntouched",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Marks the element as untouched.",
+              "inheritedFrom": {
+                "name": "Touched",
+                "module": "../core/src/shared/mixins/Touched.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "markAsDirty",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Marks the element as dirty.",
+              "inheritedFrom": {
+                "name": "Dirty",
+                "module": "../core/src/shared/mixins/Dirty.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "markAsPristine",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Marks the element as pristine.",
+              "inheritedFrom": {
+                "name": "Dirty",
+                "module": "../core/src/shared/mixins/Dirty.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "#handleSlotChange",
@@ -638,15 +802,7 @@
                 "type": {
                   "text": "void"
                 }
-              },
-              "parameters": [
-                {
-                  "name": "e",
-                  "type": {
-                    "text": "Event"
-                  }
-                }
-              ]
+              }
             },
             {
               "kind": "field",
@@ -686,20 +842,6 @@
                 "module": "../core/src/shared/mixins/FormAssociated.ts"
               }
             },
-            {
-              "kind": "method",
-              "name": "[_updateLabels]",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "inheritedFrom": {
-                "name": "Labelled",
-                "module": "../core/src/shared/mixins/Labelled.ts"
-              }
-            },
             {
               "kind": "field",
               "name": "dirty",
@@ -726,34 +868,6 @@
                 "module": "../core/src/shared/mixins/Dirty.ts"
               }
             },
-            {
-              "kind": "method",
-              "name": "markAsPristine",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "description": "Marks the element as pristine.",
-              "inheritedFrom": {
-                "name": "Dirty",
-                "module": "../core/src/shared/mixins/Dirty.ts"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "markAsDirty",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "description": "Marks the element as dirty.",
-              "inheritedFrom": {
-                "name": "Dirty",
-                "module": "../core/src/shared/mixins/Dirty.ts"
-              }
-            },
             {
               "kind": "field",
               "name": "touched",
@@ -780,34 +894,6 @@
                 "module": "../core/src/shared/mixins/Touched.ts"
               }
             },
-            {
-              "kind": "method",
-              "name": "markAsTouched",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "description": "Marks the element as touched.",
-              "inheritedFrom": {
-                "name": "Touched",
-                "module": "../core/src/shared/mixins/Touched.ts"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "markAsUntouched",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "description": "Marks the element as untouched.",
-              "inheritedFrom": {
-                "name": "Touched",
-                "module": "../core/src/shared/mixins/Touched.ts"
-              }
-            },
             {
               "kind": "field",
               "name": "required",
@@ -1097,14 +1183,14 @@
           ],
           "events": [
             {
-              "name": "change",
-              "type": {
-                "text": "Event"
-              },
-              "description": "Emitted when the checked state of a radio button changes."
+              "description": "Emitted when the checked state of a radio button changes.",
+              "name": "change"
             }
           ],
           "attributes": [
+            {
+              "name": "aria-invalid"
+            },
             {
               "name": "disabled",
               "type": {
@@ -2064,25 +2150,6 @@
           "kind": "mixin",
           "description": "Mixin that adds support for custom event attributes.",
           "name": "EventAttribute",
-          "members": [
-            {
-              "kind": "method",
-              "name": "dispatchEvent",
-              "return": {
-                "type": {
-                  "text": "boolean"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "event",
-                  "type": {
-                    "text": "Event"
-                  }
-                }
-              ]
-            }
-          ],
           "parameters": [
             {
               "name": "base",
@@ -2380,6 +2447,17 @@
           "description": "Mixin to augment an element with behavior used to submit a form.",
           "name": "FormSubmitter",
           "members": [
+            {
+              "kind": "field",
+              "name": "formAssociated",
+              "type": {
+                "text": "boolean"
+              },
+              "static": true,
+              "readonly": true,
+              "default": "true",
+              "description": "Indicates that this custom element participates in form submission, validation, and form state restoration."
+            },
             {
               "kind": "field",
               "name": "name",
@@ -2916,6 +2994,11 @@
       "kind": "javascript-module",
       "path": "../core/src/shared/mixins/Labelled.ts",
       "declarations": [
+        {
+          "kind": "variable",
+          "name": "updateLabels",
+          "description": "A symbol through which to update labels to reflect a control's current state."
+        },
         {
           "kind": "function",
           "name": "isLabelledMixin",
@@ -2965,16 +3048,6 @@
               },
               "description": "The label elements that the element is associated with.",
               "readonly": true
-            },
-            {
-              "kind": "method",
-              "name": "[_updateLabels]",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              }
             }
           ],
           "parameters": [
@@ -2989,6 +3062,14 @@
         }
       ],
       "exports": [
+        {
+          "kind": "js",
+          "name": "updateLabels",
+          "declaration": {
+            "name": "updateLabels",
+            "module": "../core/src/shared/mixins/Labelled.ts"
+          }
+        },
         {
           "kind": "js",
           "name": "isLabelledMixin",

package/dist/html-custom-data.json

@@ -4,7 +4,7 @@
   "tags": [
     {
       "name": "m3e-radio",
-      "description": "A radio button that allows a user to select one option from a set of options.\n---\n\n\n### **Events:**\n - **input** - Emitted when the checked state changes.\n- **change** - Emitted when the checked state changes.\n- **click** - Emitted when the element is clicked.\n\n### **Methods:**\n - **markAsPristine(): _void_** - Marks the element as pristine.\n- **markAsDirty(): _void_** - Marks the element as dirty.\n- **markAsTouched(): _void_** - Marks the element as touched.\n- **markAsUntouched(): _void_** - Marks the element as untouched.\n\n### **CSS Properties:**\n - **--m3e-radio-container-size** - Base size of the radio button container. _(default: undefined)_\n- **--m3e-radio-icon-size** - Size of the radio icon inside the wrapper. _(default: undefined)_\n- **--m3e-radio-unselected-hover-color** - Hover state layer color when radio is not selected. _(default: undefined)_\n- **--m3e-radio-unselected-focus-color** - Focus state layer color when radio is not selected. _(default: undefined)_\n- **--m3e-radio-unselected-ripple-color** - Ripple color when radio is not selected. _(default: undefined)_\n- **--m3e-radio-unselected-icon-color** - Icon color when radio is not selected. _(default: undefined)_\n- **--m3e-radio-selected-hover-color** - Hover state layer color when radio is selected. _(default: undefined)_\n- **--m3e-radio-selected-focus-color** - Focus state layer color when radio is selected. _(default: undefined)_\n- **--m3e-radio-selected-ripple-color** - Ripple color when radio is selected. _(default: undefined)_\n- **--m3e-radio-selected-icon-color** - Icon color when radio is selected. _(default: undefined)_\n- **--m3e-radio-disabled-icon-color** - Icon color when radio is disabled. _(default: undefined)_",
+      "description": "A radio button that allows a user to select one option from a set of options.\n---\n\n\n### **Events:**\n - **input** - Emitted when the checked state changes.\n- **change** - Emitted when the checked state changes.\n- **click** - Emitted when the element is clicked.\n\n### **Methods:**\n - **markAsPristine(): _void_** - Marks the element as pristine.\n- **markAsDirty(): _void_** - Marks the element as dirty.\n- **markAsTouched(): _void_** - Marks the element as touched.\n- **markAsUntouched(): _void_** - Marks the element as untouched.\n- **formDisabledCallback(disabled: _boolean_): _void_** - Called when the element is disabled or enabled via its form association.\n- **formResetCallback(): _void_** - Called when the associated form is reset.\n\n### **CSS Properties:**\n - **--m3e-radio-container-size** - Base size of the radio button container. _(default: undefined)_\n- **--m3e-radio-icon-size** - Size of the radio icon inside the wrapper. _(default: undefined)_\n- **--m3e-radio-unselected-hover-color** - Hover state layer color when radio is not selected. _(default: undefined)_\n- **--m3e-radio-unselected-focus-color** - Focus state layer color when radio is not selected. _(default: undefined)_\n- **--m3e-radio-unselected-ripple-color** - Ripple color when radio is not selected. _(default: undefined)_\n- **--m3e-radio-unselected-icon-color** - Icon color when radio is not selected. _(default: undefined)_\n- **--m3e-radio-selected-hover-color** - Hover state layer color when radio is selected. _(default: undefined)_\n- **--m3e-radio-selected-focus-color** - Focus state layer color when radio is selected. _(default: undefined)_\n- **--m3e-radio-selected-ripple-color** - Ripple color when radio is selected. _(default: undefined)_\n- **--m3e-radio-selected-icon-color** - Icon color when radio is selected. _(default: undefined)_\n- **--m3e-radio-disabled-icon-color** - Icon color when radio is disabled. _(default: undefined)_\n- **--m3e-radio-error-hover-color** - Fallback hover color used when the radio is invalid and touched. _(default: undefined)_\n- **--m3e-radio-error-focus-color** - Fallback focus color used when the radio is invalid and touched. _(default: undefined)_\n- **--m3e-radio-error-ripple-color** - Fallback ripple color used when the radio is invalid and touched. _(default: undefined)_\n- **--m3e-radio-error-icon-color** - Fallback icon color used when the radio is invalid and touched. _(default: undefined)_",
       "attributes": [
         {
           "name": "checked",
@@ -16,6 +16,16 @@
           "description": "Whether the element is disabled.",
           "values": []
         },
+        {
+          "name": "name",
+          "description": "The name that identifies the element when submitting the associated form.",
+          "values": []
+        },
+        {
+          "name": "required",
+          "description": "Whether the element is required.",
+          "values": []
+        },
         {
           "name": "value",
           "description": "A string representing the value of the radio.",
@@ -26,8 +36,9 @@
     },
     {
       "name": "m3e-radio-group",
-      "description": "A container for a set of radio buttons that enforces single selection.\n---\n\n\n### **Events:**\n - **change** - Emitted when the checked state of a radio button changes.\n\n### **Methods:**\n - **markAsPristine(): _void_** - Marks the element as pristine.\n- **markAsDirty(): _void_** - Marks the element as dirty.\n- **markAsTouched(): _void_** - Marks the element as touched.\n- **markAsUntouched(): _void_** - Marks the element as untouched.\n- **reportValidity(): _boolean_** - Returns `true` if the element has no validity problems; otherwise, returns `false`, fires\r\nan invalid event, and (if the event isn't canceled) reports the problem to the user.\n- **checkValidity(): _boolean_** - Returns `true` if the element has no validity problems; otherwise,\r\nreturns `false`, fires an invalid event.\n- **setCustomValidity(error: _string_): _void_** - Sets a custom validity message for the element.\n- **formDisabledCallback(disabled: _boolean_): _void_** - Called when the element is disabled or enabled via its form association.\n- **formResetCallback(): _void_** - Called when the associated form is reset.\n\n### **Slots:**\n - _default_ - Renders the radio buttons of the group.\n\n### **CSS Properties:**\n - **--m3e-radio-error-hover-color** - Fallback hover color used when the radio is invalid and touched. _(default: undefined)_\n- **--m3e-radio-error-focus-color** - Fallback focus color used when the radio is invalid and touched. _(default: undefined)_\n- **--m3e-radio-error-ripple-color** - Fallback ripple color used when the radio is invalid and touched. _(default: undefined)_\n- **--m3e-radio-error-icon-color** - Fallback icon color used when the radio is invalid and touched. _(default: undefined)_",
+      "description": "A container for a set of radio buttons.\n---\n\n\n### **Events:**\n - **change** - Emitted when the checked state of a radio button changes.\n\n### **Methods:**\n - **markAsTouched(): _void_** - Marks the element as touched.\n- **markAsUntouched(): _void_** - Marks the element as untouched.\n- **markAsDirty(): _void_** - Marks the element as dirty.\n- **markAsPristine(): _void_** - Marks the element as pristine.\n- **reportValidity(): _boolean_** - Returns `true` if the element has no validity problems; otherwise, returns `false`, fires\r\nan invalid event, and (if the event isn't canceled) reports the problem to the user.\n- **checkValidity(): _boolean_** - Returns `true` if the element has no validity problems; otherwise,\r\nreturns `false`, fires an invalid event.\n- **setCustomValidity(error: _string_): _void_** - Sets a custom validity message for the element.\n- **formDisabledCallback(disabled: _boolean_): _void_** - Called when the element is disabled or enabled via its form association.\n- **formResetCallback(): _void_** - Called when the associated form is reset.\n\n### **Slots:**\n - _default_ - Renders the radio buttons of the group.",
       "attributes": [
+        { "name": "aria-invalid", "values": [] },
         {
           "name": "disabled",
           "description": "Whether the element is disabled.",