@naturacosmeticos/natds-react/dist/components/Counter/Counter.props.d.ts

A collection of components from Natura Design System for React

import React from 'react';
import { Size } from '@naturacosmeticos/natds-themes';
declare type CounterSizes = keyof Pick<Size, 'semiX' | 'medium'>;
export interface CounterProps {
    /**
     * Add a description to increment button
     */
    ariaLabelInput?: string;
    /**
     * Add a description to increment button
     */
    ariaLabelIncrementButton?: string;
    /**
     * Add a description to decrement button
     */
    ariaLabelDecrementButton?: string;
    /**
     * Specify an optional className to be added to your Counter
     */
    className?: string;
    /**
     * If `true` disable component actions.
     *
     * @default false
     */
    disabled?: boolean;
    /**
     * If `true` readOnly component actions.
     *
     * @default false
     */
    readOnly?: boolean;
    /**
     * Prop to onChange value.
     *
     */
    onChange?: React.ChangeEventHandler<HTMLInputElement | HTMLTextAreaElement>;
    /**
     * Insert a label above Counter input group.
     *
     */
    label?: string;
    /**
     * The maximum valid value for the component
     *
     * @default 99
     */
    maxValue?: number;
    /**
     * The minimum valid value for the component
     *
     * @default 0
     */
    minValue?: number;
    /**
     * Execute a callback when decrement button is pressed.
     */
    onDecrement: () => void;
    /**
     * Execute a callback when increment button is pressed.
     */
    onIncrement: () => void;
    /**
     * Select Counter component height
     *
     * @default "semiX"
     */
    size?: CounterSizes;
    /**
     * Optional ID for testing
     */
    testID?: string;
    /**
     * The value of input
     * @default 0
     */
    value?: number;
}
export {};