# @rmwc/formfield

> MDC Form Field provides an mdc-formfield helper class for easily making theme-aware, RTL-aware form field + label combos. It also provides an MDCFormField class for easily making input ripples respond to label events.

Latest version **14.3.5** (published 2024-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @rmwc/formfield
pnpm add @rmwc/formfield
yarn add @rmwc/formfield
bun add @rmwc/formfield
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 14.3.5 |
| Published | 2024-10-24 |
| First published | 2018-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1657 |
| Author | rmwc |
| Maintainers | jamesmfriedman |
| Keywords | rmwc |

## Links

- npm: https://www.npmjs.com/package/@rmwc/formfield
- Repository: https://github.com/rmwc/rmwc
- Homepage: https://github.com/rmwc/rmwc/tree/master/packages/formfield
- Issues: https://github.com/rmwc/rmwc/issues
- npm.io page: https://npm.io/package/@rmwc/formfield

## Dependencies (3)

- [@rmwc/base](https://npm.io/package/@rmwc/base.md) 14.3.5
- [@rmwc/types](https://npm.io/package/@rmwc/types.md) 14.3.5
- [@material/form-field](https://npm.io/package/@material/form-field.md) ^14.0.0

## Recent versions

- 14.3.5 (latest) — 2024-10-24
- 14.0.2-alpha.7 (next) — 2023-10-30
- 14.3.4 — 2024-09-25
- 14.3.3 — 2024-08-30
- 14.3.2 — 2024-08-19
- 14.3.1 — 2024-07-19
- 14.3.0 — 2024-07-18
- 14.2.9 — 2024-07-03
- 14.2.8 — 2024-07-01
- 14.2.7 — 2024-06-30
- 14.2.6 — 2024-06-28
- 14.2.5 — 2024-06-26
- 14.2.2 — 2024-04-24
- 14.2.1 — 2024-04-17
- 14.2.0 — 2024-04-17
- … 153 more at https://npm.io/package/@rmwc/formfield/versions

## README

# Form Fields

MDC Form Field provides an mdc-formfield helper class for easily making theme-aware, RTL-aware form field + label combos. It also provides an MDCFormField class for easily making input ripples respond to label events.

- Module **@rmwc/formfield**
- Import styles:
  - Using CSS Loader
    - import '@rmwc/formfield/styles';
  - Or include stylesheets
    - **'@material/form-field/dist/mdc.form-field.css'**
- MDC Docs: [https://material.io/develop/web/components/input-controls/form-fields/](https://material.io/develop/web/components/input-controls/form-fields/)

```jsx
<FormField>
  <input type="checkbox" id="input" />
  <label htmlFor="input">Input Label</label>
</FormField>
```

## Align end

```jsx
<FormField alignEnd>
  <input type="checkbox" id="input" />
  <label htmlFor="input">Input Label</label>
</FormField>
```

## No wrap

```jsx
<FormField noWrap>
  <input type="checkbox" id="input" />
  <label htmlFor="input">Input Label</label>
</FormField>
```

## Space between

```jsx
<FormField spaceBetween>
  <input type="checkbox" id="input" />
  <label htmlFor="input">Input Label</label>
</FormField>
```

## FormField
A FormField component.

### Props

| Name | Type | Description |
|------|------|-------------|
| `alignEnd` | `boolean` | Position the input after the label. |
| `foundationRef` | `Ref<MDCFormFieldFoundation<>>` | Advanced: A reference to the MDCFoundation. |
| `noWrap` | `boolean` | Forces text to stay on a single line. |
| `spaceBetween` | `boolean` | Adds space between content. |

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