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
250
types/NumberInput/NumberInput.d.ts
vendored
250
types/NumberInput/NumberInput.d.ts
vendored
|
@ -2,131 +2,133 @@
|
|||
|
||||
type NumberInputTranslationId = "increment" | "decrement";
|
||||
|
||||
export interface NumberInputProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Set the size of the input
|
||||
*/
|
||||
size?: "sm" | "xl";
|
||||
|
||||
/**
|
||||
* Specify the input value
|
||||
* @default ""
|
||||
*/
|
||||
value?: string;
|
||||
|
||||
/**
|
||||
* Specify the step increment
|
||||
* @default 1
|
||||
*/
|
||||
step?: number;
|
||||
|
||||
/**
|
||||
* Specify the maximum value
|
||||
*/
|
||||
max?: number;
|
||||
|
||||
/**
|
||||
* Specify the minimum value
|
||||
*/
|
||||
min?: number;
|
||||
|
||||
/**
|
||||
* Set to `true` to enable the light variant
|
||||
* @default false
|
||||
*/
|
||||
light?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` for the input to be read-only
|
||||
* @default false
|
||||
*/
|
||||
readonly?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to enable the mobile variant
|
||||
* @default false
|
||||
*/
|
||||
mobile?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to allow for an empty value
|
||||
* @default false
|
||||
*/
|
||||
allowEmpty?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the input
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the increment icons
|
||||
* @default ""
|
||||
*/
|
||||
iconDescription?: 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;
|
||||
|
||||
/**
|
||||
* Specify the label text
|
||||
* @default ""
|
||||
*/
|
||||
label?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to visually hide the label text
|
||||
* @default false
|
||||
*/
|
||||
hideLabel?: boolean;
|
||||
|
||||
/**
|
||||
* Override the default translation ids
|
||||
* @default (id) => defaultTranslations[id]
|
||||
*/
|
||||
translateWithId?: (id: NumberInputTranslationId) => string;
|
||||
|
||||
/**
|
||||
* Default translation ids
|
||||
* @constant
|
||||
* @default { increment: "increment", decrement: "decrement", }
|
||||
*/
|
||||
translationIds?: { increment: "increment"; decrement: "decrement" };
|
||||
|
||||
/**
|
||||
* Set an id for the input element
|
||||
* @default "ccs-" + Math.random().toString(36)
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Specify a name attribute for the input
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the input HTML element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLInputElement;
|
||||
}
|
||||
|
||||
export default class NumberInput {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Set the size of the input
|
||||
*/
|
||||
size?: "sm" | "xl";
|
||||
|
||||
/**
|
||||
* Specify the input value
|
||||
* @default ""
|
||||
*/
|
||||
value?: string;
|
||||
|
||||
/**
|
||||
* Specify the step increment
|
||||
* @default 1
|
||||
*/
|
||||
step?: number;
|
||||
|
||||
/**
|
||||
* Specify the maximum value
|
||||
*/
|
||||
max?: number;
|
||||
|
||||
/**
|
||||
* Specify the minimum value
|
||||
*/
|
||||
min?: number;
|
||||
|
||||
/**
|
||||
* Set to `true` to enable the light variant
|
||||
* @default false
|
||||
*/
|
||||
light?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` for the input to be read-only
|
||||
* @default false
|
||||
*/
|
||||
readonly?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to enable the mobile variant
|
||||
* @default false
|
||||
*/
|
||||
mobile?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to allow for an empty value
|
||||
* @default false
|
||||
*/
|
||||
allowEmpty?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the input
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the increment icons
|
||||
* @default ""
|
||||
*/
|
||||
iconDescription?: 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;
|
||||
|
||||
/**
|
||||
* Specify the label text
|
||||
* @default ""
|
||||
*/
|
||||
label?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to visually hide the label text
|
||||
* @default false
|
||||
*/
|
||||
hideLabel?: boolean;
|
||||
|
||||
/**
|
||||
* Override the default translation ids
|
||||
* @default (id) => defaultTranslations[id]
|
||||
*/
|
||||
translateWithId?: (id: NumberInputTranslationId) => string;
|
||||
|
||||
/**
|
||||
* Default translation ids
|
||||
* @constant
|
||||
* @default { increment: "increment", decrement: "decrement", }
|
||||
*/
|
||||
translationIds?: { increment: "increment"; decrement: "decrement" };
|
||||
|
||||
/**
|
||||
* Set an id for the input element
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Specify a name attribute for the input
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the input HTML element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLInputElement;
|
||||
};
|
||||
|
||||
$$prop_def: NumberInputProps;
|
||||
$$slot_def: {
|
||||
label: {};
|
||||
};
|
||||
|
|
17
types/NumberInput/NumberInputSkeleton.d.ts
vendored
17
types/NumberInput/NumberInputSkeleton.d.ts
vendored
|
@ -1,14 +1,15 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export default class NumberInputSkeleton {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Set to `true` to hide the label text
|
||||
* @default false
|
||||
*/
|
||||
hideLabel?: boolean;
|
||||
};
|
||||
export interface NumberInputSkeletonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Set to `true` to hide the label text
|
||||
* @default false
|
||||
*/
|
||||
hideLabel?: boolean;
|
||||
}
|
||||
|
||||
export default class NumberInputSkeleton {
|
||||
$$prop_def: NumberInputSkeletonProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue