<ExtEmailfield/> Ext.field.Email

alignSelf : String

<ExtEmailfield alignSelf="value" />

let element = document.body.querySelector('ExtEmailfield');
element.alignSelf = 'value';
let alignSelf = element.alignSelf;

Specifies the self alignment of this widget in a box layout

Defaults to:

null

alwaysOnTop : Boolean / Number

<ExtEmailfield [alwaysOnTop]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.alwaysOnTop = true;
let alwaysOnTop = element.alwaysOnTop;

A flag indicating that this component should be above its floated siblings.

This may be a positive number to prioritize the ordering of multiple visible always on top components.

This may be set to a negative number to prioritize a component to the bottom of the z-index stack.

Defaults to:

false

Available since: 6.2.0

animateUnderline : Boolean

<ExtEmailfield [animateUnderline]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.animateUnderline = true;
let animateUnderline = element.animateUnderline;

'true' to animate the underline of a field when focused

Defaults to:

false

ariaAttributes : Object

<ExtEmailfield ariaAttributes="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.ariaAttributes = { };
let ariaAttributes = element.ariaAttributes;

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state, such as aria-live, aria-flowto, etc.

Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.

Defaults to:

null

ariaDescribedBy : String

immutable imm

<ExtEmailfield ariaDescribedBy="value" />

let element = document.body.querySelector('ExtEmailfield');
element.ariaDescribedBy = 'value';
let ariaDescribedBy = element.ariaDescribedBy;

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

ariaLabel : String

immutable imm

<ExtEmailfield ariaLabel="value" />

let element = document.body.querySelector('ExtEmailfield');
element.ariaLabel = 'value';
let ariaLabel = element.ariaLabel;

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabel and ariaLabelledBy config options are mutually exclusive.

ariaLabelledBy : String

immutable imm

<ExtEmailfield ariaLabelledBy="value" />

let element = document.body.querySelector('ExtEmailfield');
element.ariaLabelledBy = 'value';
let ariaLabelledBy = element.ariaLabelledBy;

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by id, the label element can be any existing element, not necessarily a child of the main Component element.

ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.

ariaRole : String

readonly ro

<ExtEmailfield ariaRole="value" />

let element = document.body.querySelector('ExtEmailfield');
let ariaRole = element.ariaRole;

ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set.

autoComplete : Boolean

<ExtEmailfield [autoComplete]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.autoComplete = true;
let autoComplete = element.autoComplete;

`false to disable autocomplete on this text field. Autocomplete is enabled by default on text fields, but disabled on picker fields.

Defaults to:

true

autoCorrect : Boolean

<ExtEmailfield [autoCorrect]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.autoCorrect = true;
let autoCorrect = element.autoCorrect;

True to set the field DOM element autocorrect attribute to "on", false to set to "off".

Defaults to:

null

autoFitErrors : Boolean

<ExtEmailfield [autoFitErrors]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.autoFitErrors = true;
let autoFitErrors = element.autoFitErrors;

Whether to adjust the field's body width to make room for the error messages.

Defaults to:

true

autoHideInputMask : Boolean

<ExtEmailfield [autoHideInputMask]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.autoHideInputMask = true;
let autoHideInputMask = element.autoHideInputMask;

Specify as false to always show the inputMask.

Defaults to:

true

Available since: 6.5.0

axisLock : Boolean

<ExtEmailfield [axisLock]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.axisLock = true;
let axisLock = element.axisLock;

If true, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints fail, only fallback to "r-l" is considered.

Defaults to:

null

badFormatMessage : String

immutable imm

<ExtEmailfield badFormatMessage="value" />

let element = document.body.querySelector('ExtEmailfield');
element.badFormatMessage = 'value';
let badFormatMessage = element.badFormatMessage;

The error message that will be displayed if the value cannot be parsed (for some derived types) or if the value does not match a configured inputMask.

Defaults to:

'Value does not match the required format'

Available since: 6.5.0

bind : Object / String

<ExtEmailfield bind="value" />

let element = document.body.querySelector('ExtEmailfield');
element.bind = 'value';
let bind = element.bind;

Setting this config option adds or removes data bindings for other configs. For example, to bind the title config:

 var panel = Ext.create({
     xtype: 'panel',
     bind: {
         title: 'Hello {user.name}'
     }
 });

To dynamically add bindings:

 panel.setBind({
     title: 'Greetings {user.name}!'
 });

To remove bindings:

 panel.setBind({
     title: null
 });

The bind expressions are presented to Ext.app.ViewModel#bind. The ViewModel instance is determined by lookupViewModel.

Note: If bind is passed as a string, it will use the Ext.Component#property-defaultBindProperty for the binding.

Defaults to:

null

border : Boolean

<ExtEmailfield [border]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.border = true;
let border = element.border;

Enables or disables bordering on this component. The following values are accepted:

• null or `true (default): Do nothing and allow the border to be specified by the theme.
• false: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a border-color or border-style CSS property to the component; you provide the border-color and border-style via CSS rule or style configuration (if not already provide by the theme).

Using style:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    style: 'border: 1px solid blue;'
    // ...
});

Using CSS:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    cls: 'my-component'
    // ...
});

And your CSS file:

.my-component {
    border: 1px solid red;
}

Defaults to:

null

bottom : Number / String

<ExtEmailfield [bottom]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.bottom = 'value';
let bottom = element.bottom;

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

bubbleDirty : Boolean

<ExtEmailfield [bubbleDirty]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.bubbleDirty = true;
let bubbleDirty = element.bubbleDirty;

Set to false to disable dirty states affecting ancestor containers such as fieldpanel or formpanel. The dirty state of such containers is based on the presence of dirty descendants. In some cases, however, it may be desired to hide the dirty state of one of these containers from its ancestor containers.

Defaults to:

true

Available since: 7.0

centered : Boolean

<ExtEmailfield [centered]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.centered = true;
let centered = element.centered;

Configure this as true to have this Component centered within its Container. Setting this value to true will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

false

clearable : Boolean

<ExtEmailfield [clearable]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.clearable = true;
let clearable = element.clearable;

true to show a clear trigger in this field when it has a non-empty value

Defaults to:

true

cls : String / String[]

<ExtEmailfield cls="value" />

let element = document.body.querySelector('ExtEmailfield');
element.cls = 'value';
let cls = element.cls;

The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a <ExtContainer/>).

Defaults to:

null

constrainAlign : String / Ext.util.Region / Ext.dom.Element

<ExtEmailfield constrainAlign="value" />

let element = document.body.querySelector('ExtEmailfield');
element.constrainAlign = 'value';
let constrainAlign = element.constrainAlign;

A specification of the constraint to apply when showBy or alignTo is called to align a floated or positioned component.

Defaults to the parent container for positioned components (components which have their top, right, bottom or left set to move them out of their container's layout flow).

Defaults to the viewport for floated components.

May be a Ext.ComponentQuery selector to find an ancestor component to constrain within.

May be false to specify that constraining is not applied.

You may also specify an element, or a Ext.util.Region

Defaults to:

null

containsFocus : Boolean

readonly ro

<ExtEmailfield [containsFocus]="true" />

let element = document.body.querySelector('ExtEmailfield');
let containsFocus = element.containsFocus;

true if this currently focused element is within this Component's or Container's hierarchy. This property is set separately from hasFocus, and can be true when hasFocus is false.

Examples:

• Text field with input element focused would be: focusable: true, hasFocus: true, containsFocus: true

• Date field with drop-down picker currently focused would be: focusable: true, hasFocus: false, containsFocus: true

• Form Panel with a child input field currently focused would be: focusable: false, hasFocus: false, containsFocus: true

See also hasFocus.

Defaults to:

false

contentEl : Ext.dom.Element / HTMLElement / String

<ExtEmailfield contentEl="value" />

let element = document.body.querySelector('ExtEmailfield');
element.contentEl = 'value';
let contentEl = element.contentEl;

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Defaults to:

null

controller : String / Object / Ext.app.ViewController

<ExtEmailfield controller="value" />

let element = document.body.querySelector('ExtEmailfield');
element.controller = 'value';
let controller = element.controller;

A string alias, a configuration object or an instance of a ViewController for this container. Sample usage:

Ext.define('MyApp.UserController', {
    alias: 'controller.user'
});

Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: 'user'
});
// Or
Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: {
        type: 'user',
        someConfig: true
    }
});

// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
    controller: ctrl
});

Defaults to:

null

data : Object

<ExtEmailfield data="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.data = { };
let data = element.data;

The initial set of data to apply to the tpl to update the content area of the Component.

Note: Data will be appended to any existing data.

Defaults to:

null

dataType : Ext.data.field.Field / Object / String

<ExtEmailfield dataType="value" />

let element = document.body.querySelector('ExtEmailfield');
element.dataType = 'value';
let dataType = element.dataType;

A config for a Ext.data.field.Field or data field sub-class instance used to serialize this field's value for form submission. This is used by the serialize method unless modelValidation is used, in which case, the data field of the bound Ext.data.Model is used.

For example:

 {
     xtype: 'datefield',
     dataType: {
         // type: 'date'  (datefield does this by default)
         dateWriteFormat: 'Y-m-d'
     }
 }

If this config is a string, it is used to create a Ext.data.field.Field by that alias.

Defaults to:

null

Available since: 7.0

defaultBindProperty : String

readonly ro

<ExtEmailfield defaultBindProperty="value" />

let element = document.body.querySelector('ExtEmailfield');
element.defaultBindProperty = 'value';
let defaultBindProperty = element.defaultBindProperty;

This property is used to determine the property of a bind config that is just the value. For example, if defaultBindProperty="value", then this shorthand bind config:

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

The defaultBindProperty is set to "value" for form fields and to "store" for grids and trees.

Defaults to:

'value'

defaultListenerScope : Boolean

<ExtEmailfield [defaultListenerScope]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.defaultListenerScope = true;
let defaultListenerScope = element.defaultListenerScope;

If true, this component will be the default scope (this pointer) for events specified with string names so that the scope can be dynamically resolved. The component will automatically become the defaultListenerScope if a controller is specified.

See the introductory docs for Ext.container.Container for some sample usages.

NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.

Defaults to:

false

destroyed : Boolean

readonly ro

<ExtEmailfield [destroyed]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.destroyed = true;
let destroyed = element.destroyed;

This property is set to true after the destroy method is called.

Defaults to:

false

dirty : Boolean

<ExtEmailfield [dirty]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.dirty = true;
let dirty = element.dirty;

This config property describes the modified state of this component. In most cases this config's value is maintained by the component and should be considered readonly. The class implementor should be the only one to call the setter.

For containers, this config will be updated on a short delay in some cases.

Defaults to:

false

Available since: 7.0

disabled : Boolean

<ExtEmailfield [disabled]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.disabled = true;
let disabled = element.disabled;

true to disable the field.

Be aware that conformant with the HTML specification, disabled Fields will not be submitted.

Defaults to:

false

displayed : Boolean

<ExtEmailfield [displayed]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.displayed = true;
let displayed = element.displayed;

Set to true to call show and false to call hide. Unlike the hidden config, changing this config will potentially involve animations to show or hide the component.

Defaults to:

null

Available since: 6.5.0

docked : String

<ExtEmailfield docked="value" />

let element = document.body.querySelector('ExtEmailfield');
element.docked = 'value';
let docked = element.docked;

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Defaults to:

null

draggable : Boolean / Object / Ext.drag.Source

<ExtEmailfield [draggable]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.draggable = true;
let draggable = element.draggable;

Set to true to allow this component to be dragged. This can also be the config object for the Ext.drag.Source that will manage the drag.

Defaults to:

null

editable : Boolean

<ExtEmailfield [editable]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.editable = true;
let editable = element.editable;

Configure as false to prevent the user from typing text directly into the field; the field can only have its value set programmatically or via an action invoked by a trigger.

Contrast with readOnly which disables all mutation via the UI.

Defaults to:

true

error : String / String[]

<ExtEmailfield error="value" />

let element = document.body.querySelector('ExtEmailfield');
element.error = 'value';
let error = element.error;

The error (or errors) to display for this field. This config is typically set by the field's validators but can be set directly if an error needs to be associated with a field manually.

Errors will be HTML encoded as necessary and errorTpl before becoming the current errorMessage.

Defaults to:

null

Available since: 6.5.0

errorMessage : String

<ExtEmailfield errorMessage="value" />

let element = document.body.querySelector('ExtEmailfield');
element.errorMessage = 'value';
let errorMessage = element.errorMessage;

The field's error message to display as errorTarget. This message must already be properly formatted and encoded as appropriate for the errorTarget.

Defaults to:

null

Available since: 6.5.0

errorTarget : String

<ExtEmailfield errorTarget="value" />

let element = document.body.querySelector('ExtEmailfield');
element.errorTarget = 'value';
let errorTarget = element.errorTarget;

The location where the error message text should display.

The following are values that have predefined meaning:

• qtip Display a Ext.tip.Manager containing the message when the user hovers (or taps) the field. For this option to work, quick tips must be enabled by calling Ext.tip.Manager#init.
• side Add an error icon to the right of the field, displaying the message in a popup on hover or tap.
• title Display the message in a default browser title attribute.
• under Add a div beneath the field containing the error message.

Defaults to:

'qtip'

Available since: 6.5.0

errorTip : Object

<ExtEmailfield errorTip="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.errorTip = { };
let errorTip = element.errorTip;

The default config that will be used to display errors in the tooltip.

Defaults to:

null

Available since: 6.5.0

errorTpl : String / String[] / Ext.XTemplate

<ExtEmailfield errorTpl="value" />

let element = document.body.querySelector('ExtEmailfield');
element.errorTpl = 'value';
let errorTpl = element.errorTpl;

The template used to format the error set for this field. By default, the errorTarget is used to determine whether the error(s) are formatted as an HTML list or as plain text.

Defaults to:

null

Available since: 6.5.0

factoryConfig : Object

readonly ro

<ExtEmailfield factoryConfig="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.factoryConfig = { };
let factoryConfig = element.factoryConfig;

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

flex : Number / String / Object

<ExtEmailfield [flex]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.flex = 'value';
let flex = element.flex;

The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.

You can also update the flex of a component dynamically using the Ext.layout.FlexBox#setItemFlex method.

When supplied as a string or number this option supports the same syntax as CSS flex. For example:

flex: '1 2 auto'

sets flex-grow property to 0, flex-shrink to 2 and flex-basis to 'auto'.

The default flex-shrink value for box layout items is set to 0 in the stylesheet, which is different from the browser's default flex-shrink value of 1. This accommodates the majority use case for applications since where non-flexed components are typically not expected to shrink smaller than their default size.

For convenience when only a single number is supplied it is used as the value for both flex-grow and flex-shrink, for example flex: 3 is the same as flex: '3 3'

An object form is also accepted:

flex: {
    grow: 1,
    shrink: 2,
    basis: 'auto'
}

When the object form is supplied shrink always defaults to 0 regardless of the value of grow.

Although 'auto' is the default value for flex-basis, flex-basis defaults to 0% when flex is supplied as a single numeric or string value (e.g. flex: 1). If this behavior is not desired either explicitly set flex-basis to 'auto' or use the object form to set only grow and/or shrink:

flex: {
    grow: 2
}

Defaults to:

null

floated : Boolean

<ExtEmailfield [floated]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.floated = true;
let floated = element.floated;

A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.

A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.

By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent floated component with cfg-relative: true.

Defaults to:

false

Available since: 6.2.0

floatingCls : String

readonly ro

<ExtEmailfield floatingCls="value" />

let element = document.body.querySelector('ExtEmailfield');
element.floatingCls = 'value';
let floatingCls = element.floatingCls;

The CSS class to add to this component when it is floated at the viewport level.

Defaults to:

Ext.baseCSSPrefix + 'floating'

focusCls : String

immutable imm

<ExtEmailfield focusCls="value" />

let element = document.body.querySelector('ExtEmailfield');
element.focusCls = 'value';
let focusCls = element.focusCls;

CSS class that will be added to focused component's focusClsEl, and removed when component blurs.

Defaults to:

'x-focused'

focusClsEl : Ext.dom.Element

readonly ro

<ExtEmailfield focusClsEl="value" />

let element = document.body.querySelector('ExtEmailfield');
element.focusClsEl = 'value';
let focusClsEl = element.focusClsEl;

The element that will have the focusCls applied when component's focusEl is focused.

focusEl : Ext.dom.Element

readonly ro

<ExtEmailfield focusEl="value" />

let element = document.body.querySelector('ExtEmailfield');
element.focusEl = 'value';
let focusEl = element.focusEl;

The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.

Defaults to:

'el'

focusable : Boolean

readonly ro

<ExtEmailfield [focusable]="true" />

let element = document.body.querySelector('ExtEmailfield');
let focusable = element.focusable;

true for keyboard interactive Components or Widgets, false otherwise. For Containers, this property reflects interactiveness of the Container itself, not its children. See isFocusable.

Note: It is not enough to set this property to true to make a component keyboard interactive. You also need to make sure that the component's focusEl is reachable via Tab key (tabbable). See also tabIndex.

Defaults to:

false

hasFocus : Boolean

readonly ro

<ExtEmailfield [hasFocus]="true" />

let element = document.body.querySelector('ExtEmailfield');
let hasFocus = element.hasFocus;

true if this component's focusEl is focused. See also containsFocus.

Defaults to:

false

hasListeners : Object

readonly ro

<ExtEmailfield hasListeners="{ }" />

let element = document.body.querySelector('ExtEmailfield');
let hasListeners = element.hasListeners;

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the Ext.app.EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }

height : Number / String

<ExtEmailfield [height]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.height = 'value';
let height = element.height;

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

hidden : Boolean

<ExtEmailfield [hidden]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.hidden = true;
let hidden = element.hidden;

Whether or not this Component is hidden (its CSS display property is set to none).

Defaults to true for floated Components.

Defaults to:

null

hideAnimation : String / Mixed

<ExtEmailfield hideAnimation="value" />

let element = document.body.querySelector('ExtEmailfield');
element.hideAnimation = 'value';
let hideAnimation = element.hideAnimation;

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

hideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

<ExtEmailfield hideMode="value" />

let element = document.body.querySelector('ExtEmailfield');
element.hideMode = 'value';
let hideMode = element.hideMode;

A String which specifies how this component's DOM element will be hidden. The accepted values are any of these:

• 'clip' : Hide using clip.
• 'display' : Hide using display.
• 'offsets' : Hide using positioning offsets.
• 'opacity' : Hide using opacity.
• 'visibility' : Hide using visibility.

Hiding using display results in having no dimensions as well as resetting scroll positions to 0.

The other modes overcome this but may have different trade-offs in certain circumstances.

Defaults to:

'display'

Available since: 6.5.0

hideOnMaskTap : Boolean

<ExtEmailfield [hideOnMaskTap]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.hideOnMaskTap = true;
let hideOnMaskTap = element.hideOnMaskTap;

When using a modal Component, setting this to true will hide the modal mask and the Container when the mask is tapped on.

Defaults to:

null

html : String / Ext.dom.Element / HTMLElement

<ExtEmailfield html="value" />

let element = document.body.querySelector('ExtEmailfield');
element.html = 'value';
let html = element.html;

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Defaults to:

null

id : String

immutable imm

<ExtEmailfield id="value" />

let element = document.body.querySelector('ExtEmailfield');
element.id = 'value';
let id = element.id;

The unique id of this component instance.

It should not be necessary to use this configuration except for singleton objects in your application. Components created with an id may be accessed globally using Ext.getCmp.

Instead of using assigned ids, use the itemId config, and Ext.ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The <ExtContainer/> class contains shortcut methods to query its descendant Components by selector.

Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.

Note: to avoid complications imposed by a unique id also see itemId.

Defaults to an auto-assigned id.

inheritUi : Boolean / String

readonly ro

<ExtEmailfield [inheritUi]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.inheritUi = true;
let inheritUi = element.inheritUi;

Set to true on widgets that should inherit ui from their parent container. This property is typically set on the class body, but can be set on an instance as long as it is set prior to the instance being added to its container. This property is inspected at the moment a widget is added to a container, and any UIs on the container are added to the widget at that time. Inherited UIs are in addition to the widget's own ui, and are updated when the container's UI changes.

Defaults to:

false

inline : Boolean

<ExtEmailfield [inline]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.inline = true;
let inline = element.inline;

true to cause this field to layout with inline element behavior. An inline field's width is determined by the total width of its label and body elements instead of automatically expanding to fill the width of its container.

Defaults to:

false

inputMask : String / Ext.field.InputMask

<ExtEmailfield inputMask="value" />

let element = document.body.querySelector('ExtEmailfield');
element.inputMask = 'value';
let inputMask = element.inputMask;

Important: To use this config you must require Ext.field.InputMask or use a complete framework build. The logic to implement an inputMask is not automatically included in a build.

Defaults to:

null

Available since: 6.5.0

isField : Boolean

readonly ro

<ExtEmailfield [isField]="true" />

let element = document.body.querySelector('ExtEmailfield');
let isField = element.isField;

true in this class to identify an object this type, or subclass thereof.

This is used by Ext.form.Panel#getValues to determine which components inside a form are fields.

Defaults to:

true

isObservable : Boolean

readonly ro

<ExtEmailfield [isObservable]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.isObservable = true;
let isObservable = element.isObservable;

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to:

true

itemId : String

<ExtEmailfield itemId="value" />

let element = document.body.querySelector('ExtEmailfield');
element.itemId = 'value';
let itemId = element.itemId;

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with Ext#getCmp, use itemId with Ext.Container#getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the itemId is scoped locally to the container - avoiding potential conflicts with Ext.ComponentManager which requires a unique id.

Also see id, Ext.Container#query, Ext.Container#down and Ext.Container#child.

Defaults to:

undefined

keyMap : Object

<ExtEmailfield keyMap="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.keyMap = { };
let keyMap = element.keyMap;

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function(either the literal function or the method name), or it can be an object with these properties:

• handler: The function or its name to call to handle the event.
• scope: The this pointer context (can be "this" or "controller").
• event: An optional override of the key event to which to listen.

Important: Calls to setKeyMap do not replace the entire keyMap but instead update the provided mappings. That is, unless null is passed as the value of the keyMap which will clear the keyMap of all entries.

Defaults to:

null

Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of cfg-listeners. It defaults to the "controller", but using 'this' means that an instance method will be used.

keyMapEnabled : Boolean

<ExtEmailfield [keyMapEnabled]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.keyMapEnabled = true;
let keyMapEnabled = element.keyMapEnabled;

Enables or disables processing keys in the keyMap. This value starts as null and if it is null when initKeyMap is called, it will automatically be set to true. Since initKeyMap is called by <ExtComponent/> at the proper time, this is not something application code normally handles.

Defaults to:

null

label : String

<ExtEmailfield label="value" />

let element = document.body.querySelector('ExtEmailfield');
element.label = 'value';
let label = element.label;

The label of this field

Defaults to:

null

labelAlign : 'top' / 'left' / 'bottom' / 'right'

<ExtEmailfield labelAlign="value" />

let element = document.body.querySelector('ExtEmailfield');
element.labelAlign = 'value';
let labelAlign = element.labelAlign;

When value is 'placeholder', the label text will be rendered as placeholder text inside the empty input and will animated to "top" alignment when the input is focused or contains text. The position to render the label relative to the field body.

Defaults to:

'left'

labelCls : String

<ExtEmailfield labelCls="value" />

let element = document.body.querySelector('ExtEmailfield');
element.labelCls = 'value';
let labelCls = element.labelCls;

Optional CSS class to add to the Label element.

Defaults to:

null

labelMinWidth : Number / String

<ExtEmailfield [labelMinWidth]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.labelMinWidth = 'value';
let labelMinWidth = element.labelMinWidth;

Min-width of this field's label.

Defaults to:

null

labelTextAlign : 'top' / 'right' / 'bottom' / 'left'

<ExtEmailfield labelTextAlign="value" />

let element = document.body.querySelector('ExtEmailfield');
element.labelTextAlign = 'value';
let labelTextAlign = element.labelTextAlign;

Text alignment of this field's label

Defaults to:

'left'

labelWidth : Number / String

<ExtEmailfield [labelWidth]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.labelWidth = 'value';
let labelWidth = element.labelWidth;

Width of this field's label. Can be a number of pixels or any valid CSS value, such as '30%'. To size the label to its text, use labelWidth: 'auto'

Defaults to:

null

labelWrap : Boolean

<ExtEmailfield [labelWrap]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.labelWrap = true;
let labelWrap = element.labelWrap;

true to allow the label to wrap. If set to false, the label will be truncated with an ellipsis.

Defaults to:

false

lastKeyMapEvent : Ext.event.Event

readonly ro

<ExtEmailfield lastKeyMapEvent="value" />

let element = document.body.querySelector('ExtEmailfield');
element.lastKeyMapEvent = 'value';
let lastKeyMapEvent = element.lastKeyMapEvent;

The last key event processed is cached on the component for use in subsequent event handlers.

Available since: 6.6.0

left : Number / String

<ExtEmailfield [left]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.left = 'value';
let left = element.left;

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

listeners : Object

<ExtEmailfield listeners="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.listeners = { };
let listeners = element.listeners;

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS <ExtComponent/>

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

margin : Number / String

<ExtEmailfield [margin]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.margin = 'value';
let margin = element.margin;

The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'

Defaults to:

null

maxHeight : Number / String

<ExtEmailfield [maxHeight]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.maxHeight = 'value';
let maxHeight = element.maxHeight;

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

maxLength : Number

<ExtEmailfield [maxLength]="10" />

let element = document.body.querySelector('ExtEmailfield');
element.maxLength = 10;
let maxLength = element.maxLength;

The maximum number of permitted input characters.

Defaults to:

null

maxWidth : Number / String

<ExtEmailfield [maxWidth]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.maxWidth = 'value';
let maxWidth = element.maxWidth;

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

minHeight : Number / String

<ExtEmailfield [minHeight]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.minHeight = 'value';
let minHeight = element.minHeight;

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

minWidth : Number / String

<ExtEmailfield [minWidth]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.minWidth = 'value';
let minWidth = element.minWidth;

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

modal : Boolean

<ExtEmailfield [modal]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.modal = true;
let modal = element.modal;

true to make this Component modal. This will create a mask underneath the Component that covers its parent and does not allow the user to interact with any other Components until this Component is dismissed.

Defaults to:

null

modelValidation : Boolean

immutable imm

<ExtEmailfield [modelValidation]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.modelValidation = true;
let modelValidation = element.modelValidation;

This config enables binding to your Ext.data.Model#validators. This is only processed by form fields (e.g., Ext.field.*) at present, however, this setting is inherited and so can be set on a parent container.

When set to true by a component (or by an ancestor container), the validators of for any {@Ext.data.Model record} fields will be used wherever the value is bound to such data fields.

While this config can be set arbitrarily high in the component hierarchy, doing so can create a lot overhead if most of your form fields do not actually rely on validators in your data model.

Using this setting for a form that is bound to an Ext.data.Model might look like this:

 {
     xtype: 'panel',
     modelValidation: true,
     items: [{
         xtype: 'textfield',
         bind: '{theUser.firstName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.lastName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.phoneNumber}'
     },{
         xtype: 'textfield',
         bind: '{theUser.email}'
     }]
 }

Defaults to:

null

Available since: 6.5.0

name : String

<ExtEmailfield name="value" />

let element = document.body.querySelector('ExtEmailfield');
element.name = 'value';
let name = element.name;

The field's name. Used by form panels to gather data to be submitted.

For <ExtInputfield/> this name is set as the name attribute of the inputElement

Defaults to:

null

nameable : Boolean

immutable imm

<ExtEmailfield [nameable]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.nameable = true;
let nameable = element.nameable;

Set to true for this component's name property to be tracked by its containing nameHolder.

Defaults to:

false

padding : Number / String

<ExtEmailfield [padding]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.padding = 'value';
let padding = element.padding;

The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'

Defaults to:

null

pattern : String

<ExtEmailfield pattern="value" />

let element = document.body.querySelector('ExtEmailfield');
element.pattern = 'value';
let pattern = element.pattern;

The value for the HTML5 pattern attribute. You can use this to change which keyboard layout will be used.

Ext.define('Ux.field.Pattern', {
    extend : 'Ext.field.Text',
    xtype  : 'patternfield',

    config : {

component : { pattern : '[0-9]*' } } });

Even though it extends <ExtTextfield/>, it will display the number keyboard.

Defaults to:

null

placeholder : String

<ExtEmailfield placeholder="value" />

let element = document.body.querySelector('ExtEmailfield');
element.placeholder = 'value';
let placeholder = element.placeholder;

A string value displayed in the input when the control is empty.

Defaults to:

null

plugins : Array / Ext.enums.Plugin / Object / Ext.plugin.Abstract

<ExtEmailfield plugins="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.plugins = { };
let plugins = element.plugins;

This config describes one or more plugin config objects used to create plugin instances for this component.

Plugins are a way to bundle and reuse custom functionality. Plugins should extend Ext.plugin.Abstract but technically the only requirement for a valid plugin is that it contain an init method that accepts a reference to its owner. Once a plugin is created, the owner will call the init method, passing a reference to itself. Each plugin can then call methods or respond to events on its owner as needed to provide its functionality.

This config's value can take several different forms.

The value can be a single string with the plugin's Ext.enums.Plugin:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: 'listpaging'
 });

In the above examples, the string "listpaging" is the type alias for listpaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

The preferred form for multiple plugins or to configure plugins is the keyed-object form (new in version 6.5):

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         pullrefresh: true,
         listpaging: {
             autoPaging: true,
             weight: 10
         }
     }
 });

The object keys are the id's as well as the default type alias. This form allows the value of the plugins to be merged from base class to derived class and finally with the instance configuration. This allows classes to define a set of plugins that derived classes or instantiators can further configure or disable. This merge behavior is a feature of the config.

The plugins config can also be an array of plugin aliases (arrays are not merged so this form does not respect plugins defined by the class author):

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

An array can also contain elements that are config objects with a type property holding the type alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['pullrefresh', {
         type: 'listpaging',
         autoPaging: true
     }]
 });

Defaults to:

null

publishes : String / String[] / Object

<ExtEmailfield publishes="value" />

let element = document.body.querySelector('ExtEmailfield');
element.publishes = 'value';
let publishes = element.publishes;

One or more names of config properties that this component should publish to its ViewModel. Generally speaking, only properties defined in a class config block (including ancestor config blocks and mixins) are eligible for publishing to the viewModel. Some components override this and publish their most useful configs by default.

Note: We'll discuss publishing properties not found in the config block below.

Values determined to be invalid by component (often form fields and model validations) will not be published to the ViewModel.

This config uses the cfg-reference to determine the name of the data object to place in the ViewModel. If reference is not set then this config is ignored.

By using this config and cfg-reference you can bind configs between components. For example:

 ...
     items: [{
         xtype: 'textfield',
         reference: 'somefield',  // component's name in the ViewModel
         publishes: 'value' // value is not published by default
     },{
         ...
     },{
         xtype: 'displayfield',
         bind: 'You have entered "{somefield.value}"'
     }]
 ...

Classes must provide this config as an Object:

 Ext.define('App.foo.Bar', {
     publishes: {
         foo: true,
         bar: true
     }
 });

This is required for the config system to properly merge values from derived classes.

For instances this value can be specified as a value as show above or an array or object as follows:

 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: [
         'value',
         'rawValue',
         'dirty'
     ]
 }

 // This achieves the same result as the above array form.
 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: {
         value: true,
         rawValue: true,
         dirty: true
     }
 }

In some cases, users may want to publish a property to the viewModel that is not found in a class config block. In these situations, you may utilize publishState if the property has a setter method. Let's use setFieldLabel as an example:

  setFieldLabel: function(fieldLabel) {
      this.callParent(arguments);
      this.publishState('fieldLabel', fieldLabel);
  }

With the above chunk of code, fieldLabel may now be published to the viewModel.

Defaults to:

{
    value: 1
}

readOnly : Boolean

<ExtEmailfield [readOnly]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.readOnly = true;
let readOnly = element.readOnly;

true to set the field DOM element readonly attribute to "true".

Mutation of <ExtTextfield/> through triggers is also disabled.

To simply prevent typing into the field while still allowing mutation through triggers, set editable to false.

Defaults to:

false

record : Ext.data.Model

<ExtEmailfield record="value" />

let element = document.body.querySelector('ExtEmailfield');
element.record = 'value';
let record = element.record;

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Defaults to:

null

reference : String

immutable imm

<ExtEmailfield reference="value" />

let element = document.body.querySelector('ExtEmailfield');
element.reference = 'value';
let reference = element.reference;

Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its Ext.app.ViewController. See the documentation in Ext.container.Container for more information about references.

Note: Valid identifiers start with a letter or underscore and are followed by zero or more additional letters, underscores or digits. References are case sensitive.

Defaults to:

null

relative : Boolean

<ExtEmailfield [relative]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.relative = true;
let relative = element.relative;

Only valid when a component is cfg-floated

Configure this as true if you require descendant floated components to be positioned relative to this component's coordinate space, not the viewport's coordinate space.

Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.

Defaults to:

false

Available since: 6.2.0

rendered : Boolean

readonly ro

<ExtEmailfield [rendered]="true" />

let element = document.body.querySelector('ExtEmailfield');
let rendered = element.rendered;

The rendered flag is set when a widget is inserted into the document for the first time.

Note that this is a one-way operation. The first time a widget is inserted into the document, this flag is set, and it is never unset.

required : Boolean

<ExtEmailfield [required]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.required = true;
let required = element.required;

true to make this field required.

Defaults to:

false

requiredMessage : String

<ExtEmailfield requiredMessage="value" />

let element = document.body.querySelector('ExtEmailfield');
element.requiredMessage = 'value';
let requiredMessage = element.requiredMessage;

The error message to display when required is true and the field's value is "empty" (null, undefined, or empty string).

Defaults to:

'This field is required'

right : Number / String

<ExtEmailfield [right]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.right = 'value';
let right = element.right;

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

ripple : Boolean / Object / String

<ExtEmailfield [ripple]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.ripple = true;
let ripple = element.ripple;

Set to truthy, Color or Object value for the ripple.

Defaults to:

null

Available since: 6.5.0

Properties

color : String

The background color of the ripple.

position : Array

Position for the ripple to start at [x,y]. Determines if a Ripple effect should happen whenever this element is pressed.

For example: { ripple: true }

Or:

 {
     ripple: {
         color: 'red'
     }
 }

For complex components, individual elements can suppress ripples by adding the x-no-ripple class to disable rippling for a tree of elements.

scrollable : Boolean / String / Object

<ExtEmailfield [scrollable]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.scrollable = true;
let scrollable = element.scrollable;

Configuration options to make this Component scrollable. Acceptable values are:

• true to enable auto scrolling.
• false (or null) to disable scrolling - this is the default.
• x or horizontal to enable horizontal scrolling only
• y or vertical to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);

Defaults to:

null

session : Boolean / Object / Ext.data.Session

<ExtEmailfield [session]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.session = true;
let session = element.session;

If provided this creates a new Session instance for this component. If this is a Container, this will then be inherited by all child components.

To create a new session you can specify true:

 Ext.create({
     xtype: 'viewport',
     session: true,

     items: [{
         ...
     }]
 });

Alternatively, a config object can be provided:

 Ext.create({
     xtype: 'viewport',
     session: {
         ...
     },

     items: [{
         ...
     }]
 });

Defaults to:

null

shadow : Boolean

<ExtEmailfield [shadow]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.shadow = true;
let shadow = element.shadow;

Configure as true for the component to have a drop shadow. 'false' will suppress any default shadow. By default the theme will determine the presence of a shadow.

Defaults to:

null

Available since: 6.2.0

shareableName : Boolean

immutable imm

<ExtEmailfield [shareableName]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.shareableName = true;
let shareableName = element.shareableName;

Set to true to allow this component's name to be shared by other items in the same nameHolder. Such items will be returned in an array from lookupName.

Defaults to:

false

shim : Boolean

<ExtEmailfield [shim]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.shim = true;
let shim = element.shim;

Only valid when a component is cfg-floated

Configure as true for the component to use an <iframe> as an underlay to ensure certain non-standard browser plugins are occluded by this component.

Defaults to:

false

Available since: 6.2.0

showAnimation : String / Mixed

<ExtEmailfield showAnimation="value" />

let element = document.body.querySelector('ExtEmailfield');
element.showAnimation = 'value';
let showAnimation = element.showAnimation;

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

stateId : String

<ExtEmailfield stateId="value" />

let element = document.body.querySelector('ExtEmailfield');
element.stateId = 'value';
let stateId = element.stateId;

The unique id for this object to use for state management purposes.

Defaults to:

null

stateful : Boolean / Object / String[]

<ExtEmailfield [stateful]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.stateful = true;
let stateful = element.stateful;

This config specifies the config properties that will be persisted using the Ext.state.Provider. If this config is set to true, the configs specified by statefulDefaults will be assumed.

 stateful: true

Otherwise, this config can be an array of strings of the properties to save:

 stateful: [
     'width',
     'height',
     'collapsed'
 ]

The above is equivalent to:

 stateful: {
     width: true,
     height: true,
     collapsed: true
 }

Note: To be truly stateful, an id or stateId must also be assigned.

A stateful object will save its state when any of these config properties change value.

Defaults to:

false

stripCharsRe : RegExp

immutable imm

<ExtEmailfield stripCharsRe="value" />

let element = document.body.querySelector('ExtEmailfield');
element.stripCharsRe = 'value';
let stripCharsRe = element.stripCharsRe;

A JavaScript RegExp object used to strip unwanted content from the value during input. If stripCharsRe is specified, every character sequence matching stripCharsRe will be removed.

style : String / Object

<ExtEmailfield style="value" />

let element = document.body.querySelector('ExtEmailfield');
element.style = 'value';
let style = element.style;

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

You can pass either a string syntax:

style: 'background:red'

Or by using an object:

style: {
    background: 'red'
}

When using the object syntax, you can define CSS Properties by using a string:

style: {
    'border-left': '1px solid red'
}

Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.

Defaults to:

null

tabIndex : Number

<ExtEmailfield [tabIndex]="10" />

let element = document.body.querySelector('ExtEmailfield');
element.tabIndex = 10;
let tabIndex = element.tabIndex;

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

textAlign : 'left' / 'center' / 'right'

<ExtEmailfield textAlign="value" />

let element = document.body.querySelector('ExtEmailfield');
element.textAlign = 'value';
let textAlign = element.textAlign;

The text alignment of this field.

Defaults to:

'left'

toFrontOnShow : Boolean

<ExtEmailfield [toFrontOnShow]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.toFrontOnShow = true;
let toFrontOnShow = element.toFrontOnShow;

True to automatically call toFront when a cfg-floated Component is shown.

Defaults to:

true

tooltip : String / Object

<ExtEmailfield tooltip="value" />

let element = document.body.querySelector('ExtEmailfield');
element.tooltip = 'value';
let tooltip = element.tooltip;

The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or <ExtTooltip/> config object.

The default behavior is to use a shared tip instance. The tooltip configuration is registered with the Ext.tip.Manager. To enable this, your application can set the Ext.app.Application#quickTips config, or an instance of the Ext.tip.Manager may be created manually.

To force a unique tooltip instance to be created, specify autoCreate: true on this configuration.

Configuring this with autoHide: false implies autoCreate: true so that the desired persistent behavior can be obtained with other targets still showing the singleton instance.

Defaults to:

null

top : Number / String

<ExtEmailfield [top]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.top = 'value';
let top = element.top;

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

touchAction : Object

<ExtEmailfield touchAction="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.touchAction = { };
let touchAction = element.touchAction;

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

Keys in this object are touch action names, and values are false to disable a touch action or true to enable it. Accepted keys are:

• panX
• panY
• pinchZoom
• doubleTapZoom

All touch actions are enabled (true) by default, so it is usually only necessary to specify which touch actions to disable. For example, the following disables only horizontal scrolling and pinch-to-zoom on the component's main element:

touchAction: {
    panX: false,
    pinchZoom: false
}

Touch actions can be specified on reference elements using the reference element name, for example:

// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
    panY: false
    body: {
        doubleTapZoom: false
    }
}

The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:

Ext.create('Ext.Widget', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

null

tpl : String / String[] / Ext.Template / Ext.XTemplate[]

<ExtEmailfield tpl="value" />

let element = document.body.querySelector('ExtEmailfield');
element.tpl = 'value';
let tpl = element.tpl;

A String, Ext.Template, Ext.XTemplate or an Array of strings to form an Ext.XTemplate. Used in conjunction with the data and tplWriteMode configurations.

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Defaults to:

null

tplWriteMode : String

<ExtEmailfield tplWriteMode="value" />

let element = document.body.querySelector('ExtEmailfield');
element.tplWriteMode = 'value';
let tplWriteMode = element.tplWriteMode;

The Ext.(X)Template method to use when updating the content area of the Component.

Valid modes are:

• append
• insertAfter
• insertBefore
• insertFirst
• overwrite

Defaults to:

'overwrite'

triggers : Object

<ExtEmailfield triggers="{ }" />

let element = document.body.querySelector('ExtEmailfield');
element.triggers = { };
let triggers = element.triggers;

<ExtTrigger/> <ExtTrigger.trigger/> to use in this field. The keys in this object are unique identifiers for the triggers. The values in this object are <ExtTrigger/> <ExtTrigger.trigger/> configuration objects.

Ext.create('Ext.field.Text', {
    label: 'My Custom Field',
    triggers: {

foo: { cls: 'my-foo-trigger', handler: function() { console.log('foo trigger clicked'); } }, bar: { cls: 'my-bar-trigger', handler: function() { console.log('bar trigger clicked'); } } } });

The weight value may be a negative value in order to position custom triggers ahead of default triggers like that of a DatePicker field.

Ext.create('Ext.form.DatePicker', {
    label: 'Pick a Date',
    triggers: {

foo: { cls: 'my-foo-trigger', weight: -2, // negative to place before default triggers handler: function() { console.log('foo trigger clicked'); } }, bar: { cls: 'my-bar-trigger', weight: -1, handler: function() { console.log('bar trigger clicked'); } } } });

Defaults to:

{
    clear: {
        type: 'clear'
    }
}

twoWayBindable : String / String[] / Object

<ExtEmailfield twoWayBindable="value" />

let element = document.body.querySelector('ExtEmailfield');
element.twoWayBindable = 'value';
let twoWayBindable = element.twoWayBindable;

This object holds a map of config properties that will update their binding as they are modified. For example, value is a key added by form fields. The form of this config is the same as publishes.

This config is defined so that updaters are not created and added for all bound properties since most cannot be modified by the end-user and hence are not appropriate for two-way binding.

Defaults to:

{
    value: 1
}

ui : String / String[]

<ExtEmailfield ui="value" />

let element = document.body.querySelector('ExtEmailfield');
element.ui = 'value';
let ui = element.ui;

The ui or uis to be used on this Component

When a ui is configured, CSS class names are added to the element, created by appending the ui name(s) to each classCls and/or baseCls.

Defaults to:

null

userCls : String / String[]

<ExtEmailfield userCls="value" />

let element = document.body.querySelector('ExtEmailfield');
element.userCls = 'value';
let userCls = element.userCls;

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

For example:

 items: [{
     xtype: 'button',
     userCls: 'my-button'
 ...
 }]

Defaults to:

null

userSelectable : Boolean / String / Object

<ExtEmailfield [userSelectable]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.userSelectable = true;
let userSelectable = element.userSelectable;

Setting the value to true implies auto, while false implies none. Setting the value to text allows users to select text within this component. The value may also be an object keyed by child element name as seen below.

Can also be any valid value for the CSS3 user-select property.

By default, the user cannot click+drag+select text/elements of the UI. Applications may want to enable user selection for specific DOM elements, such as the bodyElement of a component used as a tab panel. The tab and tab text would not be user selectable in this example, but the content area when the tab is selected would.

 userSelectable: {
     element: true,       // allow the element to be user selectable
     bodyElement: true    // allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

validateDisabled : Boolean

<ExtEmailfield [validateDisabled]="true" />

let element = document.body.querySelector('ExtEmailfield');
element.validateDisabled = true;
let validateDisabled = element.validateDisabled;

true to validate the field, even if it is disabled.

Defaults to:

false

validateOnInit : "none" / "auto" / "all"

readonly ro

<ExtEmailfield validateOnInit="value" />

let element = document.body.querySelector('ExtEmailfield');
element.validateOnInit = 'value';
let validateOnInit = element.validateOnInit;

Determines how initial values will handle validation

• none: Will not validate any initial values
• auto: Will only validate non-empty initial values
• all: Will validate all initial values

Defaults to:

'auto'

validationMessage : String

<ExtEmailfield validationMessage="value" />

let element = document.body.querySelector('ExtEmailfield');
element.validationMessage = 'value';
let validationMessage = element.validationMessage;

For validation, regex, etc., this is the error message returned if field is invalid.

Defaults to:

'Is in the wrong format'

validators : Mixed

<ExtEmailfield validators="value" />

let element = document.body.querySelector('ExtEmailfield');
element.validators = 'value';
let validators = element.validators;

A validator or array of validators to be applied to the field.

When the field is validated, each validator is applied and if any one of them determines the field is invalid, the field will be marked as invalid. If you examine the field's validators, you will get an array of Ext.data.Validators.

Validation currently is synchronous. If you need to validate a field with interaction with a server, you would do this when the form is submitted.

A validator may be:

• A regexp - if the field fails to match the regexp, it is invalid.

• A function - the function will be called to validate the field; it should return false if invalid.

• An object - an object with a member fn that is a function to be called to validate the field.

• An instantiated Validator Ext.data.validator.Validator

Defaults to:

null

value : Mixed

<ExtEmailfield value="value" />

let element = document.body.querySelector('ExtEmailfield');
element.value = 'value';
let value = element.value;

The field's value

Defaults to:

null

viewModel : String / Object / Ext.app.ViewModel

<ExtEmailfield viewModel="value" />

let element = document.body.querySelector('ExtEmailfield');
element.viewModel = 'value';
let viewModel = element.viewModel;

The ViewModel is a data provider for this component and its children. The data contained in the ViewModel is typically used by adding bind configs to the components that want present or edit this data.

When set, the ViewModel is created and links to any inherited viewModel instance from an ancestor container as the "parent". The ViewModel hierarchy, once established, only supports creation or destruction of children. The parent of a ViewModel cannot be changed on the fly.

If this is a root-level ViewModel, the data model connection is made to this component's associated Ext.data.Session. This is determined by calling getInheritedSession.

Defaults to:

null

weight : Number

<ExtEmailfield [weight]="10" />

let element = document.body.querySelector('ExtEmailfield');
element.weight = 10;
let weight = element.weight;

This value controls this item's order in a weighted <ExtContainer/> (see parent).

Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.

Defaults to:

0

width : Number / String

<ExtEmailfield [width]="value" />

let element = document.body.querySelector('ExtEmailfield');
element.width = 'value';
let width = element.width;

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

x : Number

<ExtEmailfield [x]="10" />

let element = document.body.querySelector('ExtEmailfield');
element.x = 10;
let x = element.x;

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

xtype : String

immutable imm

<ExtEmailfield xtype="value" />

let element = document.body.querySelector('ExtEmailfield');
element.xtype = 'value';
let xtype = element.xtype;

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom <ExtComponent/> like so:

Ext.define('PressMeButton', {
    extend: 'Ext.button.Button',
    xtype: 'pressmebutton',
    text: 'Press Me'
});

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

// Explicit creation of contained Components:
var panel = new Ext.Panel({
   // ...
   items: [
      Ext.create('Ext.button.Button', {
         text: 'OK'
      })
   ]
});

// Implicit creation using xtype:
var panel = new Ext.Panel({
   // ...
   items: [{
      xtype: 'button',
      text: 'OK'
   }]
});

In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.

y : Number

<ExtEmailfield [y]="10" />

let element = document.body.querySelector('ExtEmailfield');
element.y = 10;
let y = element.y;

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

zIndex : Number

<ExtEmailfield [zIndex]="10" />

let element = document.body.querySelector('ExtEmailfield');
element.zIndex = 10;
let zIndex = element.zIndex;

The z-index to give this Component when it is rendered.

Not valid for cfg-floated Components. The Z ordering of cfg-floated Components is managed by ordering of the DOM elements.

Defaults to:

null

addAfterListener

let element = document.body.querySelector('ExtEmailfield');
element.addAfterListener();

Alias for onAfter.

addBeforeListener

let element = document.body.querySelector('ExtEmailfield');
element.addBeforeListener();

Alias for onBefore.

addCls ( cls, [prefix], [suffix] )

let element = document.body.querySelector('ExtEmailfield');
element.addCls(cls, prefix, suffix);

Adds a CSS class (or classes) to this Component's rendered element.

Parameters

addListener ( eventName, [fn], [scope], [options], [order] ) : Object

chainable ch

let element = document.body.querySelector('ExtEmailfield');
let addListener = element.addListener(eventName, fn, scope, options, order);

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

 panel.body.un(...)

 handler('foo', 42, <actual event arguments>...);

false

'current'

Returns

this.btnListeners =  = myButton.on({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

Ext.destroy(this.btnListeners);

this.btnListeners.destroy();

addManagedListener ( item, ename, [fn], [scope], [options] ) : Object

let element = document.body.querySelector('ExtEmailfield');
let addManagedListener = element.addManagedListener(item, ename, fn, scope, options);

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

Returns

this.btnListeners = myButton.mon({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

Ext.destroy(this.btnListeners);

this.btnListeners.destroy();

addPlugin ( plugin )

let element = document.body.querySelector('ExtEmailfield');
element.addPlugin(plugin);

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

 list.addPlugin({
     type: 'pullrefresh',
     pullRefreshText: 'Pull to refresh...'
 });

Available since: 6.2.0

Parameters

addTrigger ( name, trigger ) : Ext.field.trigger.Trigger

let element = document.body.querySelector('ExtEmailfield');
let addTrigger = element.addTrigger(name, trigger);

Adds a trigger to this text field.

Parameters

Returns

afterRender

template tpl

let element = document.body.querySelector('ExtEmailfield');
element.afterRender();

This method is called after the component is initially added to the DOM. If this component <ExtContainer/> other components, the afterRender method for child components is called before the parent's afterRender.

Implementations of this method should avoid reading from the DOM but are free to write to the DOM as needed. To read the DOM, consider implementing onRender instead.

This method is not generally needed because components always have their own DOM element and these are maintained by config property updaters prior to insertion in the DOM. In general, it is always best to manipulate the component's elements outside the DOM where there is no associated reflow or layout cost. This method is useful for situations where the component's elements must be in the DOM in order to be manipulated correctly.

Available since: 6.5.0

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

bubble ( fn, [scope], [args] )

let element = document.body.querySelector('ExtEmailfield');
element.bubble(fn, scope, args);

Bubbles up the getRefOwner hierarchy, calling the specified function with each component. The scope (this reference) of the function call will be the scope provided or the current component. The arguments to the function will be the args provided or the current component. If the function returns false at any point, the bubble is stopped.

Parameters

center Ext.Component

chainable ch

let element = document.body.querySelector('ExtEmailfield');
let center = element.center();

Center this cfg-floated or positioned Component in its parent.

Returns

clearListeners

let element = document.body.querySelector('ExtEmailfield');
element.clearListeners();

Removes all listeners for this object including the managed listeners

clearManagedListeners

let element = document.body.querySelector('ExtEmailfield');
element.clearManagedListeners();

Removes all managed listeners for this object.

clearValue

let element = document.body.querySelector('ExtEmailfield');
element.clearValue();

Clears the value of this field.

constructor ( config )

let element = document.body.querySelector('ExtEmailfield');
element.constructor(config);

Creates new Component.

Parameters

destroy

let element = document.body.querySelector('ExtEmailfield');
element.destroy();

Destroys the Widget. This method should not be overridden in custom Widgets, because it sets the flags and does final cleanup that must go last. Instead, override doDestroy method to add functionality at destruction time.

destroyMembers ( args )

let element = document.body.querySelector('ExtEmailfield');
element.destroyMembers(args);

Destroys member properties by name.

If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.

The property will be destroyed, and the corrected name (if the property is a config and config names are prefixed) will set to null in this object's dictionary.

Parameters

destroyPlugin ( plugin ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtEmailfield');
let destroyPlugin = element.destroyPlugin(plugin);

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

Returns

disable

let element = document.body.querySelector('ExtEmailfield');
element.disable();

Disables this Component

doDestroy

let element = document.body.querySelector('ExtEmailfield');
element.doDestroy();

Perform the actual destruction sequence. This is the method to override in your subclasses to add steps specific to the destruction of custom Component.

If the Component is currently added to a Container it will first be removed from that Container. All Ext.Element references are also deleted and the Component is de-registered from Ext.ComponentManager.

As a rule of thumb, subclasses should destroy their child Components, Elements, and/or other objects before calling parent method. Any object references will be nulled after this method has finished, to prevent the possibility of memory leaks.

Available since: 6.2.0