mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 18:31:06 +00:00
3214d8563f* refactor(search): resolve svelte file paths * docs(Search): add reactive example * refactor(tag): use class name directive for tag types, resolve svelte icon path * chore(button-skeleton): deprecate small prop * fix(breadcrumb-item): type default slot * refactor(breadcrumb-skeleton): omit unused index * refactor(aspect-ratio): use class name directive * refactor(accordion): use the class name directive, resolve svelte icon paths * refactor(code-snippet): use class name directive, resolve svelte icon paths * fix(code-snippet-skeleton): CodeSnippetSkeleton can only be single or multi * refactor(content-switcher): use class name directive * docs(content-switcher): add reactive example * docs(content-switcher): remove unused import * docs(toggle): add reactive example * refactor(tooltip-definition): use class name directive * refactor(tooltip-icon): use class name directive * refactor(tooltip): resolve svelte icon import * fix(select): type dispatched change event * refactor(select): resolve svelte icon import * feat(select-item): spread rest props, avoid $ variable name * fix(pagination-nav): type dispatched events * refactor(pagination): resolve svelte imports * fix(pagination): type dispatched update event * fix(overflow-menu): type dispatched close event * fix(number-input): type dispatched change event * refactor(modal): use class name directive, resolve svelte imports * refactor(inline-loading): use class name directive, resolve svelte imports * refactor(composed-modal): resolve svelte icon imports * refactor(combo-box): resolve svelte imports * fix(fluid-form): rest props should not override Form class * refactor(progress-step): resolve svelte icon imports
143 lines
2.9 KiB
TypeScript
143 lines
2.9 KiB
TypeScript
/// <reference types="svelte" />
|
|
|
|
export 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?: number | 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: NumberInputProps;
|
|
$$slot_def: {
|
|
label: {};
|
|
};
|
|
|
|
$on(eventname: "change", cb: (event: CustomEvent<number>) => void): () => void;
|
|
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
|
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
|
|
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
|
|
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
|
|
$on(eventname: "input", cb: (event: WindowEventMap["input"]) => void): () => void;
|
|
$on(eventname: string, cb: (event: Event) => void): () => void;
|
|
}
|