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.6.0


top

Ext.dom.Query singleton

NPM Package

@sencha/ext-react

Hierarchy

Ext.dom.Query

Summary

Provides high performance selector/xpath processing by compiling queries into reusable functions. New pseudo classes and matchers can be plugged. It works on HTML and XML documents (if a content node is passed in).

DomQuery supports most of the CSS3 selectors spec, along with some custom selectors and basic XPath.

All selectors, attribute filters and pseudos below can be combined infinitely in any order. For example div.foo:nth-child(odd)[@foo=bar].bar:first would be a perfectly valid selector. Node filters are processed in the order in which they appear, which allows you to optimize your queries for your document structure.

Simple Selectors

For performance reasons, some query methods accept selectors that are termed as simple selectors. A simple selector is a selector that does not include contextual information about any parent/sibling elements.

Some examples of valid simple selectors:

var simple = '.foo'; // Only asking for the class name on the element
var simple = 'div.bar'; // Only asking for the tag/class name on the element
var simple = '[href];' // Asking for an attribute on the element.
var simple = ':not(.foo)'; // Only asking for the non-matches against the class name
var simple = 'span:first-child'; // Doesn't require any contextual information about the parent node

Simple examples of invalid simple selectors:

var notSimple = 'div.foo div.bar'; // Requires matching a parent node by class name
var notSimple = 'span + div'; //  Requires matching a sibling by tag name

Element Selectors:

  • * any element
  • E an element with the tag E
  • E F All descendent elements of E that have the tag F
  • E > F or E/F all direct children elements of E that have the tag F
  • E + F all elements with the tag F that are immediately preceded by an element with the tag E
  • E ~ F all elements with the tag F that are preceded by a sibling element with the tag E

Attribute Selectors:

The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.

  • E[foo] has an attribute "foo"
  • E[foo=bar] has an attribute "foo" that equals "bar"
  • E[foo^=bar] has an attribute "foo" that starts with "bar"
  • E[foo$=bar] has an attribute "foo" that ends with "bar"
  • E[foo*=bar] has an attribute "foo" that contains the substring "bar"
  • E[foo%=2] has an attribute "foo" that is evenly divisible by 2
  • E[foo!=bar] attribute "foo" does not equal "bar"

Pseudo Classes:

  • E:first-child E is the first child of its parent
  • E:last-child E is the last child of its parent
  • E:nth-child(_n_) E is the _n_th child of its parent (1 based as per the spec)
  • E:nth-child(odd) E is an odd child of its parent
  • E:nth-child(even) E is an even child of its parent
  • E:only-child E is the only child of its parent
  • E:checked E is an element that is has a checked attribute that is true (e.g. a radio or checkbox)
  • E:first the first E in the resultset
  • E:last the last E in the resultset
  • E:nth(_n_) the _n_th E in the resultset (1 based)
  • E:odd shortcut for :nth-child(odd)
  • E:even shortcut for :nth-child(even)
  • E:contains(foo) E's innerHTML contains the substring "foo"
  • E:nodeValue(foo) E contains a textNode with a nodeValue that equals "foo"
  • E:not(S) an E element that does not match simple selector S
  • E:has(S) an E element that has a descendent that matches simple selector S
  • E:next(S) an E element whose next sibling matches simple selector S
  • E:prev(S) an E element whose previous sibling matches simple selector S
  • E:any(S1|S2|S2) an E element which matches any of the simple selectors S1, S2 or S3
  • E:visible(true) an E element which is deeply visible according to Ext.dom.Element#isVisible

CSS Value Selectors:

  • E{display=none} css value "display" that equals "none"
  • E{display^=none} css value "display" that starts with "none"
  • E{display$=none} css value "display" that ends with "none"
  • E{display*=none} css value "display" that contains the substring "none"
  • E{display%=2} css value "display" that is evenly divisible by 2
  • E{display!=none} css value "display" that does not equal "none"

XML Namespaces:

  • ns|E an element with tag E and namespace prefix ns
No members found using the current filters

properties

Instance Properties

matchers

Collection of matching regular expressions and code snippets. Each capture group within () will be replace the {} in the select statement as specified by their index.

operators : Object

Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.

New operators can be added as long as the match the format c= where c is any character other than space, >, or <.

Operator functions are passed the following parameters:

  • propValue : The property value to test.
  • compareTo : The value to compare to.

pseudos

Object hash of "pseudo class" filter functions which are used when filtering selections. Each function is passed two parameters:

  • c : Array An Array of DOM elements to filter.

  • v : String The argument (if any) supplied in the selector.

A filter function returns an Array of DOM elements which conform to the pseudo class. In addition to the provided pseudo classes listed above such as first-child and nth-child, developers may add additional, custom psuedo class filters to select elements according to application-specific requirements.

For example, to filter a elements to only return links to external resources:

Ext.DomQuery.pseudos.external = function(c, v) {
    var r = [], ri = -1;
    for(var i = 0, ci; ci = c[i]; i++) {
        // Include in result set only if it's a link to an external resource
        if (ci.hostname != location.hostname) {
            r[++ri] = ci;
        }
    }
    return r;
};

Then external links could be gathered with the following statement:

var externalLinks = Ext.select("a:external");

methods

Instance Methods

compile ( selector, [type] ) : Function

Compiles a selector/xpath query into a reusable function. The returned function takes one parameter "root" (optional), which is the context node from where the query should start.

Parameters

selector :  String

The selector/xpath query

type :  String (optional)

Either "select" or "simple" for a simple selector match

Defaults to: "select"

Returns

:Function

filter ( el, selector, nonMatches ) : HTMLElement[]

Filters an array of elements to only include matches of a simple selector

Parameters

el :  HTMLElement[]

An array of elements to filter

selector :  String

The simple selector to test

nonMatches :  Boolean

If true, it returns the elements that DON'T match the selector instead of the ones that match

Returns

:HTMLElement[]

An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned.

getNodeValue ( node, [defaultValue] ) : String

Get the text value for a node, optionally replacing null with the defaultValue.

Parameters

node :  Object

The node

defaultValue :  String (optional)

When specified, this is return as empty value.

Returns

:String

The value

is ( el, selector ) : Boolean

Returns true if the passed element(s) match the passed simple selector

Parameters

el :  String/HTMLElement/HTMLElement[]

An element id, element or array of elements

selector :  String

The simple selector to test

Returns

:Boolean

jsSelect ( selector, [root] ) : HTMLElement[]

Selects an array of DOM nodes using JavaScript-only implementation.

Use select to take advantage of browsers built-in support for CSS selectors.

Parameters

selector :  String

The selector/xpath query (can be a comma separated list of selectors)

root :  HTMLElement/String (optional)

The start of the query.

Defaults to: document

Returns

:HTMLElement[]

An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned.

select ( path, [root], [type], [single] ) : HTMLElement[]

Selects an array of DOM nodes by CSS/XPath selector.

Uses document.querySelectorAll if browser supports that, otherwise falls back to Ext.dom.Query#jsSelect to do the work.

Parameters

path :  String

The selector/xpath query

root :  HTMLElement (optional)

The start of the query.

Defaults to: document

type :  String (optional)

Either "select" or "simple" for a simple selector match (only valid when used when the call is deferred to the jsSelect method)

Defaults to: "select"

single :  Boolean (optional)

Pass true to select only the first matching node using document.querySelector (where available)

Returns

:HTMLElement[]

An array of DOM elements (not a NodeList as returned by querySelectorAll).

selectNode ( selector, [root] ) : HTMLElement

Selects a single element.

Parameters

selector :  String

The selector/xpath query

root :  HTMLElement (optional)

The start of the query.

Defaults to: document

Returns

:HTMLElement

The DOM element which matched the selector.

selectNumber ( selector, [root], [defaultValue] ) : Number

Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified.

Parameters

selector :  String

The selector/xpath query

root :  HTMLElement (optional)

The start of the query.

Defaults to: document

defaultValue :  Number (optional)

When specified, this is return as empty value.

Returns

:Number

selectValue ( selector, [root], [defaultValue] ) : String

Selects the value of a node, optionally replacing null with the defaultValue.

Parameters

selector :  String

The selector/xpath query

root :  HTMLElement (optional)

The start of the query.

Defaults to: document

defaultValue :  String (optional)

When specified, this is return as empty value.

Returns

:String

ExtReact 6.6.0