1. Home
  2. Docs
  3. Documentation
  4. Core Modules
  5. Profile

Profile

Core/Profile is a module containing most of the logic behind the user settings screens. These are screens that are common to any mobile app, such as:

  • Account Details screen IMEditProfileScreen
  • Settings screen IMUserSettingsScreen
  • Contact us screen IMContactUsScreen

One of the most important components that all these screens rely on is IMFormComponent, which is a generic React Native UI component, that lives in Core/profile/ui and which has the functionality of rendering advanced forms.

Forms

As mentioned below, IMFormComponent is a custom UI component that is capable of rendering a complex form, where all its fields are passed in as a config object in its props.

It has support for rendering:

  • text fields
  • button fields
  • select fields
  • switch fields

It also communicates back all the actions taken by the user, via two methods:

  • onFormButtonPress – this is called when a button field is pressed
  • onFormChange – this is called when any of the form fields changes its value (text, switch, etc)

The main important property of the IMFormComponent is its form parameter, which stores the state of the form.

Here’s an example of how the form parameter looks like for our Account Details screen:

form: {
   sections: [
     {
       title: IMLocalized("PUBLIC PROFILE"),
       fields: [
         {
           displayName: IMLocalized("First Name"),
           type: 'text',
           editable: true,
           regex: regexForNames,
           key: 'firstName',
           placeholder: 'Your first name'
         },
         {
           displayName: IMLocalized("Last Name"),
           type: 'text',
           editable: true,
           regex: regexForNames,
           key: 'lastName',
           placeholder: 'Your last name'
         }
       ]
     },
     {
       title: IMLocalized("PRIVATE DETAILS"),
       fields: [
         {
           displayName: IMLocalized("E-mail Address"),
           type: 'text',
           editable: false,
           key: 'email',
           placeholder: 'Your email address'
         },
         {
           displayName: IMLocalized("Phone Number"),
           type: 'text',
           editable: true,
           regex: regexForPhoneNumber,
           key: 'phone',
           placeholder: 'Your phone number'
         }
       ]
     }
   ]
 }

By passing this config object as the form prop into the IMFormComponent, a beautiful native form will be rendered properly.

As you can see, the form config is made up of:

  • an array of sections
  • each section, contains
    • title
    • array of fields
  • each field contains a few parameters describing the field
    • type
    • displayName
    • regex (this is optional and used for form validation)
    • key (a unique identifier useful in processing the form)
    • placeholder (optional – useful for fields such as a textfield)

Changing Profile Fields

We made it easy to customize all the fields that are required by your app for the profile, settings and contact us default screens.

If you open the main config.js file of your premium React Native template, you’ll notice the following three fields:

editProfileFields: {...}
userSettingsFields: {...}
contactUsFields: {...}

You can simply edit these fields and sections to add, remove, and edit any form fields that you want. The changes will automatically be reflected in the 3 screens on the profile flow.

Was this article helpful to you? Yes No

How can we help?