mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 10:21:05 +00:00
6450e8b0b1* fix(types): add missing `$$restProps` for `Checkbox`, `Filename`, `FluidForm` * Run "yarn build:docs" * test: assert `$$restProps` for `Checkbox`, `Form`
103 lines
1.9 KiB
TypeScript
103 lines
1.9 KiB
TypeScript
/// <reference types="svelte" />
|
|
import type { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface CheckboxProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
|
/**
|
|
* Specify the value of the checkbox
|
|
* @default ""
|
|
*/
|
|
value?: any;
|
|
|
|
/**
|
|
* Specify whether the checkbox is checked
|
|
* @default false
|
|
*/
|
|
checked?: boolean;
|
|
|
|
/**
|
|
* Specify the bound group
|
|
* @default undefined
|
|
*/
|
|
group?: ReadonlyArray<any>;
|
|
|
|
/**
|
|
* 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` to mark the field as required
|
|
* @default false
|
|
*/
|
|
required?: 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
|
|
* @default undefined
|
|
*/
|
|
title?: string;
|
|
|
|
/**
|
|
* Set an id for the input label
|
|
* @default "ccs-" + Math.random().toString(36)
|
|
*/
|
|
id?: string;
|
|
|
|
/**
|
|
* Obtain a reference to the input HTML element
|
|
* @default null
|
|
*/
|
|
ref?: null | HTMLInputElement;
|
|
}
|
|
|
|
export default class Checkbox extends SvelteComponentTyped<
|
|
CheckboxProps,
|
|
{
|
|
check: CustomEvent<boolean>;
|
|
click: WindowEventMap["click"];
|
|
mouseover: WindowEventMap["mouseover"];
|
|
mouseenter: WindowEventMap["mouseenter"];
|
|
mouseleave: WindowEventMap["mouseleave"];
|
|
change: WindowEventMap["change"];
|
|
blur: WindowEventMap["blur"];
|
|
},
|
|
{ labelText: {} }
|
|
> {}
|