# @berlitz/input

> Input component for the Max Design System

Latest version **4.3.3** (published 2025-04-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @berlitz/input
pnpm add @berlitz/input
yarn add @berlitz/input
bun add @berlitz/input
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.3.3 |
| Published | 2025-04-21 |
| First published | 2018-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 24.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | berlitz |

## Links

- npm: https://www.npmjs.com/package/@berlitz/input
- Homepage: https://github.com/berlitz-global/max/blob/master/components/input/CHANGELOG.md
- npm.io page: https://npm.io/package/@berlitz/input

## Dependencies (2)

- [react-input-mask](https://npm.io/package/react-input-mask.md) ^2.0.4
- [styled-components-rtl](https://npm.io/package/styled-components-rtl.md) 5.2.0

## Recent versions

- 4.3.3 (latest) — 2025-04-21
- 4.2.2-test.25 (canary) — 2022-01-24
- 4.3.2 — 2025-04-16
- 4.3.1 — 2025-04-16
- 4.3.0 — 2025-04-16
- 4.2.1 — 2021-09-20
- 4.2.0 — 2021-08-05
- 4.1.3 — 2021-04-09
- 4.1.2 — 2021-02-12
- 4.0.1-alpha.63 — 2021-02-12
- 4.1.1 — 2021-01-21
- 4.1.0 — 2021-01-20
- 4.0.2 — 2021-01-06
- 4.0.1 — 2021-01-05
- 4.0.0 — 2020-10-16
- … 170 more at https://npm.io/package/@berlitz/input/versions

## README

# Input [![npm version](https://img.shields.io/npm/v/@berlitz/input.svg)](https://www.npmjs.com/package/@berlitz/input)

Simple wrapper around the native `input` component with some smarts.

## Installation

```shell
yarn add @berlitz/input
```

## Props

| Argument        | Type   | Required | Notes                                                                             |
| --------------- | ------ | -------- | --------------------------------------------------------------------------------- |
| ariaDescribedby | String |          |                                                                                   |
| autocomplete    | String |          | https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete         |
| button          | Bool   |          | Will add an arrow button to the right of the input, which accepts an onClick prop |
| defaultValue    | String |          |                                                                                   |
| disabled        | Bool   |          |                                                                                   |
| ghost           | Bool   |          | alternate style with only a bottom border                                         |
| id              | String |          |                                                                                   |
| invalid         | Bool   |          |                                                                                   |
| mask            | String |          | Mask pattern https://www.npmjs.com/package/react-input-mask                       |
| maskChar        | String |          | Mask character, typically " " or "\_"                                             |
| name            | String | X        |                                                                                   |
| onBlur          | Func   |          |                                                                                   |
| onChange        | Func   |          |                                                                                   |
| onClick         | Func   |          | onClick handler to attach to the optional button prop                             |
| onKeyDown       | Func   |          |                                                                                   |
| onKeyPress      | Func   |          |                                                                                   |
| onKeyUp         | Func   |          |                                                                                   |
| pattern         | String |          | https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern              |
| placeholder     | String |          |                                                                                   |
| required        | Bool   |          |                                                                                   |
| title           | String |          | https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-title        |
| type            | String | X        |                                                                                   |
| value           | String |          |                                                                                   |

## Usage

```jsx
import Input from '@berlitz/input'
const MyApp = () => <Input name="cool_input" type="text" />
```

---
_Source: https://npm.io/package/@berlitz/input · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._