UNPKG

@arolariu/components

Version:

🎨 70+ beautiful, accessible React components built on Base UI. TypeScript-first, CSS Modules styling, tree-shakeable, SSR-ready. Perfect for modern web apps, design systems & rapid prototyping. Zero config, maximum flexibility! ⚡

138 lines • 4.64 kB
import { NumberField as BaseNumberField } from "@base-ui/react/number-field"; import * as React from "react"; /** * Provides a styled numeric input with optional steppers and scrub support. * * @remarks * - Renders a `<div>` element by default * - Built on Base UI Number Field primitives * * @example * ```tsx * <NumberField defaultValue={2}> * <NumberFieldGroup> * <NumberFieldDecrement /> * <NumberFieldInput /> * <NumberFieldIncrement /> * </NumberFieldGroup> * </NumberField> * ``` * * @see {@link https://base-ui.com/react/components/number-field | Base UI Number Field Docs} */ declare function NumberField(props: Readonly<NumberField.Props>): React.ReactElement; declare namespace NumberField { var displayName: string; } /** * Wraps the interactive number-field controls in a shared container. * * @remarks * - Renders a `<div>` element by default * - Built on Base UI Number Field group primitives * * @example * ```tsx * <NumberFieldGroup> * <NumberFieldInput /> * </NumberFieldGroup> * ``` * * @see {@link https://base-ui.com/react/components/number-field | Base UI Number Field Docs} */ declare const NumberFieldGroup: React.ForwardRefExoticComponent<Omit<Omit<import("@base-ui/react").NumberFieldGroupProps, "ref"> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>; /** * Renders the text input used for numeric entry. * * @remarks * - Renders an `<input>` element by default * - Built on Base UI Number Field input primitives * * @example * ```tsx * <NumberFieldInput aria-label='Quantity' /> * ``` * * @see {@link https://base-ui.com/react/components/number-field | Base UI Number Field Docs} */ declare const NumberFieldInput: React.ForwardRefExoticComponent<Omit<Omit<import("@base-ui/react").NumberFieldInputProps, "ref"> & React.RefAttributes<HTMLInputElement>, "ref"> & React.RefAttributes<HTMLInputElement>>; /** * Renders the increment control for a number field. * * @remarks * - Renders a `<button>` element by default * - Built on Base UI Number Field increment primitives * * @example * ```tsx * <NumberFieldIncrement /> * ``` * * @see {@link https://base-ui.com/react/components/number-field | Base UI Number Field Docs} */ declare function NumberFieldIncrement(props: Readonly<NumberFieldIncrement.Props>): React.ReactElement; declare namespace NumberFieldIncrement { var displayName: string; } /** * Renders the decrement control for a number field. * * @remarks * - Renders a `<button>` element by default * - Built on Base UI Number Field decrement primitives * * @example * ```tsx * <NumberFieldDecrement /> * ``` * * @see {@link https://base-ui.com/react/components/number-field | Base UI Number Field Docs} */ declare function NumberFieldDecrement(props: Readonly<NumberFieldDecrement.Props>): React.ReactElement; declare namespace NumberFieldDecrement { var displayName: string; } /** * Renders the scrub handle used for drag-to-adjust interactions. * * @remarks * - Renders a `<span>` element by default * - Built on Base UI Number Field scrub-area primitives * * @example * ```tsx * <NumberFieldScrubArea /> * ``` * * @see {@link https://base-ui.com/react/components/number-field | Base UI Number Field Docs} */ declare function NumberFieldScrubArea(props: Readonly<NumberFieldScrubArea.Props>): React.ReactElement; declare namespace NumberFieldScrubArea { var displayName: string; } declare namespace NumberField { type Props = React.ComponentPropsWithRef<typeof BaseNumberField.Root>; type State = BaseNumberField.Root.State; } declare namespace NumberFieldGroup { type Props = React.ComponentPropsWithRef<typeof BaseNumberField.Group>; type State = BaseNumberField.Group.State; } declare namespace NumberFieldInput { type Props = React.ComponentPropsWithRef<typeof BaseNumberField.Input>; type State = BaseNumberField.Input.State; } declare namespace NumberFieldIncrement { type Props = React.ComponentPropsWithRef<typeof BaseNumberField.Increment>; type State = BaseNumberField.Increment.State; } declare namespace NumberFieldDecrement { type Props = React.ComponentPropsWithRef<typeof BaseNumberField.Decrement>; type State = BaseNumberField.Decrement.State; } declare namespace NumberFieldScrubArea { type Props = React.ComponentPropsWithRef<typeof BaseNumberField.ScrubArea>; type State = BaseNumberField.ScrubArea.State; } export { NumberField, NumberFieldDecrement, NumberFieldGroup, NumberFieldIncrement, NumberFieldInput, NumberFieldScrubArea }; //# sourceMappingURL=number-field.d.ts.map