mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +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
166
types/Select/Select.d.ts
vendored
166
types/Select/Select.d.ts
vendored
|
@ -1,88 +1,90 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface SelectProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Specify the selected item value
|
||||
*/
|
||||
selected?: undefined;
|
||||
|
||||
/**
|
||||
* Set the size of the select input
|
||||
*/
|
||||
size?: "sm" | "xl";
|
||||
|
||||
/**
|
||||
* Set to `true` to use the inline variant
|
||||
* @default false
|
||||
*/
|
||||
inline?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to enable the light variant
|
||||
* @default false
|
||||
*/
|
||||
light?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the select element
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Set an id for the select element
|
||||
* @default "ccs-" + Math.random().toString(36)
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Specify a name attribute for the select element
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to indicate an invalid state
|
||||
* @default false
|
||||
*/
|
||||
invalid?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the invalid state text
|
||||
* @default ""
|
||||
*/
|
||||
invalidText?: string;
|
||||
|
||||
/**
|
||||
* Specify the helper text
|
||||
* @default ""
|
||||
*/
|
||||
helperText?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to not render a label
|
||||
* @default false
|
||||
*/
|
||||
noLabel?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the label text
|
||||
* @default ""
|
||||
*/
|
||||
labelText?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to visually hide the label text
|
||||
* @default false
|
||||
*/
|
||||
hideLabel?: boolean;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the select HTML element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLSelectElement;
|
||||
}
|
||||
|
||||
export default class Select {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Specify the selected item value
|
||||
*/
|
||||
selected?: undefined;
|
||||
|
||||
/**
|
||||
* Set the size of the select input
|
||||
*/
|
||||
size?: "sm" | "xl";
|
||||
|
||||
/**
|
||||
* Set to `true` to use the inline variant
|
||||
* @default false
|
||||
*/
|
||||
inline?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to enable the light variant
|
||||
* @default false
|
||||
*/
|
||||
light?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the select element
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Set an id for the select element
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Specify a name attribute for the select element
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to indicate an invalid state
|
||||
* @default false
|
||||
*/
|
||||
invalid?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the invalid state text
|
||||
* @default ""
|
||||
*/
|
||||
invalidText?: string;
|
||||
|
||||
/**
|
||||
* Specify the helper text
|
||||
* @default ""
|
||||
*/
|
||||
helperText?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to not render a label
|
||||
* @default false
|
||||
*/
|
||||
noLabel?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the label text
|
||||
* @default ""
|
||||
*/
|
||||
labelText?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to visually hide the label text
|
||||
* @default false
|
||||
*/
|
||||
hideLabel?: boolean;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the select HTML element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLSelectElement;
|
||||
};
|
||||
|
||||
$$prop_def: SelectProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
|
53
types/Select/SelectItem.d.ts
vendored
53
types/Select/SelectItem.d.ts
vendored
|
@ -1,32 +1,33 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface SelectItemProps {
|
||||
/**
|
||||
* Specify the option value
|
||||
* @default ""
|
||||
*/
|
||||
value?: string;
|
||||
|
||||
/**
|
||||
* Specify the option text
|
||||
* @default ""
|
||||
*/
|
||||
text?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to hide the option
|
||||
* @default false
|
||||
*/
|
||||
hidden?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the option
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
}
|
||||
|
||||
export default class SelectItem {
|
||||
$$prop_def: {
|
||||
/**
|
||||
* Specify the option value
|
||||
* @default ""
|
||||
*/
|
||||
value?: string;
|
||||
|
||||
/**
|
||||
* Specify the option text
|
||||
* @default ""
|
||||
*/
|
||||
text?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to hide the option
|
||||
* @default false
|
||||
*/
|
||||
hidden?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the option
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
};
|
||||
|
||||
$$prop_def: SelectItemProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
|
|
29
types/Select/SelectItemGroup.d.ts
vendored
29
types/Select/SelectItemGroup.d.ts
vendored
|
@ -1,20 +1,21 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface SelectItemGroupProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["optgroup"]> {
|
||||
/**
|
||||
* Set to `true` to disable the optgroup element
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the label attribute of the optgroup element
|
||||
* @default "Provide label"
|
||||
*/
|
||||
label?: string;
|
||||
}
|
||||
|
||||
export default class SelectItemGroup {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["optgroup"]> & {
|
||||
/**
|
||||
* Set to `true` to disable the optgroup element
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the label attribute of the optgroup element
|
||||
* @default "Provide label"
|
||||
*/
|
||||
label?: string;
|
||||
};
|
||||
|
||||
$$prop_def: SelectItemGroupProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
|
17
types/Select/SelectSkeleton.d.ts
vendored
17
types/Select/SelectSkeleton.d.ts
vendored
|
@ -1,14 +1,15 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export default class SelectSkeleton {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Set to `true` to hide the label text
|
||||
* @default false
|
||||
*/
|
||||
hideLabel?: boolean;
|
||||
};
|
||||
export interface SelectSkeletonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Set to `true` to hide the label text
|
||||
* @default false
|
||||
*/
|
||||
hideLabel?: boolean;
|
||||
}
|
||||
|
||||
export default class SelectSkeleton {
|
||||
$$prop_def: SelectSkeletonProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue