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


top

Ext.dataview.ListItem xtype: listitem

NPM Package

@extjs/ext-react

Hierarchy

Ext.dataview.ListItem

Summary

A ListItem is a container for List with useSimpleItems: false.

ListItem configures and updates the Ext.data.Model for the sub-component items in a list.

Overwrite the updateRecord() method to set a sub-component's value. the framework calls updateRecord() whenever the data in the list updates.

The updatedata event fires after updateRecord() runs.

Note: Use of ListItem increases overhead since it generates more markup than using the List class with useSimpleItems: true. This overhead is more noticeable in Internet Explorer. If at all possible, use Ext.dataview.SimpleListItem instead via the List's useSimpleItems config.

The following example shows how to configure and update sub-component items in a list:

Ext.define('Twitter.view.TweetListItem', {
    extend: 'Ext.dataview.ListItem',
    xtype : 'tweetlistitem',
    requires: [
        'Ext.Img'
    ],
    config: {
        userName: {
            cls: 'username'
        },
        text: {
            cls: 'text'
        },
        avatar: {
            docked: 'left',
            xtype : 'image',
            cls   : 'avatar',
            width: '48px',
            height: '48px'
        },
        layout: {
            type: 'vbox'
        }
    },

    applyUserName: function(config) {
        return Ext.factory(config, Ext.Component, this.getUserName());
    },

    updateUserName: function(newUserName) {
        if (newUserName) {
            this.insert(0, newUserName);
        }
    },

    applyText: function(config) {
        return Ext.factory(config, Twitter.view.TweetListItemText, this.getText());
    },

    updateText: function(newText) {
        if (newText) {
            this.add(newText);
        }
    },

    applyAvatar: function(config) {
        return Ext.factory(config, Ext.Img, this.getAvatar());
    },

    updateAvatar: function(newAvatar) {
        if (newAvatar) {
            this.add(newAvatar);
        }
    },

    updateRecord: function(record) {
        if (!record) {
            return;
        }

        this.getUserName().setHtml(record.get('username'));
        this.getText().setHtml(record.get('text'));
        this.getAvatar().setSrc(record.get('avatar_url'));
        this.callParent(arguments);

    }
});
No members found using the current filters

configs

Optional Configs

defaultToolWeights : Object

The default weight for tools in the header.

Available since: 6.5.0

getDefaultToolWeights : Object

Returns the value of defaultToolWeights

Returns

Object

setDefaultToolWeights (defaultToolWeights)

Sets the value of defaultToolWeights

Parameters

defaultToolWeights :  Object

toolDefaults : Object

The properties of this object are shallow copied (via applyIf() as opposed to Ext.merge() to each tool declared in the tools config.

tools : Ext.Tool[] / Object / Object[]

An array of Ext.Tool configs or an object keyed by itemId.

properties

events

updatedata ( this, newData, eOpts )

Fires whenever the data of the DataItem is updated.

Parameters

this :  Ext.dataview.component.DataItem

The DataItem instance.

newData :  Object

The new data.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

theme variables

$dataitem-alt-background-color : color

background-color for striped DataItems

Defaults to:

$dataview-item-alt-background-color

$dataitem-background-color : color

DataItem background-color

Defaults to:

$dataview-item-background-color

$dataitem-border-color : color

DataItem border-color

Defaults to:

$dataview-item-border-color

$dataitem-border-style : String

DataItem border-style

Defaults to:

$dataview-item-border-style

$dataitem-border-width : Number

DataItem border-width

Defaults to:

$dataview-item-border-width

$dataitem-color : color

DataItem text color

Defaults to:

$dataview-item-color

$dataitem-default-ui : map

Parameters for the "default" DataItem UI. Set to null to eliminate the UI from the CSS output.

$dataitem-focused-outline-color : color

DataItem outline-color when focused

Defaults to:

$dataview-item-focused-outline-color

$dataitem-focused-outline-offset : Number

DataItem outline-offset when focused

Defaults to:

$dataview-item-focused-outline-offset

$dataitem-focused-outline-style : String

DataItem outline-style when focused

Defaults to:

$dataview-item-focused-outline-style

$dataitem-focused-outline-width : Number

DataItem outline-width when focused

Defaults to:

$dataview-item-focused-outline-width

$dataitem-font-family : String

DataItem font-family

Defaults to:

$dataview-item-font-family

$dataitem-font-size : Number

DataItem font-size

Defaults to:

$dataview-item-font-size

$dataitem-font-size-big : Number

DataItem font-size in the big sizing scheme

Defaults to:

$dataview-item-font-size-big

$dataitem-font-weight : String / Number

DataItem font-weight

Defaults to:

$dataview-item-font-weight

$dataitem-hovered-background-color : color

DataItem background-color when hovered

Defaults to:

$dataview-item-hovered-background-color

$dataitem-hovered-border-color : color

DataItem border-color when hovered

Defaults to:

$dataview-item-hovered-border-color

$dataitem-hovered-color : color

DataItem text color when hovered

Defaults to:

$dataview-item-hovered-color

$dataitem-line-height : Number

DataItem line-height

Defaults to:

$dataview-item-line-height

$dataitem-line-height-big : Number

DataItem line-height in the big sizing scheme

Defaults to:

$dataview-item-line-height-big

$dataitem-padding : Number / list

DataItem padding

Defaults to:

$dataview-item-padding

$dataitem-padding-big : Number / list

DataItem padding in the big sizing scheme

Defaults to:

$dataview-item-padding-big

$dataitem-pressed-background-color : color

DataItem background-color when pressed

Defaults to:

$dataview-item-pressed-background-color

$dataitem-pressed-border-color : color

DataItem border-color when pressed

Defaults to:

$dataview-item-pressed-border-color

$dataitem-pressed-color : color

DataItem text color when pressed

Defaults to:

$dataview-item-pressed-color

$dataitem-selected-background-color : color

DataItem background-color when selected

Defaults to:

$dataview-item-selected-background-color

$dataitem-selected-border-color : color

DataItem border-color when selected

Defaults to:

$dataview-item-selected-border-color

$dataitem-selected-color : color

DataItem text color when selected

Defaults to:

$dataview-item-selected-color

$listitem-alt-background-color : color

background-color for striped ListItems

Defaults to:

$dataitem-alt-background-color

$listitem-background-color : color

ListItem background-color

Defaults to:

$dataitem-background-color

$listitem-border-color : color

ListItem border-color

Defaults to:

$neutral-highlight-color

$listitem-border-style : String

ListItem border-style

Defaults to:

solid

$listitem-border-width : Number / list

ListItem border-width

Defaults to:

1px 0

$listitem-color : color

ListItem text color

Defaults to:

$dataitem-color

$listitem-focused-background-color : color

ListItem's background color when focused

$listitem-focused-border-color : color

ListItem border color when focused

$listitem-focused-color : color

ListItem text color when focused

$listitem-focused-outline-color : color

ListItem outline-color when focused

Defaults to:

$dataitem-focused-outline-color

$listitem-focused-outline-offset : Number

ListItem outline-offset when focused

Defaults to:

$dataitem-focused-outline-offset

$listitem-focused-outline-style : String

ListItem outline-style when focused

Defaults to:

$dataitem-focused-outline-style

$listitem-focused-outline-width : Number

ListItem outline-width when focused

Defaults to:

$dataitem-focused-outline-width

$listitem-font-family : String

ListItem font-family

Defaults to:

$dataitem-font-family

$listitem-font-size : Number

ListItem font-size

Defaults to:

$dataitem-font-size

$listitem-font-size-big : Number

ListItem font-size in the big sizing scheme

Defaults to:

$dataitem-font-size-big

$listitem-font-weight : String / Number

ListItem font-weight

Defaults to:

$dataitem-font-weight

$listitem-hovered-background-color : color

ListItem background-color when hovered

Defaults to:

$dataitem-hovered-background-color

$listitem-hovered-border-color : color

ListItem border-color when hovered

Defaults to:

$listitem-hovered-background-color

$listitem-hovered-color : color

ListItem text color when hovered

Defaults to:

$dataitem-hovered-color

$listitem-line-height : Number

ListItem line-height

Defaults to:

$dataitem-line-height

$listitem-line-height-big : Number

ListItem line-height in the big sizing scheme

Defaults to:

$dataitem-line-height-big

$listitem-padding : Number / list

ListItem padding

Defaults to:

4px 8px

$listitem-padding-big : Number / list

ListItem padding in the big sizing scheme

Defaults to:

7px 15px

$listitem-pinned-background-color : color

ListItem background-color when pinned

Defaults to:

null

$listitem-pinned-border-color : color

ListItem border-color when pinned

Defaults to:

null

$listitem-pinned-bottom-box-shadow : list

ListItem border-color when pinned to the bottom

Defaults to:

invert-shadow($listitem-pinned-box-shadow, y)

$listitem-pinned-box-shadow : list

ListItem border-color when pinned

Defaults to:

0 2px 4px 0 rgba(0, 0, 0, .2)

$listitem-pinned-color : color

ListItem text color when pinned

Defaults to:

null

$listitem-pressed-background-color : color

ListItem background-color when pressed

Defaults to:

$dataitem-pressed-background-color

$listitem-pressed-border-color : color

ListItem border-color when pressed

Defaults to:

$listitem-pressed-background-color

$listitem-pressed-color : color

ListItem text color when pressed

Defaults to:

$dataitem-pressed-color

$listitem-pressed-font-size : Number

ListItem font-size when pressed

Defaults to:

null

$listitem-pressed-font-size-big : Number

ListItem font-size when pressed in the big sizing scheme

Defaults to:

null

$listitem-selected-background-color : color

ListItem background-color when selected

Defaults to:

$dataitem-selected-background-color

$listitem-selected-border-color : color

ListItem border-color when selected

Defaults to:

$listitem-selected-background-color

$listitem-selected-color : color

ListItem text color when selected

Defaults to:

$dataitem-selected-color

$listitem-selected-font-size : Number

ListItem font-size when selected

Defaults to:

null

$listitem-selected-font-size-big : Number

ListItem font-size when selected in the big sizing scheme

Defaults to:

null

theme mixins

dataitem-ui ( ...list... )

Creates a visual theme for a DataItem.

Parameters

$ui :  String

The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).

$xtype :  String (optional)

The Ext.Class#xtype to use in CSS selectors. For use by UI mixins of derived classes.

Defaults to: dataitem

$color :  color

DataItem Item text color

$hovered-color :  color

DataItem Item text color when hovered

$selected-color :  color

DataItem Item text color when selected

$pressed-color :  color

DataItem Item text color when pressed

$background-color :  color

DataItem Item background-color

$alt-background-color :  color

background-color for striped DataItems

$hovered-background-color :  color

DataItem Item background-color when hovered

$selected-background-color :  color

DataItem Item background-color when selected

$pressed-background-color :  color

DataItem Item background-color when pressed

$border-width :  Number

DataItem Item border-width

$border-style :  String

DataItem Item border-style

$border-color :  color

DataItem Item border-color

$hovered-border-color :  color

DataItem Item border-color when hovered

$selected-border-color :  color

DataItem Item border-color when selected

$pressed-border-color :  color

DataItem Item border-color when pressed

$focused-outline-width :  Number

DataItem outline-width when focused

$focused-outline-style :  String

DataItem outline-style when focused

$focused-outline-color :  color

DataItem outline-color when focused

$focused-outline-offset :  Number

DataItem outline-offset when focused

$font-weight :  String/Number

DataItem Item font-weight

$font-size :  Number

DataItem Item font-size

$font-size-big :  Number

DataItem Item font-size in the big sizing scheme

$line-height :  Number

DataItem Item line-height

$line-height-big :  Number

DataItem Item line-height in the big sizing scheme

$font-family :  String

DataItem Item font-family

$padding :  Number/list

DataItem Item padding

$padding-big :  Number/list

DataItem Item padding in the big sizing scheme

toolable-ui ( ...list... )
private pri

Toolable components need special handling for their padding. When there are no tools (which usually means no dock wrapper) the padding on all sides is placed on the body-el, However, when the component has tools, the horizontal padding needs to be removed from the body-el and placed on the innermost dock wrapper so that the horizontal padding is between the outermost tools and the left/right edges of the component. In this configuration the space between the body and the tools is provided by the tools themselves via $tool-spacing.

The vertical padding remains on the body-el so that the height of the toolable component when auto-heighted is determined by the body-el's line-height + padding + the element borders. The tools gain an additional advantage from this arrangement because it means they can be taller than the component's line-height and not cause the component's height to increase since they are not "inside" of the vertical padding.

Parameters

$ui :  Object (optional)

Defaults to: null

$xtype :  Object (optional)

Defaults to: null

$padding :  Object (optional)

Defaults to: null

$padding-big :  Object (optional)

Defaults to: null

$anchor :  Object (optional)

Defaults to: body-el

ExtReact 6.5.1