.rules()

rules()Returns: Object

Description: Read, add and remove rules for an element.

  • rules()

    • This method does not accept any arguments.
  • rules( “add”, rules )

    • “add”
      Type: String
    • rules
      Type: Object
      The rules to add. Accepts the same format as the rules-option of the validate-method.
  • rules( “remove”, rules )

    • “remove”
      Type: String
    • rules
      Type: Object
      The space-seperated names of rules to remove and return. If left unspecified, removes and returns all rules. Manipulates only rules specified via rules-option or via rules(“add”).
Returns the validations rules for the first selected element or

Adds the specified rules and returns all rules for the first matched element. Requires that the parent form is validated, that is, $( “form” ).validate() is called first or

Removes the specified rules and returns all rules for the first matched element.

There are several ways to specify validation rules.

  • Validation methods without parameters can be specified as classes on the element (recommended)
  • Validation methods with parameters can be specified as attributes (recommended)
  • Both can be specified as metadata using the metadata plugin
  • Both can be specified using the rules-option of the validate()-method

When setting, the rules can also contain a messages-object, specifying custom messages for existing or added rules.

Examples:

Example: Adds minlength: 2 to an element which is already required.

1
2
3
$( "#myinput" ).rules( "add", {
minlength: 2
});

Example: Adds required and minlength: 2 to an element and specifies custom messages for both.

1
2
3
4
5
6
7
8
$( "#myinput" ).rules( "add", {
required: true,
minlength: 2,
messages: {
required: "Required input",
minlength: jQuery.format("Please, at least {0} characters are necessary")
}
});

Example: Removes all static rules from an element.

1
$( "#myinput" ).rules( "remove" );

Example: Removes min and max rules from an element.

1
$( "#myinput" ).rules( "remove", "min max" );