Home Reference Source 
import TextType from 'formatron/src/types/data/text.js'
public class | source

TextType

Extends:

Type → DataType → TextType

The DataType for text values.

Name Type Attribute Description
type string
  • optional
  • default: 'raw'
 The type of text to handle. This affects both validation and display. 'raw' | 'email' | 'url' | 'ssn' | 'zipCode' | 'tel' | 'password'
multi boolean
  • optional
  • default: false
 Whether or not to allow newline characters in the text.
mask string
  • optional
  • default: '###-##-####' (for type='ssn' only)
 A mask to use while editing the value.

Static Member Summary

Static Public Members
public static

regexps: *

public static

Method Summary

Public Methods
public

filter(filterValue: *, rowValue: *): *

public

format(value: *): *

public
public

getDisplay(value: *): *

public

getMask(): *

public

getType(): *

public

hasValue(value: *, checkDefault: *): *

public
public

validate(value: *): *

Inherited Summary

From class Type
public static

The type name.
public static

parse(field: object | Immutable.Map, parseField: function): Type

Parses a JS or Immutable.js object into a type.
public static

parseOneOrMany(parseField: func): oneOrManyParser

Creates a one or many parser with the passed in field parser.
public static

parseOptions(field: Immutable.Map, parseField: function): Immutable.Map

Override this function if you want the type to reference other types.
From class DataType
public static

The data type name.
public static

parse(field: *, parseField: *): *

public

name: *

public

options: *

public

exclude(model: *, deep: boolean): *

public

filter(filterValue: *, rowValue: *): *

public

getDefaultValue(defaultValue: undefined): *

public

getDisplay(value: *): string

Returns the value parsed for human consumption.
public

getField(ref: *): *

public

getFieldAndValue(value: *, ref: *): {"field": *, "value": *}

public

getName(): *

public

getOptions(): *

public
public
public

getValue(value: *, defaultValue: *): *

Returns a parsed value.
public

hasValue(value: object, checkDefault: boolean): boolean

Checks if the passed in value is "not empty".
public

isExcluded(): *

public
public

isRequired(): *

public

isUnique(): *

public

validate(value: *, callback: *): *

Validates that the given value follows the rules of the data type.

Static Public Members

public static regexps: * source

public static typeName: * source

The data type name. This must be overridden.

Override:

DataType#typeName

Public Methods

public filter(filterValue: *, rowValue: *): * source

Override:

DataType#filter

Params:

NameTypeAttributeDescription
filterValue *
rowValue *

Return:

*

public format(value: *): * source

Params:

NameTypeAttributeDescription
value *

Return:

*

public getDefaultValue(): * source

Override:

DataType#getDefaultValue

Return:

*

public getDisplay(value: *): * source

Returns the value parsed for human consumption.

Override:

DataType#getDisplay

Params:

NameTypeAttributeDescription
value *

Return:

*

public getMask(): * source

Return:

*

public getType(): * source

Return:

*

public hasValue(value: *, checkDefault: *): * source

Checks if the passed in value is "not empty".

Override:

DataType#hasValue

Params:

NameTypeAttributeDescription
value *
checkDefault *

Return:

*

public isMultiLined(): * source

Return:

*

public validate(value: *): * source

Validates that the given value follows the rules of the data type.

Override:

DataType#validate

Params:

NameTypeAttributeDescription
value *

Return:

*