@purpurds/checkbox 3.0.0

package/dist/checkbox.d.ts

@@ -0,0 +1,56 @@
+import React from "react";
+export type CheckedState = boolean | "indeterminate";
+export type CheckboxProps = {
+    /**
+     * To use when no label is given (not recommended).
+     * */
+    ["aria-label"]?: string;
+    /**
+     * To use with custom label (not recommended).
+     * */
+    ["aria-labelledby"]?: string;
+    ["data-testid"]?: string;
+    checked?: CheckedState;
+    /**
+     * The checked state of the checkbox when it is initially rendered. Use when you do not need to control its checked state.
+     */
+    className?: string;
+    /**
+     * The checked state of the checkbox when it is initially rendered. Use when you do not need to control its checked state.
+     */
+    defaultChecked?: boolean;
+    /**
+     * When `true`, prevents the user from interacting with the checkbox.
+     */
+    disabled?: boolean;
+    /**
+     * Use to render error message below the checkbox. The checkbox renders with error appearance.
+     * */
+    errorText?: string;
+    /**
+     * ID of the checkbox.
+     * */
+    id: string;
+    /**
+     * The label of the checkbox.
+     * */
+    label?: string;
+    /**
+     * The name of the checkbox. Submitted with its owning form as part of a name/value pair.
+     * */
+    name?: string;
+    /**
+     * Event handler called when the checked state of the checkbox changes.
+     * */
+    onChange?: (value: CheckedState) => void;
+    /**
+     * When `true`, indicates that the user must check the checkbox before the owning form can be submitted.
+     * */
+    required?: boolean;
+    /**
+     * The value given as data when submitted with a name.
+     * */
+    value?: string;
+};
+export declare const Checkbox: React.ForwardRefExoticComponent<CheckboxProps & React.RefAttributes<HTMLButtonElement>>;
+//# sourceMappingURL=checkbox.d.ts.map

package/dist/checkbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkbox.d.ts","sourceRoot":"","sources":["../src/checkbox.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAmC,MAAM,OAAO,CAAC;AAUxD,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,eAAe,CAAC;AACrD,MAAM,MAAM,aAAa,GAAG;IAC1B;;SAEK;IACL,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC;IACxB;;SAEK;IACL,CAAC,iBAAiB,CAAC,CAAC,EAAE,MAAM,CAAC;IAC7B,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;SAEK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;SAEK;IACL,EAAE,EAAE,MAAM,CAAC;IACX;;SAEK;IACL,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;SAEK;IACL,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;SAEK;IACL,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;IACzC;;SAEK;IACL,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;SAEK;IACL,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAuEF,eAAO,MAAM,QAAQ,yFAAgC,CAAC"}