🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

react-form-light

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-form-light

A minimal form framework for React

0.2.0
latest
Source
npm
Version published
Weekly downloads
6
Maintainers
1
Weekly downloads
 
Created
Source

React form light

Build Status js-standard-style

A lightweight version of react-form with a slightly different API

  • Supports a component prop instead of using children-as-functions
  • Adds createForm and withFormField HOCs which decorates the component with the form api
  • Drops FormError, FormInput and standard Form Components
  • Tests

Installation

$ npm install react-form-light

Usage

Refer to the original project for the full documentation

createForm(options: object, Component)

Provides the form prop to Component which exposes the form api

The options object will be passed as props to the Form component

withFormField(field: string, Component)

Provides the form prop to Component which exposes the form api

The field object is used to bind the form api to a specific field

Example

Check out the storybook branch

import React from 'react'
import { createForm, FormField } from 'react-form-light'

const handleSubmit = values => {
  action('Submitted values')(values)
}

const handleValidation = values => {
  const { name } = values
  return {
    name: !name ? 'A name is required' : undefined
  }
}

const CustomInput = ({ form }) => {
  const { getTouched, getError, getValue, setValue } = form

  return (
    <p>
      <input
        type='text'
        value={getValue()}
        onChange={e => setValue(e.target.value)}
      />
      <br />
      <b>{getTouched() && getError()}</b>
    </p>
  )
}

const Values = ({ form: { getValue } }) => (
  <p>{JSON.stringify(getValue())}</p>
)

const CustomForm = props => {
  const { form: { submitForm } } = props
  console.log(props)
  return (
    <form onSubmit={submitForm}>
      <p>Name</p>
      <FormField field='name' component={CustomInput} />
      <FormField component={Values} />
      <button type='submit'>Submit me</button>
    </form>
  )
}

const defaultValues = {
  name: ''
}

export default createForm({
  defaultValues,
  onSubmit: handleSubmit,
  validate: handleValidation
}, CustomForm)

Contributing

  • Create an issue
  • Submit a PR with passing tests

Keywords

react

FAQs

Package last updated on 14 Jul 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts