# @beisen-phoenix/input

> > @beisen-phoenix/input

Latest version **3.3.55** (published 2019-11-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install @beisen-phoenix/input
pnpm add @beisen-phoenix/input
yarn add @beisen-phoenix/input
bun add @beisen-phoenix/input
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.3.55 |
| Published | 2019-11-25 |
| First published | 2019-03-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 73.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | beisencorp |

## Links

- npm: https://www.npmjs.com/package/@beisen-phoenix/input
- npm.io page: https://npm.io/package/@beisen-phoenix/input

## Dependencies (4)

- [@beisen-phoenix/icon](https://npm.io/package/@beisen-phoenix/icon.md) ^3.2.54
- [@beisen-phoenix/tooltip](https://npm.io/package/@beisen-phoenix/tooltip.md) ^3.3.55
- [@beisen-phoenix/style-token](https://npm.io/package/@beisen-phoenix/style-token.md) ^3.3.55
- [@beisen-phoenix/common-utils](https://npm.io/package/@beisen-phoenix/common-utils.md) ^3.3.55

## Recent versions

- 3.3.55 (latest) — 2019-11-25
- 3.2.44-rc.1 (rc) — 2019-10-24
- 3.3.54 — 2019-11-25
- 3.3.53 — 2019-11-25
- 3.3.52 — 2019-11-24
- 3.3.51 — 2019-11-23
- 3.3.50 — 2019-11-22
- 3.3.48 — 2019-11-22
- 3.3.47 — 2019-11-22
- 3.3.46 — 2019-11-22
- 3.3.45 — 2019-11-21
- 3.3.43 — 2019-11-21
- 3.3.42 — 2019-11-21
- 3.3.41-beta.1 — 2019-11-21
- 3.3.41 — 2019-11-21
- … 395 more at https://npm.io/package/@beisen-phoenix/input/versions

## README

# 基础输入框

> @beisen-phoenix/input

## 概述

> 通过鼠标或键盘输入内容，是最基础的表单域的包装。

## API

| 参数                  | 说明                                                                          | 类型                    | 默认值   | 是否必传 |
| --------------------- | ----------------------------------------------------------------------------- | ----------------------- | -------- | -------- |
| type                  | 输入框类型，仅支持 `text` `password` `hidden`                                 | string                  | text     | 否       |
| size                  | 输入框尺寸，支持 `default` `large` `small`                                    | string                  | default  | 否       |
| value                 | 输入框内容                                                                    | string                  | -        | 否       |
| defaultValue          | 输入框默认内容，若使用了 value，则 defaultValue 无效                          | boolean                 | -        | 否       |
| placeholder           | 同原生 input                                                                  | string                  | `请输入` | 否       |
| status                | 输入框状态，正常、禁用、提示、错误，支持 `normal` `disabled` `isHint` `error` | string                  | normal   | 否       |
| readOnly              | 只读状态，不能输入，不显示清除按钮                                            | boolean                 | false    | 否       |
| autoFocus             | 首次挂载时是否自动获取焦点                                                    | boolean                 | false    | 否       |
| maxLength             | 最大输入字符数，同原生 input                                                  | number                  | -        | 否       |
| prefix                | 前缀元素                                                                      | React.ReactNode         | -        | 否       |
| suffix                | 后缀元素，同 prefix                                                           | React.ReactNode         | -        | 否       |
| translation           | 国际化，详情见下方                                                            | object                  | -        | 否       |
| onChange              | 输入框内容变化时的回调                                                        | function(value: string) | -        | 否       |
| onFocus               | 获取焦点时的回调                                                              | function(value: string) | -        | 否       |
| onBlur                | 失去焦点时的回调                                                              | function(value: string) | -        | 否       |
| onEnter               | 按下回车的回调                                                                | function(value: string) | -        | 否       |
| onClear               | 按下清除图标的回调                                                            | function()              | -        | 否       |
| onClick               | 点击输入框时的回调                                                            | function(event)         | -        | 否       |
| extraCls              | 自定义组件容器 class,一般用于覆盖组件默认样式使用                             | string                  | -        | 否       |
| clearFocus            | 输入框激活时 点击清除按钮 输入框是否激活                                      | boolean                 | false    | 否       |
| allowPoprationOnClear | 点击清除按钮时,click 事件是否冒泡                                             | boolean                 | false    | 否       |
| lang                  | 当前语言环境(zh_CN,en_US,zh_TW)                                               | string                  | zh_CN    | 否       |

## translation

```
translation: {
  placeholder: '请输入'
}
```

### 2019-11-19

> 新增 lang 属性，用于表示当前的语言环境，取值范围为“zh_CN,zh_TW,en_US”内部新增中文简体、英文、中文繁体语言包。

### 2019-09-12

> 更新设计：
> 可操作输入框文字超长时打点【保证 chrome 能正常打点即可】,不显示 tooltip
> 仅在禁用，只读时显示 tooltip

### 2019-09-18

新增 api
| clearFocus | 输入框激活时 点击清除按钮 输入框是否激活 | boolean | false | 否 |

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