@vtex/admin-ui/dist/components/NumericStepper/index.d.ts

> VTEX admin component library

import React from 'react';
import type { SystemComponentProps } from '../../types';
import type { AbstractInputOwnProps } from '../AbstractInput';
export declare const NumericStepper: React.ForwardRefExoticComponent<NumericStepperProps & React.RefAttributes<HTMLDivElement>>;
interface StateValue {
    value: number;
}
export interface NumericStepperProps extends SystemComponentProps<AbstractInputOwnProps> {
    /** NumericStepper value */
    value: number;
    /**
     * on value change event. Has a StateValue object as parameter.
     *
     * @example
     * ```ts
     * interface StateValue {
     *   value: number
     * }
     * ```
     */
    onChange: (value: StateValue) => void;
    /**
     * Represents the aria-label and will be visually hidden.
     */
    label: string;
    /**
     * Minimum value limit
     * @default -10e9
     */
    minValue?: number;
    /**
     * Maximum value limit
     * @default 10e9
     */
    maxValue?: number;
    /**
     * Whether is disabled or not
     * @default false
     */
    disabled?: boolean;
    /**
     * Tone of voice
     * @default neutral
     */
    tone?: 'neutral' | 'critical';
    /**
     * NumericStepper error message
     */
    criticalText?: string;
    /**
     * NumericStepper helper Text
     */
    helperText?: string;
    /**
     * Increment and Decrement multiplier value
     * @default 1
     */
    step?: number;
}
export {};