# @elemental-ui-alpha/text-field

> The text-field components serve as the primary device for text-based user text-field.

Latest version **0.0.2** (published 2020-04-24) · 0 weekly downloads

## Install

```sh
npm install @elemental-ui-alpha/text-field
pnpm add @elemental-ui-alpha/text-field
yarn add @elemental-ui-alpha/text-field
bun add @elemental-ui-alpha/text-field
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-04-24 |
| First published | 2020-04-23 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | dsf-release-bot, mitchellhamilton |

## Links

- npm: https://www.npmjs.com/package/@elemental-ui-alpha/text-field
- npm.io page: https://npm.io/package/@elemental-ui-alpha/text-field

## Dependencies (4)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.8.3
- [@elemental-ui-alpha/core](https://npm.io/package/@elemental-ui-alpha/core.md) ^0.0.2
- [@elemental-ui-alpha/field](https://npm.io/package/@elemental-ui-alpha/field.md) ^0.0.2
- [@elemental-ui-alpha/theme](https://npm.io/package/@elemental-ui-alpha/theme.md) ^0.0.0

## Recent versions

- 0.0.2 (latest) — 2020-04-24
- 0.0.1 — 2020-04-23
- 0.0.0 — 2020-04-23

## README

# Input

```jsx
import { TextField, TextInput } from '@elemental-ui-alpha/text-field';
```

## TextField

The `TextField` component is the recommended component to use, which connects
the label, description, and message to the input element.

### Label

Each text field must be accompanied by a label.

```jsx live
<TextField label="Name" />
```

### Description

Labels should be concise. If you need to provide extra information to describe
the field, use the `description` property.

```jsx live
<TextField
  label="Email"
  description="We take your privacy seriously. We will never give your email to a third party."
/>
```

### Message

Offer a message to the user that may aid input.

```jsx live
<TextField label="First name" message="e.g. Olivia" />
```

## TextInput

The `TextInput` component is just a styled `input` element.

```jsx live
<TextInput />
```

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