from-form-submit
TypeScript icon, indicating that this package has built-in type declarations

0.5.2 • Public • Published

from-form-submit

Simply convert a form submit event to a Javascript object

npm bundle size npm Coverage Status

Features

  • Convert input values by looking at their types
    • date
    • number
    • text
    • checkbox
  • Support arrays (eg: name="values.0.name" will be converted as { values: [{ name }] })
  • Vanilla JS, meaning it should work with all frameworks!
  • Prevent the default form submit behaviour

API

  • fromEvent(event: SubmitEvent, starter: Object): Object: convert the submit event ̀event to a Javascript object

    • types are casted when we can
    • inputs must have a name attribute for this to work
    • you can give a starter object, in which case this object will be copied and then populated with the form informations
  • wrapSubmit(callback: Function, starter: Object): Function: wrap your implementation before giving it to your "submit" callback form

    • this function catch the form event, then calls ̀formEvent to retrieve data, then calls your callback with it
    • callback(data: object, event: window.Event): void

Examples (ReactJS)

fromEvent

import React from 'react'
import { fromEvent } from 'from-form-submit'

const Component = () => (
  <form
    onSubmit={(event) => {
      console.log(fromEvent(event))
    }}
  >
    <input type="number" name="age" />
    <input type="string" name="name" />
  </form>
)

wrapSubmit

import React from 'react'
import { wrapSubmit } from 'from-form-submit'

const Component = () => (
  <form onSubmit={wrapSubmit(console.log)}>
    <input type="number" name="age" />
    <input type="string" name="name" />
  </form>
)

Package Sidebar

Install

npm i from-form-submit

Weekly Downloads

78

Version

0.5.2

License

MIT

Unpacked Size

18.1 kB

Total Files

15

Last publish

Collaborators

  • fabienjuif