ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

Or in the case of an ExtReact component class this indicates a member of type prop

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

ExtReact 6.7.0


top

Ext.field.Manager protected

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.field.Manager

Requires

Ext.Ajax

Summary

This mixin is used by Ext.field.Panel to provide field management methods.

Setting Form Data

The setValues can be used to populate fields from a data object.

form.setValues({
    name: 'Peter',
    email: '[email protected]',
    password: 'secret'
});

It's also easy to load Ext.data.Model instances into a form - let's say we have a User model and want to load a particular instance into our form:

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    config: {
        fields: ['name', 'email', 'password']
    }
});

var ed = Ext.create('MyApp.model.User', {
    name: 'Peter',
    email: '[email protected]',
    password: 'secret'
});

form.setRecord(ed);

Setting multiple errors on fields

While you can call Ext.field.Field#setError and setError(null) on each field, in your form, FormPanel provides a setErrors method that will apply an Object of error states to multiple fields with one call:

 panel.setErrors({
     field1: 'field1 is in error',
     name2: 'field2 is in error',
     fieldname3: null,   // clear any errors
     fieldname4: [ 'one', 'two', 'three' },      // multiple errors
     ...
 });

While you can call Ext.field.Field#getError on each field in the form to query the form for errors, you can call getError on the form to get an array of error states, suitable to pass into setErrors.

NOTE: these methods will only work on fields with a name config specified.

No members found using the current filters

properties

methods

Instance Methods

clearErrors Ext.field.Manager
chainable ch

Marks all named fields as valid by calling setError() on each.

Returns

:Ext.field.Manager

this

clearErrors Ext.field.Manager

Marks all named fields as valid by calling setError() on each.

Returns

:Ext.field.Manager

this

fillRecord ( record ) : Ext.field.Manager
chainable ch

Set the fields of the provided record from the name fields.

Parameters

record :  Ext.data.Model

Returns

:Ext.field.Manager

this

focusNextField Boolean/Ext.field.Field
private pri

Tries to focus the next field in the form, if there is currently a focused field.

Returns

:Boolean/Ext.field.Field

The next field that was focused, or false.

focusPreviousField Boolean/Ext.field.Field
private pri

Tries to focus the previous field in the form, if there is currently a focused field.

Returns

:Boolean/Ext.field.Field

The previous field that was focused, or false.

getErrors

Gets error state for all named fields of the form.

The Object returned is exactly the same as one that can be passed to setErrors.

getErrors

Gets error state for all named fields of the form.

The Object returned is exactly the same as one that can be passed to setErrors.

getFields ( byName, deep ) : Object/Ext.field.Field/Ext.field.Field[]

Returns all Ext.field.Field instances inside this form.

Parameters

byName :  String

Return an array of fields that match the given name. If only one field matches the name, only that instance will be returned.

deep :  Boolean

false will prevent it from getting fields in child containers.

Returns

:Object/Ext.field.Field/Ext.field.Field[]

All field instances, mapped by field name; or an array if byName is passed.

getFocusedField Ext.field.Field
private pri

Returns the currently focused field

Returns

:Ext.field.Field

The currently focused field, if one is focused or null.

getNextField Boolean/Ext.field.Field
private pri

Returns

:Boolean/Ext.field.Field

The next field if one exists, or false.

getPreviousField Boolean/Ext.field.Field
private pri

Returns

:Boolean/Ext.field.Field

The next field if one exists, or false.

getSubmitValues ( [options] )

Convenience method which calls getValues, passing serialize: true.

Parameters

options :  Object (optional)

The options parameter passed to method-getValues

getValues ( [options] ) : Object

Returns an object containing the value of each field in the form, keyed to the field's name.

For groups of checkbox fields with the same name, it will be arrays of values. For example:

{
    name: "Bill", // From a TextField
    favorites: [
        'pizza',
        'noodle',
        'cake'
    ]
}

Parameters

options :  Object/Boolean (optional)

An object containing options to control the values retrieved. If a boolean is passed, this is the same as passing the enabled property on the object.

enabled :  Boolean (optional)

true to return only enabled fields.

nameless :  Boolean (optional)

true to return all fields even if they don't have a name configured.

serialize :  Boolean (optional)

Pass true to return serialized values.

Returns

:Object

Object mapping field name to its value.

getValues ( [enabled], [all] ) : Object

Returns an object containing the value of each field in the form, keyed to the field's name.

For groups of checkbox fields with the same name, it will be arrays of values. For example:

{
    name: "Bill", // From a TextField
    favorites: [
        'pizza',
        'noodle',
        'cake'
    ]
}

Parameters

enabled :  Boolean (optional)

true to return only enabled fields.

all :  Boolean (optional)

true to return all fields even if they don't have a name configured.

Returns

:Object

Object mapping field name to its value.

isValid Boolean

Test to see if the form has any invalid fields.

NOTE This method does not validate the fields, it only returns true if any field is already marked invalid using the field's isValid. If field values need to be validated, validate should be used instead.

Returns

:Boolean

true if all fields are currently valid.

isValid Boolean

Test to see if the form has any invalid fields.

NOTE This method does not validate the fields, it only returns true if any field is already marked invalid using the field's isValid. If field values need to be validated, validate should be used instead.

Returns

:Boolean

true if all fields are currently valid.

reset ( clearInvalid ) : Ext.field.Manager
chainable ch

Resets all fields in the form back to their original values.

Parameters

clearInvalid :  Boolean

If true will clear any invalid UI state for the fields as well.

Returns

:Ext.field.Manager

this

setErrors ( errors ) : Ext.field.Manager
chainable ch

Marks multiple fields valid or invalid based upon an Object of error states

Each key of the error states Object is the name of the field whose validity status is to be affected. Each value of the error states Object is either a string or array of strings to set as the field's invalid message(s). If the value is null or an empty array, the field is marked valid instead of invalid.

Parameters

errors :  Object

The errors to set child fields with.

Returns

:Ext.field.Manager

this

setErrors ( errors ) : Ext.field.Manager

Marks multiple fields valid or invalid based upon an Object of error states

Each key of the error states Object is the name of the field whose validity status is to be affected. Each value of the error states Object is either a string or array of strings to set as the field's invalid message(s). If the value is null or an empty array, the field is marked valid instead of invalid.

Parameters

errors :  Object

The errors to set child fields with.

Returns

:Ext.field.Manager

this

setValues ( values ) : Ext.field.Manager
chainable ch

Sets the values of form fields in bulk. Example usage:

myForm.setValues({
    name: 'Bill',
    crazy: true,
    username: 'bill.preston'
});

If there groups of checkbox fields with the same name, pass their values in an array. For example:

myForm.setValues({
    name: 'Ted',
    crazy: false,
    hobbies: [
        'reading',
        'cooking',
        'gaming'
    ]
});

Parameters

values :  Object

field name => value mapping object.

Returns

:Ext.field.Manager

this

setValues ( values ) : Ext.field.Manager

Sets the values of form fields in bulk. Example usage:

myForm.setValues({
    name: 'Bill',
    crazy: true,
    username: 'bill.preston'
});

If there groups of checkbox fields with the same name, pass their values in an array. For example:

myForm.setValues({
    name: 'Ted',
    crazy: false,
    hobbies: [
        'reading',
        'cooking',
        'gaming'
    ]
});

Parameters

values :  Object

field name => value mapping object.

Returns

:Ext.field.Manager

this

updateDisabled ( newDisabled ) : Ext.field.Manager
chainable ch

A convenient method to disable all fields in this form.

Parameters

newDisabled :  Object

Returns

:Ext.field.Manager

this

validate Boolean

Calls validate on each field in the form.

Note This will validate the field's current value. If you want to check if all the fields are currently valid without validating the fields value, isValid should be used instead.

Returns

:Boolean

true if all fields in the form are valid, false if any one (or more) of the fields is invalid.

validate Boolean

Calls validate on each field in the form.

Note This will validate the field's current value. If you want to check if all the fields are currently valid without validating the fields value, isValid should be used instead.

Returns

:Boolean

true if all fields in the form are valid, false if any one (or more) of the fields is invalid.

Static Methods

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

ExtReact 6.7.0