# @visual-framework/vf-form

> form component

Latest version **2.0.3** (published 2025-02-25) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install @visual-framework/vf-form
pnpm add @visual-framework/vf-form
yarn add @visual-framework/vf-form
bun add @visual-framework/vf-form
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

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

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2025-02-25 |
| First published | 2018-11-27 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 36.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | VF |
| Maintainers | sandykadam, ebiwebdev, khawkins98, pacope92, bhushan-ebi |
| Keywords | fractal, component |

## Links

- npm: https://www.npmjs.com/package/@visual-framework/vf-form
- Homepage: https://stable.visual-framework.dev/
- Issues: https://github.com/visual-framework/vf-core/issues/new
- npm.io page: https://npm.io/package/@visual-framework/vf-form

## Dependencies (10)

- [@visual-framework/vf-form__item](https://npm.io/package/@visual-framework/vf-form__item.md) ^3.0.0
- [@visual-framework/vf-form__input](https://npm.io/package/@visual-framework/vf-form__input.md) ^3.0.0
- [@visual-framework/vf-form__label](https://npm.io/package/@visual-framework/vf-form__label.md) ^3.0.0
- [@visual-framework/vf-form__radio](https://npm.io/package/@visual-framework/vf-form__radio.md) ^3.0.0
- [@visual-framework/vf-form__helper](https://npm.io/package/@visual-framework/vf-form__helper.md) ^3.0.0
- [@visual-framework/vf-form__legend](https://npm.io/package/@visual-framework/vf-form__legend.md) ^2.0.3
- [@visual-framework/vf-form__select](https://npm.io/package/@visual-framework/vf-form__select.md) ^3.0.0
- [@visual-framework/vf-form__checkbox](https://npm.io/package/@visual-framework/vf-form__checkbox.md) ^3.0.0
- [@visual-framework/vf-form__fieldset](https://npm.io/package/@visual-framework/vf-form__fieldset.md) ^2.0.0
- [@visual-framework/vf-form__textarea](https://npm.io/package/@visual-framework/vf-form__textarea.md) ^3.0.0

## Recent versions

- 2.0.3 (latest) — 2025-02-25
- 2.0.2 — 2024-05-17
- 2.0.1 — 2024-05-01
- 2.0.0-alpha.2 — 2021-10-25
- 2.0.0-alpha.1 — 2021-03-29
- 2.0.0-alpha.0 — 2021-03-24
- 0.0.26 — 2019-01-29
- 0.0.23 — 2019-01-24
- 0.0.22 — 2018-12-20
- 0.0.21 — 2018-12-12
- 0.0.20 — 2018-12-10
- 0.0.19 — 2018-12-10
- 0.0.18 — 2018-12-10
- 0.0.17 — 2018-12-10
- 0.0.16 — 2018-11-28
- … 9 more at https://npm.io/package/@visual-framework/vf-form/versions

## README

# Form component

[![npm version](https://badge.fury.io/js/%40visual-framework%2Fvf-form.svg)](https://badge.fury.io/js/%40visual-framework%2Fvf-form)

## About

The `vf-form` manages a group of form inputs and interactive controls to collect data that can be sent to a server. The `vf-form` is the wrapping component for [all form elements](/components/#form).

## Usage

Whenever you need to use a `vf-form__item` and related input or control you need to wrap them with a `vf-form`.

The `vf-form` makes use of the `vf-stack` layout component to evenly distrubute the form inputs on a page.


## Install

This component is distributed with npm. After [installing npm](https://www.npmjs.com/get-npm), you can install the `vf-form` with this command. This will install all form items that work within a `vf-form` too.

```
$ yarn add --dev @visual-framework/vf-form
```

### Sass/CSS

The source files included are written in [Sass](http://sass-lang.com)(`scss`). You can point your Sass `include-path` at your `node_modules` directory and import it like this.

```
@import "@visual-framework/vf-form/vf-form.scss";
```

Make sure you import Sass requirements along with the modules. You can use a [project boilerplate](https://stable.visual-framework.dev/building/) or the [`vf-sass-starter`](https://stable.visual-framework.dev/components/vf-sass-starter/)

## Help

- [Read the Visual Framework troubleshooting](https://stable.visual-framework.dev/troubleshooting/)
- [Open a ticket](https://github.com/visual-framework/vf-core/issues)
- [Chat on Slack](https://join.slack.com/t/visual-framework/shared_invite/enQtNDAxNzY0NDg4NTY0LWFhMjEwNGY3ZTk3NWYxNWVjOWQ1ZWE4YjViZmY1YjBkMDQxMTNlNjQ0N2ZiMTQ1ZTZiMGM4NjU5Y2E0MjM3ZGQ)

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