@warp-ds/elements 2.10.0-next.2 → 2.10.0-next.3

package/dist/packages/checkbox/checkbox.d.ts

@@ -1,5 +1,8 @@
 import { LitElement, PropertyValues } from 'lit';
 declare const WCheckbox_base: import("@open-wc/form-control").Constructor<import("@open-wc/form-control").FormControlInterface> & typeof LitElement;
+/**
+ * @parent w-checkbox-group
+ */
 export declare class WCheckbox extends WCheckbox_base {
     #private;
     static styles: import("lit").CSSResult[];
@@ -12,34 +15,60 @@ export declare class WCheckbox extends WCheckbox_base {
         slotAssignment?: SlotAssignmentMode;
     };
     input: HTMLInputElement | null;
-    /** The name of the checkbox, submitted as a name/value pair with form data. */
+    /**
+     * The name of the checkbox.
+     *
+     * When the checkbox is checked and belongs to a form, this name is submitted with the checkbox value. If the checkbox is inside a `w-checkbox-group` with a name, the group name is used when the checkbox does not have its own name.
+     */
     set name(value: string | undefined);
     get name(): string | undefined;
     private _ownName;
-    /** The value of the checkbox, submitted as a name/value pair with form data. */
+    /**
+     * The value submitted when the checkbox is checked.
+     *
+     * If no value attribute is set, the checkbox defaults to `on`. Unchecked and disabled checkboxes do not submit a value.
+     */
     value: string | null;
-    /** Draws the checkbox in an indeterminate state. */
+    /**
+     * Whether the checkbox is visually indeterminate.
+     *
+     * Use this for parent options that represent a mixed set of child selections. Clicking the checkbox clears the indeterminate state and sets the checkbox to checked.
+     */
     indeterminate: boolean;
-    /** Draws the checkbox in a checked state (reflected to attribute). */
+    /**
+     * Whether the checkbox is checked.
+     *
+     * Checked checkboxes submit their value with form data. The property is reflected to the `checked` attribute.
+     */
     checked: boolean;
-    /** Disables the checkbox. */
+    /**
+     * Whether the checkbox is disabled.
+     *
+     * Disabled checkboxes cannot be focused, changed, or submitted with form data.
+     */
     disabled: boolean;
-    /** Makes the checkbox a required field. */
+    /**
+     * Whether the checkbox must be checked before form submission.
+     *
+     * A required checkbox is invalid until it is checked. For requiring at least one option in a set, use `required` on `w-checkbox-group`.
+     */
     required: boolean;
-    /** Draws the checkbox in an invalid state. */
+    /**
+     * Whether the checkbox is visually invalid.
+     *
+     * Use this to show an externally managed validation error. Required validation also sets the invalid state after the user interacts with the checkbox or tries to submit the form.
+     */
     invalid: boolean;
     /**
      * Internal invalid state managed by parent checkbox-group.
      * Non-reflecting to avoid DOM changes during hydration.
-     * @internal
      */
-    _groupInvalid: boolean | undefined;
+    private _groupInvalid;
     /**
      * Internal name managed by parent checkbox-group.
      * Non-reflecting to avoid DOM changes during hydration.
-     * @internal
      */
-    _groupName: string | undefined;
+    private _groupName;
     /** Computed invalid state: combines own invalid with group invalid */
     get _computedInvalid(): boolean;
     connectedCallback(): void;