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

65 lines
1.3 KiB
TypeScript

/// <reference types="svelte" />
export interface RadioButtonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Specify the value of the radio button
* @default ""
*/
value?: string;
/**
* Set to `true` to check the radio button
* @default false
*/
checked?: boolean;
/**
* et to `true` to disable the radio button
* @default false
*/
disabled?: boolean;
/**
* Specify the label position
* @default "right"
*/
labelPosition?: "right" | "left";
/**
* Specify the label text
* @default ""
*/
labelText?: string;
/**
* Set to `true` to visually hide the label text
* @default false
*/
hideLabel?: boolean;
/**
* Set an id for the input element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Specify a name attribute for the checkbox input
* @default ""
*/
name?: string;
/**
* Obtain a reference to the input HTML element
* @default null
*/
ref?: null | HTMLInputElement;
}
export default class RadioButton {
$$prop_def: RadioButtonProps;
$$slot_def: {};
$on(eventname: "change", cb: (event: WindowEventMap["change"]) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}