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

/// <reference types="svelte" />

type NumberInputTranslationId = "increment" | "decrement";

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;
  };

  $$slot_def: {
    label: {};
  };

  $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: "change", cb: (event: CustomEvent<any>) => void): () => void;
  $on(eventname: string, cb: (event: Event) => void): () => void;
}