Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MichaelCereda/react-native-form-generator
Generate forms with native look and feel in a breeze
https://github.com/MichaelCereda/react-native-form-generator
Last synced: 5 days ago
JSON representation
Generate forms with native look and feel in a breeze
- Host: GitHub
- URL: https://github.com/MichaelCereda/react-native-form-generator
- Owner: MichaelCereda
- License: mit
- Created: 2016-01-20T06:56:26.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-02-21T03:30:04.000Z (almost 5 years ago)
- Last Synced: 2024-11-30T08:08:29.360Z (12 days ago)
- Language: JavaScript
- Size: 591 KB
- Stars: 377
- Watchers: 17
- Forks: 105
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-native - react-native-form-generator ★354 - Generate amazing React Native forms in a breeze (Components / Forms)
- awesome-react-native - react-native-form-generator ★354 - Generate amazing React Native forms in a breeze (Components / Forms)
- awesome-react-native - react-native-form-generator - Generate amazing React Native forms in a breeze.  (Components / Forms)
- awesome-react-native - react-native-form-generator ★354 - Generate amazing React Native forms in a breeze (Components / Forms)
- awesome-react-native-ui - react-native-form-generator ★207 - Generate amazing React Native forms in a breeze (Components / Forms)
- awesome-react-native - react-native-form-generator ★354 - Generate amazing React Native forms in a breeze (Components / Forms)
README
React Native Form Generator
================
Generate forms with native look and feel in a breeze
[](https://nodei.co/npm/react-native-form-generator/)
## Components
* Picker
* DatePicker
* TimePicker
* Input
* Link
* Separator
* Switch
## Features
* Android and IOS support, Yeah Baby!
* Pleasant Defaults, totally overridable
* Doesn't have dependencies
* Use your own icon pack
* Easy to use and clean, react style syntax
* Automatic events handling
* Supports custom fields and styles without adding any weird syntax (just create a react component)
* Applies by default the current OS style
* Inspired by tcomb, the good parts
* Performances: just the field changed gets a setState
* You don't need to create a 'Model' or a 'Struct' that contains your data, just create a form component (the React's way)
* Validate InputFields based on keyboardType (can be overridden using validationFunction)
* Multiple validators
* Reset/Set Fields programmatically (setValue, setDate, setTime, focus)
* Custom Wrapper for Picker & DatePicker Components (iOS Only)
[My blogpost about React Native Form Generator](https://medium.com/@michaelcereda/react-native-forms-the-right-way-315802f989d6#.p9oj79vt3)
## Installation
```
npm install --save react-native-form-generator
```
## I'm actively working on this project
* Pull requests are very very welcome. They make my day ;).
* Master should be considered 'unstable' even if I do my best to keep it nice and safe.
* Every release has its own branch.
* Slider hasn't been created.
* I have to document the code properly and do some housekeeping, i apologize in advance.
## Example
Please check the folder _examples_ for an always up to date use case.
the example below generates the form you see in the animation
```javascript
/*
This is a view i use in a test app,
very useful to list all the use cases
*/
import React from 'react';
import {
AppRegistry,
StyleSheet,
Text,
View,ScrollView,
} from 'react-native';
import { Form,
Separator,InputField, LinkField,
SwitchField, PickerField,DatePickerField,TimePickerField
} from 'react-native-form-generator';
export class FormView extends React.Component{
constructor(props){
super(props);
this.state = {
formData:{}
}
}
handleFormChange(formData){
/*
formData will contain all the values of the form,
in this example.
formData = {
first_name:"",
last_name:"",
gender: '',
birthday: Date,
has_accepted_conditions: bool
}
*/
this.setState({formData:formData})
this.props.onFormChange && this.props.onFormChange(formData);
}
handleFormFocus(e, component){
//console.log(e, component);
}
openTermsAndConditionsURL(){
}
render(){
return (
{
if(Object.keys(self.refs).length !== 0){
if(!self.refs.registrationForm.refs.first_name.valid){
return self.refs.registrationForm.refs.first_name.validationErrors.join("\n");
}
}
// if(!!(self.refs && self.refs.first_name.valid)){
// }
})(this)}
validationFunction={[(value)=>{
/*
you can have multiple validators in a single function or an array of functions
*/
if(value == '') return "Required";
//Initial state is null/undefined
if(!value) return true;
// Check if First Name Contains Numbers
var matches = value.match(/\d+/g);
if (matches != null) {
return "First Name can't contain numbers";
}
return true;
}, (value)=>{
///Initial state is null/undefined
if(!value) return true;
if(value.indexOf('4')!=-1){
return "I can't stand number 4";
}
return true;
}]}
/>
{}}/>
{JSON.stringify(this.state.formData)}
);
}
}
```
## Form
Form automatically attaches on change events so you just have to attach an handle to the onFocus attibute of Form to monitor all the changes.
It's just a wrapper that allows you to attach onFocus (used to track focus events and keyboard events) and onChange (used to track changes in every field)
## Fields
#### Common Rules
* __Every__ field that has to propagate its value in the form __MUST__ have a ref attribute. (Separator and LinkField don't have a ref).
Check the example to understand the use of the ref attribute.
* All the components provided use _Field_ as wrapper in order to have the following props.
| Prop (parameters) | Description |
| --- | --- |
| helpText | String shown as text under the component |
| helpTextComponent | Custom component that replaces the one provided |
| onPress | onPress method |
### Separator
```javascript
```
### InputField
Input fields can be used to receive text, you can add icons (a react component) to the left and the right side of the field.
InputField can validate values based on keyboardType property, validation is not "aggressive", just changes a value inside the class, you can access the value using the ref (ex. this.ref.example_input_field.valid).
InputField automatically provides the attibutes _valid_ and _validationErrors_ to guarantee full control to the developer.
you can customize your validation function by adding a _validationFunction_ prop to the component. _validationFunction_ supports also an array of validators.
#### Creating a validator
Validators are simple functions have one paramenter (value) and that return true or a string containing an error.
```javascript
let workingValidator = (value)=>{
if(value == '') return "Required";
//Initial state is null/undefined
if(!value) return true;
var matches = value.match(/\d+/g);
if (matches != null) {
return "First Name can't contain numbers";
}
return true;
}
```
_react-native-form-generator_ doesn't depend on any icon library, that gives you freedom of adding any icon or react component you want.
look at the example here.
```javascript
{return true;}}
iconRight={
{
//i can change the style of the component related to the attibute of example_input_field
if(!!(self.refs && self.refs.example_input_field)){
if(!self.refs.example_input_field.valid) return {color:'#d52222'}
}
}
)(this)]}
/>
} //React Component
/>
```
All the props are passed down to the underlying TextInput Component
| Prop (parameters) | Description |
| --- | --- |
| label | Text to show in the field, if exists will move the textinput on the right, providing also the right alignment |
| iconLeft | React component, shown on the left of the field, the component needs to have a prop size to allow the inputText to resize properly |
| iconRight | React component, shown on the right of the field, the component needs to have a prop size to allow the inputText to resize properly |
| validationFunction | Function or array of functions, used to pass custom validators to the component|
| keyboardType | possible values: __undefined__, __email-address__|
| ref methods | Description |
| --- | --- |
| setValue | Sets the value programmatically |
| focus | Focus the textinput component |
### SwitchField
| Prop (parameters) | Description |
| --- | --- |
| onValueChange(value) | triggered at every value change, returns the new value of the field|
| value | Initial value of the component (Boolean)|
### PickerField
| Prop (parameters) | Description |
| --- | --- |
| onValueChange(value) | triggered at every value change, returns the new value of the field|
| value | Initial value of the component|
| options=[{label:"test",value="Test"},...] | All the possible options, array of objects|
| iconRight | React component, shown on the left of the text field (i suggest Ionicons 'ios-arrow-right' for a nice iOS effect) |
| pickerWrapper | Optional, Custom wrapper of the picker, check the example |
### DatePickerField
Every prop is passed down to the underlying DatePickerIOS/DatePickerAndroid component.
| Prop (parameters) | Description |
| --- | --- |
| onValueChange(date) | triggered at every value change, returns the new value of the field|
| date | Initial date of the component, defaults to (new Date()) |
| iconRight | React component, shown on the left of the text field (i suggest Ionicons 'ios-arrow-right' for a nice iOS effect) |
| dateTimeFormat | Optional, Custom date formatter |
| pickerWrapper | Optional, Custom wrapper of the picker, check the example |
| prettyPrint | Boolean, if true the component returns a string formatted using dateTimeFormat, if false a Date object is returned |
| placeholderComponent | Substitutes the component used to render the placeholder |
| placeholderStyle | Used to style the placeholder |
| valueStyle | Used to style the field's value |
### TimePickerField
Every prop is passed down to the underlying DatePickerIOS/DatePickerAndroid component.
Mode is set to 'time'
| Prop (parameters) | Description |
| --- | --- |
| onValueChange(date) | triggered at every value change, returns the new value of the field|
| date | Initial date of the component, defaults to (new Date()) |
| iconRight | React component, shown on the left of the text field (i suggest Ionicons 'ios-arrow-right' for a nice iOS effect) |
| dateTimeFormat | Optional, Custom date formatter |
| pickerWrapper | Optional, Custom wrapper of the picker, check the example |
| prettyPrint | Boolean, if true the component returns a string formatted using dateTimeFormat, if false a Date object is returned |
| placeholderComponent | Substitutes the component used to render the placeholder |
| placeholderStyle | Used to style the placeholder |
| valueStyle | Used to style the field's value |
### LinkField
Every prop is passed down to the underlying DatePickerIOS component.
| Prop (parameters) | Description |
| --- | --- |
| label | Text to show in the field |
| iconLeft | React component, shown on the left of the text field |
| iconRight | React component, shown on the left of the text field (i suggest Ionicons 'ios-arrow-right' for a nice iOS effect) |
### KeyboardEvents
react-native-form-generator ships with an implementation ok KeyboardAwareScrollView that make handling keyboard events a breeze.
check here https://medium.com/@michaelcereda/react-native-forms-the-right-way-315802f989d6#.p9oj79vt3
### Custom Fields
With react-native-form-generator is extremely easy to create your own custom fields.
You just need to know that:
1. Every field is a react component
2. Evey field will receive 3 props from the Form object:
- fieldRef: contains the reference of the field (workaround on a react-native bug).
- onChange: must be called every time i want to update the values inside the form component. (required)
- onValueChange: can be used whenever you prefer to pass the values to another component.
Example
```javascript
'use strict';
import {Field} from '../lib/Field';
export class SimpleInputField extends React.Component{
constructor(props){
super();
}
}
handleChange(event){
var value = event.nativeEvent.text;
this.setState({value:value});
// This updates values in form everytime i update
if(this.props.onChange) this.props.onChange(this.props.fieldRef, value);
if(this.props.onValueChange) this.props.onValueChange(value);
}
render(){
return(
)
}
}
```
### Wrapping fields
You can decide to wrap every field in a component to mantain design uniformity and avoid repetitions (ex. Icons ?!).
Battle tested example
```javascript
import {PickerField, LinkField} from 'react-native-form-generator';
import Icon from 'react-native-vector-icons/Ionicons';
let {
StyleSheet
} = React;
export class WrappedLinkField extends React.Component{
render(){
return
}
}
export class WrappedPickerField extends React.Component{
render(){
return
}
/>
}
}
let formStyles = StyleSheet.create({
alignRight:{
marginTop: 7, position:'absolute', right: 10
}
});
```