Email Input State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Built-in State Variables
• Input SV Type Reference
• Text Input State Variable Reference

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
  • val()
  • isValid()
• Inherited properties
• DOM element properties

Introduction

Email Input state variables represent email address text inputs. They extend Text Input state variables, so the text format info properties apply. An empty value is valid, so an email input is not required.

Constructor

• Type string: 'emailInput', class: EmailInputSv

Syntax

ctl.createPage({
	...,
	stateVarInfo:[
		{type:'emailInput', ...},
	],
})

Parameters

• info
  An object containing the state variable properties. The info object can contain the following properties, but subclasses of StateVar may have additional properties:
  • StateVar info properties.
  • Model SV type info properties.
  • Input SV type info properties.
  • allCaps (optional)
    If true, input will be converted to all capitals.
  • maxLength (optional)
    The maximum length of a valid input string. Default: undefined.
  • minLength (optional)
    The minimum length of a valid input string. Default: 0.
  • pattern (optional)
    A RegExp for a valid input string.
  • size (optional)
    The width of the input field in characters. Default: maxLength or 16.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• InputSv methods
• Text input state variable methods

Note: The component() method returns an EmailInputSvComponent, a subclass of the Text Input component that sets the <input> type to email.

val()

Syntax

val(value)
val()

Gets or sets the value. Assigning a value that is not valid (see isValid()) causes an assertion failure.

isValid()

Syntax

isValid(value)
isValid()

Return true if value (or the current state variable value if omitted) is empty or is considered a valid email address. A non-empty value must match a basic address pattern: allowed local-part characters, followed by a @, followed by one or more dot-separated domain labels. A dot is not required in the domain, so a@b is valid.

Return value

A Boolean. Returns true if the current state variable value is considered valid and false otherwise.

Inherited properties

• StateVar properties
• ModelValueSv properties
• InputSv properties
• Text input state variable properties

DOM element properties

• Standard DOM element properties
• The emailInput Component will render an <input type="email"> element.
• The <input> element's value will be synchronized with the value of the associated state variable.
• The <input> element will have a className that contains 'svIo_emailInput'.