# @dt-dds/react-text-field 中文文档

规范地址：https://npmcn.com/package/%40dt-dds/react-text-field/

版本：1\.0\.0-beta\.134
npm 元数据更新时间：2026-11-13T11:47:54.289Z
中文译文更新时间：2026-11-12T23:15:19.609Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dt-dds/react-text-field
原文对照：https://npmcn.com/package/%40dt-dds/react-text-field/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：79.8 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：8 个
- peer 依赖：react \>=17\.0\.2，react-dom \>=17\.0\.2，@emotion/css ^11\.7\.1，@emotion/react ^11\.8\.2，@emotion/styled ^11\.8\.1
- 首次发布：2025-08-07T14:19:56.853Z
- 最新版本发布：2026-11-13T11:47:54.070Z
- 近 30 天下载量：3230（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：83（近 12 个月 49 个）

## 中文简介

文本字段允许用户输入并编辑文本. 它们通常出现在形式和模式窗口中.

## 安装

```sh
npm install @dt-dds/react-text-field
```

也可以使用：`pnpm add @dt-dds/react-text-field`、`yarn add @dt-dds/react-text-field`、`bun add @dt-dds/react-text-field`

## README

# 文本字段

文本字段允许用户输入并编辑文本. 它们通常出现在形式和模式窗口中.

## 图片参考

[图片- 文本字段](https://www.figma.com/design/kMk36nv0ZT4AHhBbw9jq0S/%E2%86%B3-1.-Daimler-Truck-DDS--Beta-?node-id=8913-60394&t=Q2vzJQbSCO9jHwxx-4) [图片 - 数字字段](https://www.figma.com/design/kMk36nv0ZT4AHhBbw9jq0S/%E2%86%B3-1.-Daimler-Truck-DDS--Beta-?node-id=15578-3005&t=Q2vzJQbSCO9jHwxx-4)

## 文本字段使用

```jsx
import { TextField } from '@dt-dds/react-text-field';

export const App = () => {
  return <TextField label='My Field' message='Helpful hint' maxLength={40} />;
};
```

## 属性

| 财产 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `children` | `ReactNode` | \- 说吧 | 在输入域内提供儿童组件. |
| `label` | `string` | \- 说吧 | 一个帮助用户理解文本字段范围的标签. |
| `labelIcon` | `ReactNode` | \- 说吧 | 设置标签图标,为字段范围提供指导. |
| `initialValue` | `string` | \- 说吧 | 设置文本字段的初始值. |
| `message` | `string` | \- 说吧 | 输入字段下面要显示的消息 。 用于提示或显示错误 . |
| `hasError` | `boolean` | \- 说吧 | 设置文本字段错误状态 . |
| `disabled` | `boolean` | \- 说吧 | 确定输入字段的已禁用状态. |
| `name` | `string` | \- 说吧 | 指定文本字段名称的属性 . |
| `required` | `boolean` | \- 说吧 | 以信件设置错误状态 `requiredMessage` |
| `requiredMessage` | `string` | \- 说吧 | 需要验证时显示的错误消息 |
| `style` | `CSSProperties` | \- 说吧 | 直接在文本字段中添加 Css 样式. |
| `inputRef` | `RefObject` | \- 说吧 | 提供了访问 DOM 节点或反应元素引用的方法. |
| `maxLength` | `number` | \- 说吧 | 用户可以输入的最大字符数. |
| `type` | `HTMLInputTypeAttribute` | `text` | 用于指定要显示的元素类型 . |
| `onChange` | `function` | \- 说吧 | 当输入改变时触发函数 . |
| `onResetInput` | `function` | \- 说吧 | 点击交叉图标时触发的函数, 当类型搜索时 |
| `variant` | `[outlined, bottomLine]` | `outlined` | 以大纲或下行样式处理输入 |
| `scale` | `[compact, standard]` | `standard` | 设置文本字段的间隔和大小 |
| `backgroundFill` | `[default, contrast, light]` | `default` | 用背景颜色样式输入 |
| `isFloatingLabel` | `boolean` | `false` | 在输入上方设置浮动或传统标签 |
| `extraPrefix` | `ExtraComponent` | \- 说吧 | 在输入字段内左侧提供组件 |
| `extraSuffix` | `ExtraComponent` | \- 说吧 | 输入字段内右侧的组件 |
| `id` | `string` | \- 说吧 | 通过 htmlFor 属性将元素与相应元素链接的唯一标识符 |
| `dataTestId` | `string` | `label`\- 文本字段 | 自定义测试标识符 |
| `...` | `InputHTMLAttributes` | \- 说吧 | 所有来自本地 html 输入的可用属性 |

## 堆栈

-   [类型脚本](https://www.typescriptlang.org/) 用于静态类型检查
-   [反应](https://reactjs.org/) — JavaScript 用户界面库
-   [情感](https://emotion.sh/docs/introduction) 用于使用 JavaScript 写入 Css 样式
-   [故事书](https://storybook.js.org/) ——由Vite供电的UI组件环境
-   [欢乐](https://jestjs.io/) - JavaScript 测试框架
-   [反应测试库](https://testing-library.com/) - 以用户为中心测试用户界面组件
-   [ESLint 语录](https://eslint.org/) 代码林入
-   [高级](https://prettier.io/) 用于代码格式
-   [苏普](https://github.com/egoist/tsup) - 由Esbuild供电的脚本捆绑机
-   [雅伦](https://yarnpkg.com/) 从管理软件包

## 图标

-   `yarn build` - 制作软件包
-   `yarn dev` - 在当地运行软件包
-   `yarn lint` - 将所有文件输入此软件包
-   `yarn test` - 测试所有单位
-   `yarn test:report` - 打开测试覆盖报告
-   `yarn test:update:snapshot` - 进行所有单元测试并更新快照

## 汇编

运行 `yarn build` 从软件包的根部 [齐声](https://tsup.egoist.dev/) 将原始的 TypeScript 和 React 代码编译为普通 JavaScript .

这个 `/dist` 文件夹包含编译输出.

```bash
text-field
└── dist
    ├── index.d.ts  <-- Types
    ├── index.js    <-- CommonJS version
    └── index.mjs   <-- ES Modules version
    ...
```

## 版本

跟着 [语义版本](https://semver.org/)

## 许可证

许可证根据 [MIT 许可证](https://npmcn.com/package/%40dt-dds/react-text-field/LICENSE)

## 常见问题

### @dt-dds/react-text-field 是什么？

文本字段允许用户输入并编辑文本\. 它们通常出现在形式和模式窗口中\.

### 如何安装 @dt-dds/react-text-field？

在项目目录运行 npm install @dt-dds/react-text-field，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=17\.0\.2）、react-dom（\>=17\.0\.2）、@emotion/css（^11\.7\.1）、@emotion/react（^11\.8\.2）、@emotion/styled（^11\.8\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dt-dds/react-text-field 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dt-dds/react-text-field 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @dt-dds/react-text-field 可以商用吗？

@dt-dds/react-text-field 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dt-dds/react-text-field 的下载量有多少？

根据 npm 官方下载统计，@dt-dds/react-text-field 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,230 次，日均约 108 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dt-dds/react-text-field 还在维护吗？

最新版本 1\.0\.0-beta\.134 发布于 2026/11/13（今天）；至今共发布 83 个版本，其中过去 12 个月发布了 49 个；首次发布于 2025/08/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。