@justeattakeaway/pie-checkbox
Advanced tools
Comparing version 0.0.0-snapshot-release-20240522140604 to 0.0.0-snapshot-release-20240523095048
{ | ||
"schemaVersion": "1.0.0", | ||
"readme": "", | ||
"modules": [ | ||
"schemaVersion": "1.0.0", | ||
"readme": "", | ||
"modules": [ | ||
{ | ||
"kind": "javascript-module", | ||
"path": "src/defs-react.js", | ||
"declarations": [], | ||
"exports": [] | ||
}, | ||
{ | ||
"kind": "javascript-module", | ||
"path": "src/defs.js", | ||
"declarations": [ | ||
{ | ||
"kind": "javascript-module", | ||
"path": "src/defs.js", | ||
"declarations": [ | ||
{ | ||
"kind": "variable", | ||
"name": "defaultProps", | ||
"type": { | ||
"text": "DefaultProps" | ||
}, | ||
"default": "{\n required: false,\n indeterminate: false,\n}" | ||
"kind": "variable", | ||
"name": "defaultProps", | ||
"type": { | ||
"text": "DefaultProps" | ||
}, | ||
"default": "{\n required: false,\n indeterminate: false,\n}" | ||
} | ||
], | ||
"exports": [ | ||
{ | ||
"kind": "js", | ||
"name": "defaultProps", | ||
"declaration": { | ||
"name": "defaultProps", | ||
"module": "src/defs.js" | ||
} | ||
} | ||
] | ||
}, | ||
{ | ||
"kind": "javascript-module", | ||
"path": "src/index.js", | ||
"declarations": [ | ||
{ | ||
"kind": "class", | ||
"description": "", | ||
"name": "PieCheckbox", | ||
"members": [ | ||
{ | ||
"kind": "field", | ||
"name": "shadowRootOptions", | ||
"type": { | ||
"text": "object" | ||
}, | ||
"static": true, | ||
"default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "value", | ||
"type": { | ||
"text": "CheckboxProps['value'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"default": "'on'", | ||
"attribute": "value" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "label", | ||
"type": { | ||
"text": "CheckboxProps['label'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "label" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "name", | ||
"type": { | ||
"text": "CheckboxProps['name'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "name" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "checked", | ||
"type": { | ||
"text": "CheckboxProps['checked'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "checked" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "disabled", | ||
"type": { | ||
"text": "CheckboxProps['disabled'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "disabled", | ||
"reflects": true | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "required", | ||
"type": { | ||
"text": "CheckboxProps['required'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "required", | ||
"reflects": true | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "indeterminate", | ||
"type": { | ||
"text": "CheckboxProps['indeterminate'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "indeterminate" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "aria", | ||
"type": { | ||
"text": "CheckboxProps['aria']" | ||
}, | ||
"privacy": "public", | ||
"attribute": "aria" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "checkbox", | ||
"type": { | ||
"text": "HTMLInputElement | undefined" | ||
}, | ||
"privacy": "private" | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "onClick", | ||
"privacy": "private" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "validity", | ||
"type": { | ||
"text": "ValidityState" | ||
}, | ||
"privacy": "public", | ||
"description": "(Read-only) returns a ValidityState with the validity states that this element is in.\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/validity", | ||
"readonly": true | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "formDisabledCallback", | ||
"privacy": "public", | ||
"return": { | ||
"type": { | ||
"text": "void" | ||
} | ||
], | ||
"exports": [ | ||
}, | ||
"parameters": [ | ||
{ | ||
"kind": "js", | ||
"name": "defaultProps", | ||
"declaration": { | ||
"name": "defaultProps", | ||
"module": "src/defs.js" | ||
} | ||
"name": "disabled", | ||
"type": { | ||
"text": "boolean" | ||
}, | ||
"description": "The latest disabled state of the input." | ||
} | ||
] | ||
}, | ||
{ | ||
"kind": "javascript-module", | ||
"path": "src/index.js", | ||
"declarations": [ | ||
{ | ||
"kind": "class", | ||
"description": "", | ||
"name": "PieCheckbox", | ||
"members": [ | ||
{ | ||
"kind": "field", | ||
"name": "shadowRootOptions", | ||
"type": { | ||
"text": "object" | ||
}, | ||
"static": true, | ||
"default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "value", | ||
"type": { | ||
"text": "CheckboxProps['value'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"default": "'on'", | ||
"attribute": "value" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "label", | ||
"type": { | ||
"text": "CheckboxProps['label'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "label" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "name", | ||
"type": { | ||
"text": "CheckboxProps['name'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "name" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "checked", | ||
"type": { | ||
"text": "CheckboxProps['checked'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "checked" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "disabled", | ||
"type": { | ||
"text": "CheckboxProps['disabled'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "disabled", | ||
"reflects": true | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "required", | ||
"type": { | ||
"text": "CheckboxProps['required'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "required", | ||
"reflects": true | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "indeterminate", | ||
"type": { | ||
"text": "CheckboxProps['indeterminate'] | undefined" | ||
}, | ||
"privacy": "public", | ||
"attribute": "indeterminate" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "aria", | ||
"type": { | ||
"text": "CheckboxProps['aria']" | ||
}, | ||
"privacy": "public", | ||
"attribute": "aria" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "checkbox", | ||
"type": { | ||
"text": "HTMLInputElement | undefined" | ||
}, | ||
"privacy": "private" | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "onClick", | ||
"privacy": "private" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "validity", | ||
"type": { | ||
"text": "ValidityState" | ||
}, | ||
"privacy": "public", | ||
"description": "(Read-only) returns a ValidityState with the validity states that this element is in.\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/validity", | ||
"readonly": true | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "formDisabledCallback", | ||
"privacy": "public", | ||
"return": { | ||
"type": { | ||
"text": "void" | ||
} | ||
}, | ||
"parameters": [ | ||
{ | ||
"name": "disabled", | ||
"type": { | ||
"text": "boolean" | ||
}, | ||
"description": "The latest disabled state of the input." | ||
} | ||
], | ||
"description": "Called after the disabled state of the element changes,\neither because the disabled attribute of this element was added or removed;\nor because the disabled state changed on a <fieldset> that's an ancestor of this element." | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "formResetCallback", | ||
"privacy": "public", | ||
"return": { | ||
"type": { | ||
"text": "void" | ||
} | ||
}, | ||
"description": "Called when the form that owns this component is reset.\nResets the value to the default value." | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "onChange", | ||
"description": "Captures the native change event and wraps it in a custom event.", | ||
"parameters": [ | ||
{ | ||
"description": "This should be the change event that was listened for on an input element with `type=\"checkbox\"`.", | ||
"name": "event", | ||
"type": { | ||
"text": "Event" | ||
} | ||
} | ||
] | ||
} | ||
], | ||
"attributes": [ | ||
{ | ||
"name": "value", | ||
"type": { | ||
"text": "CheckboxProps['value'] | undefined" | ||
}, | ||
"default": "'on'", | ||
"fieldName": "value" | ||
}, | ||
{ | ||
"name": "label", | ||
"type": { | ||
"text": "CheckboxProps['label'] | undefined" | ||
}, | ||
"fieldName": "label" | ||
}, | ||
{ | ||
"name": "name", | ||
"type": { | ||
"text": "CheckboxProps['name'] | undefined" | ||
}, | ||
"fieldName": "name" | ||
}, | ||
{ | ||
"name": "checked", | ||
"type": { | ||
"text": "CheckboxProps['checked'] | undefined" | ||
}, | ||
"fieldName": "checked" | ||
}, | ||
{ | ||
"name": "disabled", | ||
"type": { | ||
"text": "CheckboxProps['disabled'] | undefined" | ||
}, | ||
"fieldName": "disabled" | ||
}, | ||
{ | ||
"name": "required", | ||
"type": { | ||
"text": "CheckboxProps['required'] | undefined" | ||
}, | ||
"fieldName": "required" | ||
}, | ||
{ | ||
"name": "indeterminate", | ||
"type": { | ||
"text": "CheckboxProps['indeterminate'] | undefined" | ||
}, | ||
"fieldName": "indeterminate" | ||
}, | ||
{ | ||
"name": "aria", | ||
"type": { | ||
"text": "CheckboxProps['aria']" | ||
}, | ||
"fieldName": "aria" | ||
} | ||
], | ||
"mixins": [ | ||
{ | ||
"name": "FormControlMixin", | ||
"package": "@justeattakeaway/pie-webc-core" | ||
}, | ||
{ | ||
"name": "RtlMixin", | ||
"package": "@justeattakeaway/pie-webc-core" | ||
} | ||
], | ||
"superclass": { | ||
"name": "LitElement", | ||
"package": "lit" | ||
}, | ||
"tagName": "pie-checkbox", | ||
"customElement": true | ||
], | ||
"description": "Called after the disabled state of the element changes,\neither because the disabled attribute of this element was added or removed;\nor because the disabled state changed on a <fieldset> that's an ancestor of this element." | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "formResetCallback", | ||
"privacy": "public", | ||
"return": { | ||
"type": { | ||
"text": "void" | ||
} | ||
], | ||
"exports": [ | ||
}, | ||
"description": "Called when the form that owns this component is reset.\nResets the checked state to false." | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "onChange", | ||
"description": "Captures the native change event and wraps it in a custom event.", | ||
"parameters": [ | ||
{ | ||
"kind": "js", | ||
"name": "*", | ||
"declaration": { | ||
"name": "*", | ||
"package": "./defs" | ||
} | ||
}, | ||
{ | ||
"kind": "js", | ||
"name": "PieCheckbox", | ||
"declaration": { | ||
"name": "PieCheckbox", | ||
"module": "src/index.js" | ||
} | ||
"description": "This should be the change event that was listened for on an input element with `type=\"checkbox\"`.", | ||
"name": "event", | ||
"type": { | ||
"text": "Event" | ||
} | ||
} | ||
] | ||
] | ||
} | ||
], | ||
"attributes": [ | ||
{ | ||
"name": "value", | ||
"type": { | ||
"text": "CheckboxProps['value'] | undefined" | ||
}, | ||
"default": "'on'", | ||
"fieldName": "value" | ||
}, | ||
{ | ||
"name": "label", | ||
"type": { | ||
"text": "CheckboxProps['label'] | undefined" | ||
}, | ||
"fieldName": "label" | ||
}, | ||
{ | ||
"name": "name", | ||
"type": { | ||
"text": "CheckboxProps['name'] | undefined" | ||
}, | ||
"fieldName": "name" | ||
}, | ||
{ | ||
"name": "checked", | ||
"type": { | ||
"text": "CheckboxProps['checked'] | undefined" | ||
}, | ||
"fieldName": "checked" | ||
}, | ||
{ | ||
"name": "disabled", | ||
"type": { | ||
"text": "CheckboxProps['disabled'] | undefined" | ||
}, | ||
"fieldName": "disabled" | ||
}, | ||
{ | ||
"name": "required", | ||
"type": { | ||
"text": "CheckboxProps['required'] | undefined" | ||
}, | ||
"fieldName": "required" | ||
}, | ||
{ | ||
"name": "indeterminate", | ||
"type": { | ||
"text": "CheckboxProps['indeterminate'] | undefined" | ||
}, | ||
"fieldName": "indeterminate" | ||
}, | ||
{ | ||
"name": "aria", | ||
"type": { | ||
"text": "CheckboxProps['aria']" | ||
}, | ||
"fieldName": "aria" | ||
} | ||
], | ||
"mixins": [ | ||
{ | ||
"name": "FormControlMixin", | ||
"package": "@justeattakeaway/pie-webc-core" | ||
}, | ||
{ | ||
"name": "RtlMixin", | ||
"package": "@justeattakeaway/pie-webc-core" | ||
} | ||
], | ||
"superclass": { | ||
"name": "LitElement", | ||
"package": "lit" | ||
}, | ||
"tagName": "pie-checkbox", | ||
"customElement": true | ||
} | ||
], | ||
"exports": [ | ||
{ | ||
"kind": "js", | ||
"name": "*", | ||
"declaration": { | ||
"name": "*", | ||
"package": "./defs" | ||
} | ||
}, | ||
{ | ||
"kind": "javascript-module", | ||
"path": "src/defs-react.js", | ||
"declarations": [], | ||
"exports": [] | ||
"kind": "js", | ||
"name": "PieCheckbox", | ||
"declaration": { | ||
"name": "PieCheckbox", | ||
"module": "src/index.js" | ||
} | ||
} | ||
] | ||
} | ||
] | ||
} | ||
] | ||
} |
@@ -90,3 +90,3 @@ import { ComponentDefaultPropsGeneric } from '@justeattakeaway/pie-webc-core'; | ||
* Called when the form that owns this component is reset. | ||
* Resets the value to the default value. | ||
* Resets the checked state to false. | ||
*/ | ||
@@ -93,0 +93,0 @@ formResetCallback(): void; |
@@ -44,3 +44,3 @@ import { LitElement as u, html as y, nothing as p, unsafeCSS as f } from "lit"; | ||
* Called when the form that owns this component is reset. | ||
* Resets the value to the default value. | ||
* Resets the checked state to false. | ||
*/ | ||
@@ -47,0 +47,0 @@ formResetCallback() { |
@@ -93,3 +93,3 @@ import { ComponentDefaultPropsGeneric } from '@justeattakeaway/pie-webc-core'; | ||
* Called when the form that owns this component is reset. | ||
* Resets the value to the default value. | ||
* Resets the checked state to false. | ||
*/ | ||
@@ -96,0 +96,0 @@ formResetCallback(): void; |
{ | ||
"name": "@justeattakeaway/pie-checkbox", | ||
"description": "PIE Design System Checkbox built using Web Components", | ||
"version": "0.0.0-snapshot-release-20240522140604", | ||
"version": "0.0.0-snapshot-release-20240523095048", | ||
"type": "module", | ||
@@ -6,0 +6,0 @@ "main": "dist/index.js", |
@@ -82,3 +82,3 @@ import { | ||
* Called when the form that owns this component is reset. | ||
* Resets the value to the default value. | ||
* Resets the checked state to false. | ||
*/ | ||
@@ -85,0 +85,0 @@ public formResetCallback (): void { |
831
34947