React-Form-Elements

Simplify form elements and form management.

Demo & Examples

* Live demo: kevinisom.info/react-form-elements
* Code Sandbox: Demo

Installation

The easiest way to use react-form-elements is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/react-form-elements.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

``bash
npm install react-form-elements
`

Usage

`js
import React from 'react'
import {
Button,
Checkbox,
ColorInput,
DateTime,
DropDown,
EmailInput,
Fieldset,
Form,
Option,
OptionGroup,
RadioGroup,
Range,
Row,
Telephone,
TextBox,
UrlInput,
} from 'react-form-elements'

const App = () => {

return (
name="testForm"
onSubmit={data => {
console.log(data)
// data.myTextBox
// data.
}}
>




label="Passing Attributes"
name="inputWithNativeAttributes"
required
placeholder="Put some text here"
/>
label="My Checkbox"
isChecked={true}
name="check"
value="checkpoint"
/>
name="rgroup"
label="The Radio"
initialChecked="first"
options={[
{ value: 'first', label: 'First' },
{ value: 'second', label: 'Second' },
]}
/>






label="My DateTime"
type="datetime-local"
name="myDateTimeLocal"
/>

label="My Drop Down"
initialValue="2"
data-testid="dd1"
name="myDropDown"
>

First
Second



Second First
Second Second



Third First
Third Second



label="Color"
name="color"
initialValue="#0668fa"
required
/>

name="emailbox"
label="Email"
initialValue="nospam@example.com"
/>
onClick={e => {
console.info('The button was clicked')
}}
>
Check





)
}
`

$3

The Form component has an onSubmit event handler that passes the data from the form elements as an object

$3

* Button
* CheckBox
* ColorInput
* DateTime
* DropDown
* EmailInput
* Fieldset
* Form
* Hidden
* Input
* Meter
* Option
* OptionGroup (also as OptGroup)
* Password (also as PasswordInput)
* Progress
* RadioGroup
* Range
* Row
* Telephone
* TextArea
* TextBox (also as TextInput)
* UrlInput

$3

React Form Elements exposes the useFormElement hook that can be used to enable integration with your own custom elements with the form management.

`jsx

import React, { Component, createRef } from 'react'
import {
useFormElement,
Button,
Form,
} from 'react-form-elements'

export default () => {
const ref = createRef()
const { id, value, handleChange, inputRef } = useFormElement('', ref)
return ( name="sampleForm"
onSubmit={values => {
console.log('Custom', values.myCustomInput)
sendData({ formValues: values })
}}
>

Send
)
}

`

$3

__Always in Development__

Demo & Examples local

To build the examples locally, run:

`bash
npm install
npm start
`

Then open localhost:8080 in a browser.

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link`).

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to

Copyright (c) 2015 Kevin Isom.