mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
refactor(types): shorten ref, id JSDocs, use CarbonIcon type, export component props
This commit is contained in:
parent
d38e6d8be6
commit
75d4b4cf03
219 changed files with 5168 additions and 5259 deletions
86
types/Toggle/Toggle.d.ts
vendored
86
types/Toggle/Toggle.d.ts
vendored
|
@ -1,48 +1,50 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface ToggleProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Set to `true` to toggle the checkbox input
|
||||
* @default false
|
||||
*/
|
||||
toggled?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable checkbox input
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the label for the untoggled state
|
||||
* @default "Off"
|
||||
*/
|
||||
labelA?: string;
|
||||
|
||||
/**
|
||||
* Specify the label for the toggled state
|
||||
* @default "On"
|
||||
*/
|
||||
labelB?: string;
|
||||
|
||||
/**
|
||||
* Specify the label text
|
||||
* @default ""
|
||||
*/
|
||||
labelText?: string;
|
||||
|
||||
/**
|
||||
* Set an id for the input element
|
||||
* @default "ccs-" + Math.random().toString(36)
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Specify a name attribute for the checkbox input
|
||||
*/
|
||||
name?: string;
|
||||
}
|
||||
|
||||
export default class Toggle {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Set to `true` to toggle the checkbox input
|
||||
* @default false
|
||||
*/
|
||||
toggled?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable checkbox input
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the label for the untoggled state
|
||||
* @default "Off"
|
||||
*/
|
||||
labelA?: string;
|
||||
|
||||
/**
|
||||
* Specify the label for the toggled state
|
||||
* @default "On"
|
||||
*/
|
||||
labelB?: string;
|
||||
|
||||
/**
|
||||
* Specify the label text
|
||||
* @default ""
|
||||
*/
|
||||
labelText?: string;
|
||||
|
||||
/**
|
||||
* Set an id for the input element
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Specify a name attribute for the checkbox input
|
||||
*/
|
||||
name?: string;
|
||||
};
|
||||
|
||||
$$prop_def: ToggleProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
|
|
28
types/Toggle/ToggleSkeleton.d.ts
vendored
28
types/Toggle/ToggleSkeleton.d.ts
vendored
|
@ -1,19 +1,21 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface ToggleSkeletonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Specify the label text
|
||||
* @default ""
|
||||
*/
|
||||
labelText?: string;
|
||||
|
||||
/**
|
||||
* Set an id for the input element
|
||||
* @default "ccs-" + Math.random().toString(36)
|
||||
*/
|
||||
id?: string;
|
||||
}
|
||||
|
||||
export default class ToggleSkeleton {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Specify the label text
|
||||
* @default ""
|
||||
*/
|
||||
labelText?: string;
|
||||
|
||||
/**
|
||||
* Set an id for the input element
|
||||
*/
|
||||
id?: string;
|
||||
};
|
||||
|
||||
$$prop_def: ToggleSkeletonProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue