Â鶹¹ÙÍøÊ×Ò³Èë¿Ú

Constructor

new glow.forms.Form(formNode, opts)

Parameters

formNode

Type

glow.dom.NodeList | Selector

opts

Type

Optional

Yes

onValidate

Handles the 'validate' event when all tests are complete. Default is glow.forms.feedback.defaultFeedback.

Type

Optional

Yes

Examples

myForm = new glow.forms.Form("#htmlFormId" ,{
  onValidate: function(results) {
    // ...
  }
});

Properties

formNode

NodeList containing the form element

Type

glow.dom.NodeList

Methods

addTests

Add one or more tests to a field.

Synopsis

myForm.addTests(fieldName, spec);

Parameters

fieldName

Type

The name of the field to add tests to.

spec

Type

Optional

Yes

Test specifications identify the type of test to be run on a field to determine whether it contains desired data. See docs on the types of tests.

Example

//pattern for a test specification
[
  "testName", //name of the test to run
  {
    arg     : 5,                //an argument for the test, not all tests need this
    on      : "submit change",  //when should this test be run?
    message : "Incorrect value" //a custom error message to display
  }
]

//setting a form up for validation
var myForm = new glow.forms.Form(glow.dom.get("#myFormId"))
  .addTests(
    "username",
    ["required"],
    ["maxLen", {
      arg: 12,
      message: "Name must be les than 12 characters long."
    }]
  )
  .addTests(
    "email",
    ["isEmail"]
  );

validate

Run validation tests.

Synopsis

myForm.validate(eventName, fieldName);

Parameters

eventName

Type

Default

'submit'

Optional

Yes

Run only tests tied to this eventname.

fieldName

Type

Optional

Yes

Run only tests attached to the form element with this name.

Description

This is called automatically depending on the tests added to the form. However, you can trigger validation manually

Events

validate

Fired whenever the glow tries to validate a form.

Synopsis

glow.events.addListener(myForm, "validate", function(event) {
    // ...
});

Arguments

event

Type

glow.forms.ValidateResult

A specialised Event object.

Description

If you prefer you can set a handler for this event via the onValidate option of the glow.forms.Form constructor.

Example

glow.events.addListener(myForm, "validate", function(e) {
  if (e.eventName == 'submit') {
    if (e.errorCount == 0) { alert("Well done!"); }
    else { e.preventDefault(); } // stop the submit from happening
  }
});