# @clds/text-field

> ---

Latest version **0.40.0** (published 2024-06-17) · 0 weekly downloads

## Install

```sh
npm install @clds/text-field
pnpm add @clds/text-field
yarn add @clds/text-field
bun add @clds/text-field
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.40.0 |
| Published | 2024-06-17 |
| First published | 2023-01-05 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 65.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Cloudinary |
| Maintainers | cloudinary-internal |

## Links

- npm: https://www.npmjs.com/package/@clds/text-field
- Repository: https://github.com/cloudinary/design-system
- Homepage: https://github.com/cloudinary/design-system/tree/main/libs/components/text-field#readme
- Issues: https://github.com/cloudinary/design-system/issues
- npm.io page: https://npm.io/package/@clds/text-field

## Dependencies (6)

- [polished](https://npm.io/package/polished.md) 3.7.2
- [@clds/typography](https://npm.io/package/@clds/typography.md) 0.40.0
- [styled-components](https://npm.io/package/styled-components.md) 5.3.11
- [@clds/toolbar-layout](https://npm.io/package/@clds/toolbar-layout.md) 0.40.0
- [@clds/component-theme](https://npm.io/package/@clds/component-theme.md) 0.40.0
- [@clds/common-definitions](https://npm.io/package/@clds/common-definitions.md) 0.40.0

## Recent versions

- 0.40.0 (latest) — 2024-06-17
- 0.39.2 — 2024-06-10
- 0.39.0 — 2024-06-06
- 0.38.0 — 2024-01-08
- 0.37.0 — 2023-12-15
- 0.36.3 — 2023-11-24
- 0.36.2 — 2023-11-20
- 0.36.1 — 2023-11-20
- 0.36.0 — 2023-10-24
- 0.35.3 — 2023-10-04
- 0.35.2 — 2023-09-28
- 0.35.1 — 2023-09-26
- 0.35.0 — 2023-09-20
- 0.34.0 — 2023-09-01
- 0.33.10 — 2023-08-31
- … 55 more at https://npm.io/package/@clds/text-field/versions

## README

## @clds/text-field

---

[![npm version](https://img.shields.io/npm/v/@clds/text-field)](https://www.npmjs.org/package/@clds/text-field)

Documentation of the text field component.

## Installation

Install the package using Yarn:

```sh
yarn add @clds/text-field
```

## Components

### TextField

Controlled text field component - does not handle any other responsibilities beside displaying and controlling the field itself.

## Usage

```javascript
import React, { FC, useRef, useState } from 'react';
import TextField from '@clds/text-field';
const ControlledExample: FC = () => {
  const [fieldValue, setFieldValue] = useState(defaultValue);
  return (
    <TextField
      onChange={setFieldValue}
      placeholder="Enter text here"
      type="text"
      value={fieldValue}
    />
  );
};
const UncontrolledExample: FC = () => {
  const textFieldRef = useRef(null);
  return <TextField defaultValue="Test" inputRef={textFieldRef} type="text" />;
};
```

## Versioning

This library follows [Semantic Versioning](http://semver.org/).

## License

See [LICENSE](https://github.com/cloudinary/design-system/blob/main/LICENSE)

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