# Number Input

Numeric input with increment/decrement and bounds



<ComponentPreview base="opentui" name="number-input-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/opentui-number-input
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="opentui" name="number-input" title="components/ui/number-input.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { NumberInput } from "@/components/ui/number-input";
```

```tsx
<NumberInput
  label="Quantity"
  min={0}
  max={100}
  step={1}
  onChange={(value) => console.log("Value:", value)}
/>
```

API Reference [#api-reference]

NumberInput [#numberinput]

| Prop          | Type                                                                                         | Default                  |
| ------------- | -------------------------------------------------------------------------------------------- | ------------------------ |
| `value`       | `number`                                                                                     | -                        |
| `onChange`    | `(value: number) => void`                                                                    | -                        |
| `onSubmit`    | `(value: number) => void`                                                                    | -                        |
| `min`         | `number`                                                                                     | -                        |
| `max`         | `number`                                                                                     | -                        |
| `step`        | `number`                                                                                     | `1`                      |
| `placeholder` | `string`                                                                                     | `""`                     |
| `label`       | `string`                                                                                     | -                        |
| `id`          | `string`                                                                                     | -                        |
| `format`      | `(n: number) => string`                                                                      | -                        |
| `borderStyle` | `"single" \| "double" \| "round" \| "bold" \| "singleDouble" \| "doubleSingle" \| "classic"` | `"round"`                |
| `paddingX`    | `number`                                                                                     | `1`                      |
| `cursor`      | `string`                                                                                     | `"█"`                    |
| `stepHint`    | `string`                                                                                     | `"↑ +{step}  ↓ -{step}"` |