rn-formly v1.0.26

Note:

Typescript Suppoerted

Create beautiful React-Native forms within minutes with validator, progress-bar, custom error handling by passing just JSON

If you find this repo useful, please give it a star on github

	Status
Dependencies
Package
License

⭐ Features

• 10+ fully customisable component ready to be used by passing a json (including support for loading data asynchronously)
• Can easily manage Safe Area for devices with notch
• Ingerated with optional progress bar to show user their progress while filling up a form
• Allows throwing custom error and data validation
• Includes loading component
• Instant support for feature and issue using git issue tracker

Index

• Screenshots
• Installation
• Basic Usage and Global Props
• Supported Components and Props Index
• Structuring your Array Object

Screenshots

Installation

RN-Formly use following as peerDependency 1. react-native-device-info 2. react-native-image-crop-picker

npm i react-native-image-crop-picker react-native-device-info rn-formly --save

For iOS, If you are using React Native => 0.60 then simple do

pod install 

else follow this guide

Setting up image crop picker

IOS setup

Image Crop picker requires you to have relevant permission to access camera and storage for both iOS and Android

1. Go to info.plist and add this

<plist version="1.0">
  <dict>
    ...
    <key>NSPhotoLibraryUsageDescription</key>
    <string>$(PRODUCT_NAME) would like access to your photo gallery</string>
    <key>NSCameraUsageDescription</key>
    <string>$(PRODUCT_NAME) would like to use your camera</string>
    <key>NSPhotoLibraryAddUsageDescription</key>
    <string>$(PRODUCT_NAME) would like to save photos to your photo gallery</string>
    <key>NSMicrophoneUsageDescription</key>
    <string>$(PRODUCT_NAME) would like to use your microphone (for videos)</string>
  </dict>
</plist>

You refer to following documentation for more information (and probably for integration in complex project)

or look into this commit

Android Setup

Add following lines in your android/app/src/main/AndroidManifest.xml

 <uses-permission android:name="android.permission.INTERNET" />
 <uses-permission android:name="android.permission.CAMERA" />
 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

look at this commit

If this does not work, refer to following instructions.

1. For Image Croper
2. For React Native Device Info

Usage

To get started/or a try it out, you can clone or check out the following repo

Minimilistic Setup Example

import SignupFormComponent from 'rn-formly';


const inputFields = [
  {
    key: 'name', 
    type: 'text', 
    label: `Your Full Name`,
    required: true,
    helper: 'Using your real name would make it more likely for you to get a match',
    templateOptions: { 
      componentProps: {
        placeholder: 'Frank Murphy'
      }
    }
  }, 
  {
    key: 'otp', 
    type: 'otp', 
    label: 'Enter OTP',
    helper: '(optional) but try to enter incorrect date', 
    templateOptions: {
      noOfTextInput: 5,
    }
  }]
  
  const App: () => React$Node = () => {

  const justLogDataFromForms = (index, key, currentValue,  payload) => {
     console.log('Logging from Parent log')
    console.log(index, key, currentValue, payload)
  }

  return (
    <>
      <SignupFormComponent 
      inputFields={inputFields}
      globalButtonText={'Next'}
      onButtonClick={justLogDataFromForms}
      defaultColor={'green'}
      progressBarProps={{
        blink: false
      }}
      /> 
    </>
  );
};

Example usage of all the component can be seen using this file

Required Props

This is how error handling is done behind the scene: if (error.message) setErrorData({status: true, message: error.message})

Optional Props

Important Props are highlighted.

General Optional Props

Button Optional props

Validation and Error throwing are done in inputFields array. See inputFields section to know more

Error Props

Validation and Error throwing is done in the inputFields array. See inputFeilds section to know more.

Note

1. for stylesheet object type props. you need to pass props like this

const styles = StyleSheet.create({
  someStyle: {
    ....
    ....
  }, 
})

and then pass styles.someStyle in props

2. For stylesheet object, Default None does not mean that element won't have any styles; the props provided by the user would override the default styling.

inputFields Props

inputFields Props supports most of the popular components you would need in a form. If we are missing any component, create an issue, and we should be able to add within 2-4 days.

Currently Supported Component

1. Text
2. dataTyper
3. checkboxes
4. picker
5. image,
6. images
7. AutoComplete
8. otp

Structuring your Array Object

  {
    key: 'name', 
    type: 'text', 
    label: 'Your Full Name',
    helper: 'Using your real name would make it more likely for you to get a match',
    templateOptions: { 
      componentProps: {
        placeholder: 'Frank Murphy'
      },
      templateStyle: styles.textStyle // refer to the style component
    }
  }

Global Properties for each object

Text Component

{
    key: 'name', 
    type: 'text', 
    label: 'Your Full Name',
    helper: 'Using your real name would make it more likely for you to get a match',
    templateOptions: { 
      componentProps: {
        placeholder: 'Frank Murphy'
      },
      templateStyle: styles.textStyle // refer to the style component
    }
  }

Component level Props are mostly passed in templateOptions

Default Value type: string

TemplateOptions keys with value

dateTyper

  {
    key: 'dob', 
    type: 'dateTyper', //change this to Dob component
    label: 'Your Date of birth',
    helper: 'Your Birthdate will help us in connecting you with people of similar age',
    required: true
  }, 

TemplateOptions key/value

Default Value type: Array of strings or string

checkboxes

  {
    key: "gender", 
    type: 'checkboxes',
    label: 'Select your Gender', 
    helper: '(Optional), Please select a gender', 
    templateOptions: {
      options: [
  {
  key: 'male',
  label: 'Male',
  value: false 
  },
  {
    key: 'female', 
    label: 'Female',
    value: false
  },
  {
    key: 'others', 
    label: 'Others',
    value: false
  }
]
    }
  }, 

TemplateOptions key/value

image (single image)

  {
    key: 'image',
    type:'image', 
    label: "Upload your cover image", 
    helper: 'You can change your profile pic anytime from settings',
    templateOptions: {
     cropHeight: 200,
     cropWidth: 300
    }
  },

defaultValue type: ImageType;

TemplateOptions key/value

images

  {
    key: 'image',
    type:'images', 
    label: "Upload your cover image", 
    helper: 'You can change your profile pic anytime from settings',
    templateOptions: {
     cropHeight: 200,
     cropWidth: 300
    }
  },

defaultValue type: Array of ImageType;

TemplateOptions key/value

OTP

   {
    key: 'otp', 
    type: 'otp', 
    label: 'Enter OTP',
    helper: '(optional) but try to enter incorrect date', 
    templateOptions: {
      noOfTextInput: 5,
    }
  }, 

TemplateOptions key/value

AutoComplete

{
    key: 'autoComplete', 
    type: 'autoComplete', 
    label: 'Type Programming language',
    helper: "This is an example of Auto Complete Component, Don't try to make sense out of the returned data",
    templateOptions: { 
      asyncFunction: async function (text) {
        return async data
      }
    }
  }

Where data should be object Array containg id, value, title

 [{
    { 
      id: 1,
      title: "Javascript",
      value: "javascript"
    },
    { 
      id: 2,
      title: "Java",
      value: "java"
  },
}]

Click here to see the example da

TemplateOptions key/value

Picker

  {
    key: "gender", 
    type: 'picker',
    label: 'Select your Gender', 
    helper: '(Optional), Please select a gender', 
    templateOptions: {
      options: [
  {
  key: 'male',
  label: 'Male',
  value: false 
  },
  {
    key: 'female', 
    label: 'Female',
    value: false
  },
  {
    key: 'others', 
    label: 'Others',
    value: false
  }
]
    }
  }, 

TemplateOptions key/value