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

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.panel.Resizer

Requires

Ext.panel.Resizable

Summary

This class allows a Panel to be resized via user interaction. It can be used on floating panels, or as a splitter between two panels.

No members found using the current filters

configs

Optional Configs

constrainToParent : Boolean

true to constrain the dragging operation to the parent of the cfg-target.

Defaults to:

true

getConstrainToParent : Boolean

Returns the value of constrainToParent

Returns

Boolean

setConstrainToParent (constrainToParent)

Sets the value of constrainToParent

Parameters

constrainToParent :  Boolean

constrainToParent : Boolean

true to constrain the dragging operation to the parent of the cfg-target.

Defaults to:

true

getConstrainToParent : Boolean

Returns the value of constrainToParent

Returns

Boolean

setConstrainToParent (constrainToParent)

Sets the value of constrainToParent

Parameters

constrainToParent :  Boolean

dynamic : Boolean

true to live resize the cfg-target. false to create a proxy indicator to represent the drag operation.

Defaults to:

false

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 cfg-target. false to create a proxy indicator to represent the drag operation.

Defaults to:

false

getDynamic : Boolean

Returns the value of dynamic

Returns

Boolean

setDynamic (dynamic)

Sets the value of dynamic

Parameters

dynamic :  Boolean

edges : String / String[]

The draggable edges. These can be specified as a string separated by ' ' or ','. The values for the edges should be direction coordinates (or the shortcut). Possible values are:

  • 'north', or 'n'
  • 'northeast', or 'ne'
  • 'east', or 'e'
  • 'southeast', or 'se'
  • 'south', or 's'
  • 'southwest', or 'sw'
  • 'west', or 'w'
  • 'northwest', or 'nw'
  • 'all', a shortcut for all edges

Examples:

  • ['n', 'e', 's', 'w'],
  • 'e,se,s'
  • 'e se s',
  • 'northeast southeast southwest northwest'

Defaults to:

null

getEdges : String / String[]

Returns the value of edges

Returns

String / String[]

setEdges (edges)

Sets the value of edges

Parameters

edges :  String / String[]

edges : String / String[]

The draggable edges. These can be specified as a string separated by ' ' or ','. The values for the edges should be direction coordinates (or the shortcut). Possible values are:

  • 'north', or 'n'
  • 'northeast', or 'ne'
  • 'east', or 'e'
  • 'southeast', or 'se'
  • 'south', or 's'
  • 'southwest', or 'sw'
  • 'west', or 'w'
  • 'northwest', or 'nw'
  • 'all', a shortcut for all edges

Examples:

  • ['n', 'e', 's', 'w'],
  • 'e,se,s'
  • 'e se s',
  • 'northeast southeast southwest northwest'

getEdges : String / String[]

Returns the value of edges

Returns

String / String[]

setEdges (edges)

Sets the value of edges

Parameters

edges :  String / String[]

maxSize : Number / Number[]

The maximum width and height for this resizer. If specified as a number, the value applies for both width and height. Otherwise,

  • [100, null], constrain only the width
  • [null, 100], constrain only the height
  • [200, 300], constrain both.

Note If a maxWidth or maxHeight is specified, it will take precedence.

Defaults to:

null

getMaxSize : Number / Number[]

Returns the value of maxSize

Returns

Number / Number[]

setMaxSize (maxSize)

Sets the value of maxSize

Parameters

maxSize :  Number / Number[]

maxSize : Number / Number[]

The maximum width and height for this resizer. If specified as a number, the value applies for both width and height. Otherwise,

  • [100, null], constrain only the width
  • [null, 100], constrain only the height
  • [200, 300], constrain both.

Note If a maxWidth or maxHeight is specified, it will take precedence.

getMaxSize : Number / Number[]

Returns the value of maxSize

Returns

Number / Number[]

setMaxSize (maxSize)

Sets the value of maxSize

Parameters

maxSize :  Number / Number[]

minSize : Number / Number[]

The minimum width and height for this resizer. If specified as a number, the value applies for both width and height. Otherwise,

  • [100, null], constrain only the width
  • [null, 100], constrain only the height
  • [200, 300], constrain both.

Note If a minWidth or minHeight is specified, it will take precedence.

Defaults to:

null

getMinSize : Number / Number[]

Returns the value of minSize

Returns

Number / Number[]

setMinSize (minSize)

Sets the value of minSize

Parameters

minSize :  Number / Number[]

minSize : Number / Number[]

The minimum width and height for this resizer. If specified as a number, the value applies for both width and height. Otherwise,

  • [100, null], constrain only the width
  • [null, 100], constrain only the height
  • [200, 300], constrain both.

Note If a minWidth or minHeight is specified, it will take precedence.

getMinSize : Number / Number[]

Returns the value of minSize

Returns

Number / Number[]

setMinSize (minSize)

Sets the value of minSize

Parameters

minSize :  Number / Number[]

preserveRatio

{@cfg} {Boolean} preserveRatio true to preserve the current aspect ratio of the component while dragging.

Defaults to:

false

getPreserveRatio

Returns the value of preserveRatio

Returns

setPreserveRatio (preserveRatio)

Sets the value of preserveRatio

Parameters

preserveRatio :  Object

snap : Number / Number[]

The interval to move during a resize. If specified as a number, the value applies for both width and height. Otherwise,

  • [100, null], snap only the width
  • [null, 100], snap only the height
  • [200, 300], snap both.

Defaults to:

null

getSnap : Number / Number[]

Returns the value of snap

Returns

Number / Number[]

setSnap (snap)

Sets the value of snap

Parameters

snap :  Number / Number[]

snap : Number / Number[]

The interval to move during a resize. If specified as a number, the value applies for both width and height. Otherwise,

  • [100, null], snap only the width
  • [null, 100], snap only the height
  • [200, 300], snap both.

getSnap : Number / Number[]

Returns the value of snap

Returns

Number / Number[]

setSnap (snap)

Sets the value of snap

Parameters

snap :  Number / Number[]

split : Boolean

true to operate in splitter mode, which is typically used for docked items or items in a Ext.layout.Box. false to operate in handle mode, which is often used for floating items.

Defaults to:

false

getSplit : Boolean

Returns the value of split

Returns

Boolean

setSplit (split)

Sets the value of split

Parameters

split :  Boolean

split : Boolean

true to operate in splitter mode, which is typically used for docked items or items in a Ext.layout.Box. false to operate in handle mode, which is often used for floating items.

Defaults to:

false

getSplit : Boolean

Returns the value of split

Returns

Boolean

setSplit (split)

Sets the value of split

Parameters

split :  Boolean

target : Panel
readonly ro

The panel to be resized.

Defaults to:

null

getTarget : Panel

Returns the value of target

Returns

Panel

setTarget (target)

Sets the value of target

Parameters

target :  Panel

ui : String
private pri

The ui, inherited by the panel

Defaults to:

null

getUi : String

Returns the value of ui

Returns

String

setUi (ui)

Sets the value of ui

Parameters

ui :  String

properties

Instance Properties

allEdges : String[]
private pri

A shortcut to provide all the edges.

Defaults to:

[
    'north',
    'northeast',
    'east',
    'southeast',
    'south',
    'southwest',
    'west',
    'northwest'
]

defaultMaxSize : Number
private pri

A maximum size to use for constraining if it isn't configured on either the component or this resizer.

Defaults to:

100000

defaultMaxSize : Number
private pri

A minimum size to use for constraining if it isn't configured on either the component or this resizer.

Defaults to:

50

edgeDelimiterRe : RegExp
private pri

A regex for splitting the edges by a separator when used as a string.

Defaults to:

/(?:\s*,\s*)|\s+/

edgeInfoMap : Object
private pri

Meta information about each edge.

Defaults to:

{
    north: {
        vert: true,
        constrainProp: {
            vert: 'bottom'
        },
        adjustHeightOffset: -1,
        splitPosSetter: 'setY',
        oppSplitPosSetter: 'setX',
        sizeProp: 'height',
        startEdge: 'top',
        touchAction: {
            panY: false
        }
    },
    northeast: {
        horz: true,
        vert: true,
        corner: true,
        constrainProp: {
            horz: 'left',
            vert: 'bottom'
        },
        adjustHeightOffset: -1,
        adjustWidthOffset: 1,
        touchAction: {
            panX: false,
            panY: false
        }
    },
    east: {
        horz: true,
        constrainProp: {
            horz: 'left'
        },
        adjustWidthOffset: 1,
        splitPosSetter: 'setX',
        oppSplitPosSetter: 'setY',
        sizeProp: 'width',
        startEdge: 'right',
        touchAction: {
            panX: false
        }
    },
    southeast: {
        horz: true,
        vert: true,
        corner: true,
        constrainProp: {
            horz: 'left',
            vert: 'top'
        },
        adjustHeightOffset: 1,
        adjustWidthOffset: 1,
        touchAction: {
            panX: false,
            panY: false
        }
    },
    south: {
        vert: true,
        constrainProp: {
            vert: 'top'
        },
        adjustHeightOffset: 1,
        splitPosSetter: 'setY',
        oppSplitPosSetter: 'setX',
        sizeProp: 'height',
        startEdge: 'bottom',
        touchAction: {
            panY: false
        }
    },
    southwest: {
        horz: true,
        vert: true,
        corner: true,
        constrainProp: {
            horz: 'right',
            vert: 'top'
        },
        adjustHeightOffset: 1,
        adjustWidthOffset: -1,
        touchAction: {
            panX: false,
            panY: false
        }
    },
    west: {
        horz: true,
        constrainProp: {
            horz: 'right'
        },
        adjustWidthOffset: -1,
        splitPosSetter: 'setX',
        oppSplitPosSetter: 'setY',
        sizeProp: 'width',
        startEdge: 'left',
        touchAction: {
            panX: false
        }
    },
    northwest: {
        horz: true,
        vert: true,
        corner: true,
        constrainProp: {
            horz: 'right',
            vert: 'bottom'
        },
        adjustHeightOffset: -1,
        adjustWidthOffset: -1,
        touchAction: {
            panX: false,
            panY: false
        }
    }
}

emptyConstrain : Array
private pri

An empty array used to for minSize and maxSize when no value is provided.

Defaults to:

[
    null,
    null
]

positionMap : Object
private pri

A map of short position names to long names.

Defaults to:

{
    n: 'north',
    north: 'north',
    ne: 'northeast',
    northeast: 'northeast',
    e: 'east',
    east: 'east',
    se: 'southeast',
    southeast: 'southeast',
    s: 'south',
    south: 'south',
    sw: 'southwest',
    southwest: 'southwest',
    w: 'west',
    west: 'west',
    nw: 'northwest',
    northwest: 'northwest'
}

methods

Instance Methods
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