Reusable Validation Method In SPFx

Recently I have implemented one reusable functions to validate the form in SPFx. In SPFx, we have so many react modules available in the market, but if we need some basic validation like required and regular we should install complete components into our solution and it will directly cause performance.

 

Develop SharePoint Framework Web Part

 

Open a command prompt. Create a directory for the SPFx solution.

 

md reusableformvalidations

 

Navigate to the above-created directory.

 

cd reusableformvalidations

 

Run the Yeoman SharePoint Generator to create the solution.

 

yo @microsoft/sharepoint

 

Yeoman generator will present you with the wizard by asking questions about the solution to be created. 

 

 

Solution Name - Hit enter to have default name (reusableformvalidations in this case) or type in any other name for your solution.

Selected choice: Hit enter

 

Target for the component - Here we can select the target environment where we are planning to deploy the client web part i.e. SharePoint Online or SharePoint On-Premises (SharePoint 2016 onwards).

Selected choice: SharePoint Online only (latest)

 

Place of files - We may choose to use the same folder or create a sub-folder for our solution.

Selected choice: Same folder

 

Deployment option - Selecting Y will allow the app to be deployed instantly to all sites and will be accessible everywhere.

Selected choice: Y

 

Type of client-side component to create - Generator will only allow you to create a web part.

Selected choice: WebPart

 

Web part name - Hit enter to select the default name or type in any other name.

Selected choice: reusableformvalidations

 

Web part description - Hit enter to select the default description or type in any other value.

Selected choice: ””.

 

Framework to use - Select any JavaScript framework to develop the component. Available choices are (No JavaScript Framework, React, and Knockout)

Selected choice:React Framework

 

Yeoman generator will perform scaffolding process to generate the solution. The scaffolding process will take a significant amount of time.

 

Once the scaffolding process is completed, lock down the version of project dependencies by running the below command.

 

npm shrinkwrap

 

In the command prompt type the below command to open the solution in the code editor of your choice.

 

code .

 

I am choosing to do very basic validations so I have created the below list of columns for the SharePoint list.

 

List Name - Employee Details.

 

Columns

 

First Name	Single Line of Text (internal name will be FirstName)
Last Name	Single Line of Text(internal name will be LastName)
Department	Choice with (HR, IT, Admin) (internal name will be Department)
Gender	Choice with (Male, Female) (internal name will be Gender)
Mobile Number	Number (internal name will be MobileNumber)

 

I have implemented the below reusable method which will accept data and fields as the below format.

inValidDataMsgs: { "CategoryId required": "Please Select Agenda Category", "Title required": "Please enter Title" },
      validationFields: {
        "required": ["CategoryId", "Title"]
      },

Calling
let validationResult = CommonMethods.ValidateForm(this.state.item, this.state.validationFields);

    if (validationResult["isValid"]) {
}
else {
      let validationMsg = "";
      let msgs = this.state.inValidData;
      for (let vMsg in validationResult) {
        if (validationResult.hasOwnProperty(vMsg) && vMsg != "isValid")
          validationMsg += msgs[validationResult[vMsg]] + "\n";
      }
      alert(validationMsg);
    }

Reusable Class

export default class CommonMethods {
  public static ValidateForm(data, fields) {
    let validationCheckResult = { isValid: true };
    let isValid = true;
    for (let optType in fields) {
      switch (optType) {
        case "required":
          for (let fieldIndex = 0; fieldIndex < fields[optType].length; fieldIndex++) {
            let currentValue = data[fields[optType][fieldIndex]];
            if (!currentValue || currentValue == -1 || (Array.isArray(currentValue) && currentValue.length == 0)) {
              validationCheckResult[fields[optType][fieldIndex]] = fields[optType][fieldIndex] + " required";
              isValid = false;
            }
          }
          break;
        case "regular":
          for (let fieldKey in fields[optType]) {
            if (fields[optType].hasOwnProperty(fieldKey)) {
              if (!validationCheckResult[fieldKey]) {
                let regExp = new RegExp(fields[optType][fieldKey]);
                let result = regExp.test(data[fields[optType][fieldKey]]);
                if (!result) {
                  isValid = false;
                  validationCheckResult[fieldKey] = fieldKey + " is not Valid";
                }
              }
            }
          }
          break;
      }
      validationCheckResult["isValid"] = isValid;

    }
    return validationCheckResult;
  }
}

For complete usage, please download the attachment.