# final-vuerm

> Form management solution for Vue.js based on [:checkered_flag: Final Form](https://www.npmjs.com/package/final-form).

Latest version **0.4.1** (published 2018-10-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install final-vuerm
pnpm add final-vuerm
yarn add final-vuerm
bun add final-vuerm
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2018-10-21 |
| First published | 2018-10-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 341 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Katre Metsvahi |
| Maintainers | katre7 |
| Keywords | vue, vuejs, form, final form, validation |

## Links

- npm: https://www.npmjs.com/package/final-vuerm
- Repository: https://github.com/KatreMetsvahi/final-vuerm
- Homepage: https://github.com/KatreMetsvahi/final-vuerm#readme
- Issues: https://github.com/KatreMetsvahi/final-vuerm/issues
- npm.io page: https://npm.io/package/final-vuerm

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^2.5.17
- [final-form](https://npm.io/package/final-form.md) ^4.10.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.4.1 (latest) — 2018-10-21
- 0.4.0 — 2018-10-21
- 0.3.5 — 2018-10-21
- 0.3.4 — 2018-10-20
- 0.3.3 — 2018-10-20
- 0.3.2 — 2018-10-20
- 0.3.1 — 2018-10-20
- 0.2.3 — 2018-10-17
- 0.2.2 — 2018-10-17
- 0.2.1 — 2018-10-17
- 0.2.0 — 2018-10-17
- 0.1.3 — 2018-10-17
- 0.1.2 — 2018-10-17
- 0.1.1 — 2018-10-17
- 0.1.0 — 2018-10-17

## README

# final-vuerm

Form management solution for Vue.js based on [:checkered_flag: Final Form](https://www.npmjs.com/package/final-form).




## Installation

```bash
yarn add final-vuerm
```

or

```bash
npm install final-vuerm --save
```




## Simple form example

```js
import { Form, Field, Select, ResetButton, SubmitButton } from 'final-vuerm';

<Form :config="{ onSubmit: handleSubmit }">
  <Field name="fieldName" />
  <Select name="selectName">
    <option>1</option>
    <option>2</option>
    <option>3</option>
  </Select>
  
  <ResetButton>Reset</ResetButton>
  <SubmitButton>Submit</SubmitButton>
</Form>

```




## API




### `<Form>`

#### Props:

##### <a name="form-config"></a>`config`

Configuration used for creating a form instance. `onSubmit` is required.  
https://github.com/final-form/final-form#config

Example:
```js
{
  onSubmit: handleSubmit
}
```

##### `subscriptions?`

Object containing the values you wish to be updated about.  
https://github.com/final-form/final-form#formsubscription--string-boolean-

Example:
```js
{
  active: true,
  dirty: true,
  touched: true,
  valid: true,
  value: true
}
```

#### Events:

##### `@update`

Returns `formState` object.  
https://github.com/final-form/final-form#formstate


---


### `<Field>`

#### Props:

##### `config?`

Additional field configuration. This is where you can apply field-level validation.  
https://github.com/final-form/final-form#fieldconfig

##### `name`

Name to register field values to. This is a required prop.  
https://github.com/final-form/final-form#field-names

##### `subscriptions?`

Object containing the values you wish to be updated about.  
https://github.com/final-form/final-form#fieldsubscription--string-boolean-

Example:
```js
{
  dirty: true,
  valid: true,
  values: true
}
```

##### `type?`

Input type. Default is `text`.

##### `value?`

Input value. Used for `radio` inputs.
Use [`<Form>` `config`](#form-config) prop to set initial values, otherwise they will not be recorded in state.

#### Events:

##### `@update`

Returns `formState` object.  
https://github.com/final-form/final-form#fieldstate


---


### `<Select>`

See props and events definitions from [`<Field>`](#field).

#### Props:

##### `config?`

##### `name`

##### `subscriptions?`

#### Events:

##### `@update`


---


### `<ResetButton>`
Restores initial values.


---


### `<SubmitButton>`
Submits the form.

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