@m3e/radio-group
Version:
Radio Group for M3E
62 lines (61 loc) • 5.24 kB
JSON
{
"$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
"version": 1.1,
"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- **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",
"description": "Whether the element is checked.",
"values": []
},
{
"name": "disabled",
"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.",
"values": []
}
],
"references": []
},
{
"name": "m3e-radio-group",
"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.",
"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": []
}
],
"references": []
}
]
}