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.panel.Collapser

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.panel.Collapser

Requires

Ext.panel.Collapsible
Ext.fx.Animation
Ext.Deferred

Summary

This class allows a Panel to be collapsible via user interaction.

No members found using the current filters

configs

Optional Configs

animation : Boolean / Object

Animation effect to apply when the Panel is being expanded or collapsed. Set to null for no animations. For more fine grained control, see cfg-expandAnimation and cfg-collapseAnimation.

Defaults to:

{
    duration: 250
}

getAnimation : Boolean / Object

Returns the value of animation

Returns

Boolean / Object

setAnimation (animation)

Sets the value of animation

Parameters

animation :  Boolean / Object

animation : Boolean / Object

Animation effect to apply when the Panel is being expanded or collapsed. Set to null for no animations. For more fine grained control, see cfg-expandAnimation and cfg-collapseAnimation.

getAnimation : Boolean / Object

Returns the value of animation

Returns

Boolean / Object

setAnimation (animation)

Sets the value of animation

Parameters

animation :  Boolean / Object

collapseAnimation : Boolean / Object

Animation effect to apply when the panel is being collapsed. If not specified, this falls back to cfg-animation.

Defaults to:

null

getCollapseAnimation : Boolean / Object

Returns the value of collapseAnimation

Returns

Boolean / Object

setCollapseAnimation (collapseAnimation)

Sets the value of collapseAnimation

Parameters

collapseAnimation :  Boolean / Object

collapseAnimation : Boolean / Object

Animation effect to apply when the panel is being collapsed. If not specified, this falls back to cfg-animation.

getCollapseAnimation : Boolean / Object

Returns the value of collapseAnimation

Returns

Boolean / Object

setCollapseAnimation (collapseAnimation)

Sets the value of collapseAnimation

Parameters

collapseAnimation :  Boolean / Object

collapsed : Boolean

True to make the panel collapsed. False to expand the panel.

Defaults to:

false

getCollapsed : Boolean

Returns the value of collapsed

Returns

Boolean

setCollapsed (collapsed)

Sets the value of collapsed

Parameters

collapsed :  Boolean

collapsed : Boolean

True to make the panel collapsed. False to expand the panel.

Defaults to:

false

getCollapsed : Boolean

Returns the value of collapsed

Returns

Boolean

setCollapsed (collapsed)

Sets the value of collapsed

Parameters

collapsed :  Boolean

collapseToolText : String

Text to be announced by screen readers when collapse tool is focused. Will also be set as the collapse tool's tooltip text.

Defaults to:

'Collapse panel'

getCollapseToolText : String

Returns the value of collapseToolText

Returns

String

setCollapseToolText (collapseToolText)

Sets the value of collapseToolText

Parameters

collapseToolText :  String

collapseToolText : String

Text to be announced by screen readers when collapse tool is focused. Will also be set as the collapse tool's tooltip text.

Defaults to:

'Collapse panel'

getCollapseToolText : String

Returns the value of collapseToolText

Returns

String

setCollapseToolText (collapseToolText)

Sets the value of collapseToolText

Parameters

collapseToolText :  String

direction : 'top' / 'right' / 'bottom' / 'left'

The direction to collapse the Panel when the toggle button is clicked. Defaults to Ext.Panel#headerPosition.

Defaults to:

'top'

getDirection : 'top' / 'right' / 'bottom' / 'left'

Returns the value of direction

Returns

'top' / 'right' / 'bottom' / 'left'

setDirection (direction)

Sets the value of direction

Parameters

direction :  'top' / 'right' / 'bottom' / 'left'

direction : 'top' / 'right' / 'bottom' / 'left'

The direction to collapse the Panel when the toggle button is clicked. Defaults to Ext.Panel#headerPosition.

Defaults to:

'top'

getDirection : 'top' / 'right' / 'bottom' / 'left'

Returns the value of direction

Returns

'top' / 'right' / 'bottom' / 'left'

setDirection (direction)

Sets the value of direction

Parameters

direction :  'top' / 'right' / 'bottom' / 'left'

drawer : Object

The configuration for the drawer component that can display the collapsed component contents without expanding. when Ext.Panel#titleCollapse false

Defaults to:

{
    xtype: 'panel',
    border: true,
    top: 0,
    left: 0,
    cls: Ext.baseCSSPrefix + 'drawer'
}

getDrawer : Object

Returns the value of drawer

Returns

Object

setDrawer (drawer)

Sets the value of drawer

Parameters

drawer :  Object

drawer : Object

The configuration for the drawer component that can display the collapsed component contents without expanding.

getDrawer : Object

Returns the value of drawer

Returns

Object

setDrawer (drawer)

Sets the value of drawer

Parameters

drawer :  Object

drawerHideDelay : Number

Defaults to:

500

getDrawerHideDelay : Number

Returns the value of drawerHideDelay

Returns

Number

setDrawerHideDelay (drawerHideDelay)

Sets the value of drawerHideDelay

Parameters

drawerHideDelay :  Number

drawerHideDelay : Number

Defaults to:

500

getDrawerHideDelay : Number

Returns the value of drawerHideDelay

Returns

Number

setDrawerHideDelay (drawerHideDelay)

Sets the value of drawerHideDelay

Parameters

drawerHideDelay :  Number

dynamic : Boolean

true to "live resize" the panels as they collapse. false to pre-determine the size of surrounding components and then animate. false provides a performance benefit because it won't trigger reflow of other components during resizing.

The value defaults to null and the behavior is determined via the current state. true for floated containers, or containers that are not inside a parent container.

This config only applies when using animation.

Defaults to:

null

getDynamic : Boolean

Returns the value of dynamic

Returns

Boolean

setDynamic (dynamic)

Sets the value of dynamic

Parameters

dynamic :  Boolean

dynamic : Boolean

true to "live resize" the panels as they collapse. false to pre-determine the size of surrounding components and then animate. false provides a performance benefit because it won't trigger reflow of other components during resizing.

The value defaults to null and the behavior is determined via the current state. true for floated containers, or containers that are not inside a parent container.

This config only applies when using animation.

Defaults to:

null

getDynamic : Boolean

Returns the value of dynamic

Returns

Boolean

setDynamic (dynamic)

Sets the value of dynamic

Parameters

dynamic :  Boolean

expandAnimation : Boolean / Object

Animation effect to apply when the panel is being expanded. If not specified, this falls back to cfg-animation.

Defaults to:

null

getExpandAnimation : Boolean / Object

Returns the value of expandAnimation

Returns

Boolean / Object

setExpandAnimation (expandAnimation)

Sets the value of expandAnimation

Parameters

expandAnimation :  Boolean / Object

expandAnimation : Boolean / Object

Animation effect to apply when the panel is being expanded. If not specified, this falls back to cfg-animation.

getExpandAnimation : Boolean / Object

Returns the value of expandAnimation

Returns

Boolean / Object

setExpandAnimation (expandAnimation)

Sets the value of expandAnimation

Parameters

expandAnimation :  Boolean / Object

expandToolText : String

Text to be announced by screen readers when expand tool is focused. Will also be set as the expand tool's tooltip text.

Defaults to:

'Expand panel'

getExpandToolText : String

Returns the value of expandToolText

Returns

String

setExpandToolText (expandToolText)

Sets the value of expandToolText

Parameters

expandToolText :  String

expandToolText : String

Text to be announced by screen readers when expand tool is focused. Will also be set as the expand tool's tooltip text.

Defaults to:

'Expand panel'

getExpandToolText : String

Returns the value of expandToolText

Returns

String

setExpandToolText (expandToolText)

Sets the value of expandToolText

Parameters

expandToolText :  String

state : "collapsed" / "collapsing" / "expanded" / "expanding"
private pri

Defaults to:

'expanded'

Available since: 7.0

getState : "collapsed" / "collapsing" / "expanded" / "expanding"

Returns the value of state

Returns

"collapsed" / "collapsing" / "expanded" / "expanding"

setState (state)

Sets the value of state

Parameters

state :  "collapsed" / "collapsing" / "expanded" / "expanding"

target : Panel
readonly ro

The panel to be collapsed.

Defaults to:

null

getTarget : Panel

Returns the value of target

Returns

Panel

setTarget (target)

Sets the value of target

Parameters

target :  Panel

tool : Object

The configuration for the collapsible tool. This may be set to null to not show the tool.

Defaults to:

{
    xtype: 'tool',
    weight: 900
}

getTool : Object

Returns the value of tool

Returns

Object

setTool (tool)

Sets the value of tool

Parameters

tool :  Object

tool : Object

The configuration for the collapsible tool. This may be set to null to not show the tool.

getTool : Object

Returns the value of tool

Returns

Object

setTool (tool)

Sets the value of tool

Parameters

tool :  Object

useDrawer : Boolean

True to enable the drawer to display from user interaction.

Defaults to:

true

getUseDrawer : Boolean

Returns the value of useDrawer

Returns

Boolean

setUseDrawer (useDrawer)

Sets the value of useDrawer

Parameters

useDrawer :  Boolean

useDrawer : Boolean

True to enable the drawer to display from user interaction.

Defaults to:

true

getUseDrawer : Boolean

Returns the value of useDrawer

Returns

Boolean

setUseDrawer (useDrawer)

Sets the value of useDrawer

Parameters

useDrawer :  Boolean

properties

methods

Instance Methods

collapse ( [animation] ) : Ext.Promise

Collapses the panel body so that the body becomes hidden. Fires the Ext.Panel#beforecollapse event which will cancel the collapse action if it returns false.

It also fires the Ext.Panel#collapse event after the panel body is collapsed.

Parameters

animation :  Boolean/Object (optional)

The animation to execute. This setting overrides any cfg-animation configuration. Do not pass a value to use the values configured on the class.

Returns

:Ext.Promise

A promise that resolves when the collapse completes.

expand ( [animation] ) : Ext.Promise

Expands the panel body so that it becomes visible. Fires the Ext.Panel#beforeexpand event which will cancel the expand action if it returns false.

It also fires the Ext.Panel#expand event after the panel is expanded.

Parameters

animation :  Boolean/Object (optional)

The animation to execute. This setting overrides any cfg-animation configuration. Do not pass a value to use the values configured on the class.

Returns

:Ext.Promise

A promise that resolves when the expand completes.

getProxiedConfigs ( name ) : Object
private pri

This method returns an object of all proxied config values for a given target. This is only useful during the class initialization phase to avoid passing in "wrong" initial config values for a child object and then proxying down all the configs from the parent.

This method is not typically called directly but rather mergeProxiedConfigs is more likely.

Available since: 6.5.0

Parameters

name :  String

The proxy target config name (in the class example, this would be "childThing").

Returns

:Object

hideDrawer ( [animation] ) : Ext.Promise

Hide the cfg-drawer.

Parameters

animation :  Boolean/Object (optional)

The animation to execute. This setting overrides any cfg-animation configuration. Do not pass a value to use the values configured on the class.

Returns

:Ext.Promise

A promise that resolves when the hide completes.

isDynamic Boolean

Checks the method of expansion, see dynamic. If a value is configured, it will be used, otherwise it will be determined.

Returns

:Boolean

If the animated expand/collapse is dynamic.

mergeProxiedConfigs ( name, itemConfig, [alwaysClone] ) : Object
private pri

This method accepts the normal config object (itemConfig) for the child object (name) and merges any proxied configs into a new config object. This is useful during the class initialization phase to avoid passing in "wrong" initial config values for a child object and then proxying down the rest of the configs.

This method is typically called during an "applier" method for a proxy target. If called at any other time this method simply returns the given itemConfig. This makes it safe to code such appliers as follows:

 applyChildThing: function(config) {
     config = this.mergeProxiedConfigs('childThing', config);

     return new ChildThing(config);
 }

Available since: 6.5.0

Parameters

name :  String

The proxy target config name (in the class example, this would be "childThing").

itemConfig :  Mixed

The default configuration for the child item.

alwaysClone :  Boolean (optional)

Pass true to ensure a new object is returned.

Returns

:Object

showDrawer ( [animation] ) : Ext.Promise

Show the cfg-drawer.

Parameters

animation :  Boolean/Object (optional)

The animation to execute. This setting overrides any cfg-animation configuration. Do not pass a value to use the values configured on the class.

Returns

:Ext.Promise

A promise that resolves when the show completes.

toggleCollapsed ( collapsed, [animation] ) : Ext.Promise

Set the collapsed state of the panel.

Parameters

collapsed :  Boolean

The collapsed state.

animation :  Boolean/Object (optional)

The animation to execute. This setting overrides any cfg-animation configuration. Do not pass a value to use the values configured on the class.

Returns

:Ext.Promise

A promise that resolves when the collapse/expand completes.

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