Notice: You're viewing an old version of the Nylo documentation.
Consider upgrading your project to Nylo 6.x.

Basics

Validation

Introduction
Validation Rules

Introduction

In Nylo, we provide a simple way to can start validating your user's input and show them feedback through an alert.

We currently have some basic validation rules but we'll be adding more in the future.

Let's take a look at how validation works in Nylo.

class ExamplePage extends NyStatefulWidget {
  final ExampleController controller = ExampleController();
  ...
}

class _ExampleState extends NyState<ExamplePage> {
  TextEditingController _textFieldControllerEmail = TextEditingController();
  ...

  handleForm() {
    String textEmail = _textFieldControllerEmail.text;

    try {
      this.validator(rules: {
          "email address": "email"
        }, data: {
          "email address": textEmail
      });
      // will show alert error if fails the validation and throw exception
    } on ValidationException catch(e) {
      print(e.toString());
    }
  }
}

Options:

this.validator(
  rules: {
  "email address": "email|max:10" // checks data is an email and maximum of 10 characters
  }, data: {
    "email address": textEmail // data to be validated
  }, message: {
    "email address": "oops|it failed" // first section is title, then add a " | " and then provide the the description
  },
  showAlert: true, // if you want Nylo to display the alert, default : true
  alertStyle: ToastNotificationStyleType.DANGER // choose from SUCCESS, INFO, WARNING and DANGER
);

This method is handy if you want to quickly validate the user's data and display some feedback to the user.

Validation Rules

Here are the available validation rules that you can use in Nylo.

Rule Name	Usage	Info
Email	email	Checks if the data is a valid email
Contains	contains:jeff,cup,example	Checks if the data contains a value
URL	url	Checks if the data is a valid url
Boolean	boolean	Checks if the data is a valid boolean
Min	min:5	Checks if the data is a minimum of x characters
Max	max:11	Checks if the data is a maximum of x characters

This allows you to validate if the input is an email.

Usage: email

boolean

This allows you to validate if the input is a boolean.

Usage: boolean

contains

Check if the input contains a particular value.

Usage: contains:dog,cat

url

Check if the input is a URL.

Usage: url

min

Check if the input is a minimum of characters.

Usage: min:7 - will fail if the user's input is less than 7 characters.

max

Check if the input is a maximum of characters.

Usage: max:10 - will fail if the user's input is more than 10 characters.