Text Input State Variable Reference

Related documents

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

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
• Instance properties
  • Inherited properties
  • allCaps
  • maxLength
  • minLength
  • pattern
  • size
• Component attributes
  • Inherited attributes
• DOM element properties

Introduction

Text Input state variables represent text inputs. Each rendered component will display according to the format specified in the state variable.

Constructor

• Type string: 'textInput', class: TextInputSv

Syntax

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

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

Note: The component() method returns a TextInputSvCmp.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• InputSv properties

allCaps

If true, the value will be converted to all capitals when assigned due to user input or otherwise.

Value

A Boolean.

maxLength

The maximum length of a valid input string. Default: undefined.

Value

An integer Number.

minLength

The minimum length of a valid input string.

Value

An integer Number.

pattern

A RegExp for a valid input string.

Value

A RegExp.

size

The width of the input field in characters. Default: maxLength or 16.

Value

An integer Number.

Component attributes

Inherited attributes

• Component attributes

DOM element properties

• Standard DOM element properties
• The textInput Component will render an <input type="text"> with maxLength, minLength, pattern, and size attributes set according to the state variable instance properties.
• The maxLength, minLength, pattern, and size attributes will be synchronized with the respective state variable properties.
• The <input> element will have a className that contains 'svIo_textInput'.