carbon-components-svelte/types/Checkbox/Checkbox.d.ts

/// <reference types="svelte" />

export default class Checkbox {
  $$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
    /**
     * Specify whether the checkbox is checked
     * @default false
     */
    checked?: boolean;

    /**
     * Specify whether the checkbox is indeterminate
     * @default false
     */
    indeterminate?: boolean;

    /**
     * Set to `true` to display the skeleton state
     * @default false
     */
    skeleton?: boolean;

    /**
     * Set to `true` for the checkbox to be read-only
     * @default false
     */
    readonly?: boolean;

    /**
     * Set to `true` to disable the checkbox
     * @default false
     */
    disabled?: boolean;

    /**
     * Specify the label text
     * @default ""
     */
    labelText?: string;

    /**
     * Set to `true` to visually hide the label text
     * @default false
     */
    hideLabel?: boolean;

    /**
     * Set a name for the input element
     * @default ""
     */
    name?: string;

    /**
     * Specify the title attribute for the label element
     */
    title?: string;

    /**
     * Set an id for the input label
     */
    id?: string;

    /**
     * Obtain a reference to the input HTML element
     * @default null
     */
    ref?: null | HTMLInputElement;
  };

  $$slot_def: {};

  $on(eventname: "check", cb: (event: CustomEvent<boolean>) => void): () => void;
  $on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
  $on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
  $on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
  $on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
  $on(eventname: "change", cb: (event: WindowEventMap["change"]) => void): () => void;
  $on(eventname: string, cb: (event: Event) => void): () => void;
}