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

Tab Ext.tab.Tab

Summary

Used in the TabBar component. This shouldn't be used directly, instead use TabBar or TabPanel.

Children

The following Components (and their sub-components) may be included as children of Tab:
String
Object
Menu
String
Object
No members found using the current filters

props

Optional Props

active : Boolean

Set this to true to have the tab be active by default.

Defaults to:

false

activeCls : String

The CSS class to be applied to a Tab when it is active. Providing your own CSS for this class enables you to customize the active state.

allowDepress : Boolean

true to allow user interaction to set pressed to false when the button is in the pressed state. Only valid when pressed is configured.

Defaults to:

true

Available since: 6.0.2

alwaysOnTop : Boolean / Number

A flag indicating that this component should be above its floated siblings.

This may be a positive number to prioritize the ordering of multiple visible always on top components.

This may be set to a negative number to prioritize a component to the bottom of the z-index stack.

Defaults to:

false

Available since: 6.2.0

ariaAttributes : Object

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state, such as aria-live, aria-flowto, etc.

Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.

ariaDescribedBy : String
immutable imm

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

ariaLabel : String
immutable imm

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabel and ariaLabelledBy config options are mutually exclusive.

ariaLabelledBy : String
immutable imm

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by id, the label element can be any existing element, not necessarily a child of the main Component element.

ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.

arrow : Boolean

By default, if the button has a menu, an arrow icon is shown to indicate this.

Configure arrow: false to hide the menu arrow.

Defaults to:

true

arrowAlign : "right" / "bottom"

The side of the Button box to render the arrow if the button has an associated menu.

Defaults to:

'right'

autoEvent : String

Optional event name that will be fired instead of tap when the Button is tapped on.

Defaults to:

null

axisLock : Boolean

If true, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints fail, only fallback to "r-l" is considered.

Defaults to:

null

badgeText : String

Optional badge text. Badges appear as small numbers, letters, or icons that sit on top of your button. For instance, a small red number indicating how many updates are available.

Defaults to:

null

border : Boolean

Enables or disables bordering on this component. The following values are accepted:

  • null or `true (default): Do nothing and allow the border to be specified by the theme.
  • false: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a border-color or border-style CSS property to the component; you provide the border-color and border-style via CSS rule or style configuration (if not already provide by the theme).

Defaults to:

null

bottom : Number / String

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

buttonType : String

By default, all buttons have type="button". If a button is intended to be invoked as the default action button inside an FormPanel, then setting this to 'submit' will cause the button to be clicked whenever the ENTER key is pressed.

Defaults to:

'button'

Available since: 6.5.0

centered : Boolean

Configure this as true to have this Component centered within its Container. Setting this value to true will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

false

cls : String / String[]

The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a Container).

Defaults to:

null

constrainAlign : String / Ext.util.Region / Ext.dom.Element

A specification of the constraint to apply when showBy or alignTo is called to align a floated or positioned component.

Defaults to the parent container for positioned components (components which have their top, right, bottom or left set to move them out of their container's layout flow).

Defaults to the viewport for floated components.

May be a Ext.ComponentQuery selector to find an ancestor component to constrain within.

May be false to specify that constraining is not applied.

You may also specify an element, or a Ext.util.Region

contentEl : Ext.dom.Element / HTMLElement / String

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Defaults to:

null

data : Object

The initial set of data to apply to the tpl to update the content area of the Component.

Defaults to:

null

destroyMenu : Boolean

Whether or not to destroy any associated menu when this button is destroyed. In addition, a value of true for this prop will destroy the currently bound menu when a new menu is set in setMenu unless overridden by that method's destroyMenu function argument.

Defaults to:

true

disabled : Boolean

Whether or not this component is disabled

Defaults to:

null

displayed : Boolean

Set to true to call show and false to call hide. Unlike the hidden config, changing this config will potentially involve animations to show or hide the component.

Defaults to:

null

Available since: 6.5.0

docked : String

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Defaults to:

null

draggable : Boolean / Object / Ext.drag.Source

Configuration options to make this Component draggable

Defaults to:

null

enableToggle : Boolean

Allows this button to have the pressed state toggled via user interaction.

Defaults to:

false

Available since: 6.0.2

eventHandlers : Object
immutable imm

Properties

click : String

Defaults to: 'onClick'

factoryConfig : Object
readonly ro

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

flex : Number / String / Object

The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.

You can also update the flex of a component dynamically using the Ext.layout.FlexBox#setItemFlex method.

When supplied as a string or number this option supports the same syntax as CSS flex. For example:

flex: '1 2 auto'

sets flex-grow property to 0, flex-shrink to 2 and flex-basis to 'auto'.

The default flex-shrink value for box layout items is set to 0 in the stylesheet, which is different from the browser's default flex-shrink value of 1. This accommodates the majority use case for applications since where non-flexed components are typically not expected to shrink smaller than their default size.

For convenience when only a single number is supplied it is used as the value for both flex-grow and flex-shrink, for example flex: 3 is the same as flex: '3 3'

An object form is also accepted:

flex: {
    grow: 1,
    shrink: 2,
    basis: 'auto'
}

When the object form is supplied shrink always defaults to 0 regardless of the value of grow.

Although 'auto' is the default value for flex-basis, flex-basis defaults to 0% when flex is supplied as a single numeric or string value (e.g. flex: 1). If this behavior is not desired either explicitly set flex-basis to 'auto' or use the object form to set only grow and/or shrink:

flex: {
    grow: 2
}

floated : Boolean

A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.

A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.

By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent floated component with cfg-relative: true.

Defaults to:

false

Available since: 6.2.0

focusCls : String
immutable imm

CSS class that will be added to focused component's focusClsEl, and removed when component blurs.

Defaults to:

'x-focused'

focusClsEl : Ext.dom.Element
readonly ro

The element that will have the focusCls applied when component's focusEl is focused.

focusEl : Ext.dom.Element
readonly ro

The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.

Defaults to:

'el'

fullscreen : Boolean
immutable imm

Force the component to take up 100% width and height available, by adding it to Ext.Viewport.

handler : Function

The handler function to run when the Button is tapped on.

Defaults to:

null

height : Number / String

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

hidden : Boolean

Whether or not this Component is hidden (its CSS display property is set to none).

Defaults to true for floated Components.

Defaults to:

null

hideAnimation : String / Mixed

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

hideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

A String which specifies how this component's DOM element will be hidden. The accepted values are any of these:

Hiding using display results in having no dimensions as well as resetting scroll positions to 0.

The other modes overcome this but may have different trade-offs in certain circumstances.

Defaults to:

'display'

Available since: 6.5.0

hideOnMaskTap : Boolean

When using a modal Component, setting this to true will hide the modal mask and the Container when the mask is tapped on.

Defaults to:

null

html : String

The HTML to put in this button.

If you want to just add text, please use the text configuration.

icon : String

Url to the icon image to use if you want an icon to appear on your button.

Defaults to:

false

iconAlign : 'top' / 'right' / 'bottom' / 'left'

The position within the Button to render the icon Options are: top, right, bottom, left and center (when you have no text set).

Defaults to:

'left'

iconCls : String

One or more space separated CSS classes to be applied to the icon element. The CSS rule(s) applied should specify a background image to be used as the icon.

An example of specifying a custom icon class would be something like:

// specify the property in the prop for the class:
iconCls="my-home-icon"

// css rule specifying the background image to be used as the icon image:
.my-home-icon {
    background-image: url(../images/my-home-icon.gif) !important;
}

In addition to specifying your own classes, you can use the font icons provided in the SDK using the following syntax:

// using Font Awesome
iconCls="x-fa fa-home"

// using Pictos
iconCls="pictos pictos-home"

Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:

Defaults to:

null

id : String
immutable imm

The unique id of this component instance.

It should not be necessary to use this configuration except for singleton objects in your application. Components created with an id may be accessed globally using Ext.getCmp.

Instead of using assigned ids, use the itemId config, and Ext.ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query its descendant Components by selector.

Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.

Note: to avoid complications imposed by a unique id also see itemId.

Defaults to an auto-assigned id.

isObservable : Boolean
readonly ro

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to:

true

itemId : String

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with Ext#getCmp, use itemId with Ext.Container#getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the itemId is scoped locally to the container - avoiding potential conflicts with Ext.ComponentManager which requires a unique id.

Also see id, Ext.Container#query, Ext.Container#down and Ext.Container#child.

keyMap : Object

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:

  • handler: The function or its name to call to handle the event.
  • scope: The this pointer context (can be "this" or "controller").
  • event: An optional override of the key event to which to listen.

Important: Calls to setKeyMap do not replace the entire keyMap but instead update the provided mappings. That is, unless null is passed as the value of the keyMap which will clear the keyMap of all entries.

Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of cfg-listeners. It defaults to the "controller", but using 'this' means that an instance method will be used.

keyMapEnabled : Boolean

Enables or disables processing keys in the keyMap. This value starts as null and if it is null when initKeyMap is called, it will automatically be set to true. Since initKeyMap is called by Ext.Component at the proper time, this is not something application code normally handles.

Defaults to:

null

left : Number / String

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Ext.Component

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

margin : Number / String

The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'

Defaults to:

null

maxHeight : Number / String

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

maxWidth : Number / String

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

menuAlign : String

The position to align the menu to (see Ext.util.Positionable#alignTo for more details).

Defaults to:

'tl-bl?'

minHeight : Number / String

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

minWidth : Number / String

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

modal : Boolean

true to make this Component modal. This will create a mask underneath the Component that covers its parent and does not allow the user to interact with any other Components until this Component is dismissed.

Defaults to:

null

modelValidation : Boolean
immutable imm

This config enables binding to your Ext.data.Model#validators. This is only processed by form fields (e.g., Ext.field.*) at present, however, this setting is inherited and so can be set on a parent container.

When set to true by a component (or by an ancestor container), the validators of for any {@Ext.data.Model record} fields will be used wherever the value is bound to such data fields.

While this config can be set arbitrarily high in the component hierarchy, doing so can create a lot overhead if most of your form fields do not actually rely on validators in your data model.

Using this setting for a form that is bound to an Ext.data.Model might look like this:

 {
     xtype: 'panel',
     modelValidation: true,
     items: [{
         xtype: 'textfield',
         bind: '{theUser.firstName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.lastName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.phoneNumber}'
     },{
         xtype: 'textfield',
         bind: '{theUser.email}'
     }]
 }

Defaults to:

null

Available since: 6.5.0

name : String
immutable imm

Name for the widget to be used with Ext.Container#lookupName et al.

Defaults to:

null

padding : Number / String

The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'

Defaults to:

null

plugins : Object / String / Object[] / String[]

An object or array of objects that will provide custom functionality for this component. If a string is provided or a string is one of the elements of the array, that string is treated as the type alias. For example, "listpaging" is the type alias for Ext.plugin.ListPaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an init() method that accepts a reference to the owning component.

When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

Example code

A plugin by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: 'listpaging'
 });

Multiple plugins by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

Single plugin by class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         type: 'listpaging',
         autoPaging: true
     }
 });

Multiple plugins by type and class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: [{
         xclass: 'Ext.plugin.PullRefresh',
         pullRefreshText: 'Pull to refresh...'
     }, {
         type: 'listpaging',
         autoPaging: true
     }]
 });

pressed : Boolean

Sets the pressed state of the button.

Defaults to:

false

Available since: 6.0.2

pressedCls : String

The CSS class to be applied to a Tab when it is pressed. Providing your own CSS for this class enables you to customize the pressed state.

pressedDelay : Number / Boolean

The amount of delay between the tapstart and the moment we add the pressingCls (in milliseconds). Settings this to true defaults to 100ms.

Defaults to:

0

publishes : String

Defaults to:

'pressed'

record : Ext.data.Model

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Defaults to:

null

relative : Boolean

Only valid when a component is cfg-floated

Configure this as true if you require descendant floated components to be positioned relative to this component's coordinate space, not the viewport's coordinate space.

Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.

Defaults to:

false

Available since: 6.2.0

right : Number / String

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

ripple : Boolean / Object / String

Set to truthy, Color or Object value for the ripple.

Available since: 6.5.0

Properties

color : String

The background color of the ripple.

position : Array

Position for the ripple to start at [x,y]. Determines if a Ripple effect should happen whenever this element is pressed.

For example: { ripple: true }

Or:

 {
     ripple: {
         color: 'red'
     }
 }

For complex components, individual elements can suppress ripples by adding the x-no-ripple class to disable rippling for a tree of elements.

scope : Object

The scope (this reference) in which the configured handler will be executed, unless the scope is a ViewController method name.

Defaults to:

null

scrollable : Boolean / String / Object

Configuration options to make this Component scrollable. Acceptable values are:

  • true to enable auto scrolling.
  • false (or null) to disable scrolling - this is the default.
  • x or horizontal to enable horizontal scrolling only
  • y or vertical to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);

Defaults to:

null

selfAlign : String

Specifies the self alignment of this widget in a box layout

shadow : Boolean

Configure as true for the component to have a drop shadow. 'false' will suppress any default shadow. By default the theme will determine the presence of a shadow.

Available since: 6.2.0

shim : Boolean

Only valid when a component is cfg-floated

Configure as true for the component to use an <iframe> as an underlay to ensure certain non-standard browser plugins are occluded by this component.

Defaults to:

false

Available since: 6.2.0

showAnimation : String / Mixed

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

stretchMenu : Boolean
immutable imm

Configure as true if the cfg of this button's. menu should at least match the width of this button. An minWidth explicit minWidth on the menu will override this.

Defaults to:

false

Available since: 6.5.1

style : String / Object

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

You can pass either a string syntax:

style: 'background:red'

Or by using an object:

style: {
    background: 'red'
}

When using the object syntax, you can define CSS Properties by using a string:

style: {
    'border-left': '1px solid red'
}

Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.

Defaults to:

null

tabIndex : Number

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

text : String

The Button text.

Defaults to:

null

textAlign : "left" / "right" / "center"

Defaults to:

'center'

Available since: 6.0.1

title : String

The title of the card that this tab is bound to.

Defaults to:

'&nbsp;'

toFrontOnShow : Boolean

True to automatically call toFront when a cfg-floated Component is shown.

Defaults to:

true

toggleHandler : Function

Properties

button : Ext.Button

This Button.

pressed : Boolean

This Button's new pressed state. The handler function to run when the Button is toggled. Supplying this configuration implies enableToggle is true.

top : Number / String

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

touchAction : Object
immutable imm

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

Keys in this object are touch action names, and values are false to disable a touch action or true to enable it. Accepted keys are:

  • panX
  • panY
  • pinchZoom
  • doubleTapZoom

All touch actions are enabled (true) by default, so it is usually only necessary to specify which touch actions to disable. For example, the following disables only horizontal scrolling and pinch-to-zoom on the component's main element:

touchAction: {
    panX: false,
    pinchZoom: false
}

Touch actions can be specified on reference elements using the reference element name, for example:

// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
    panY: false
    body: {
        doubleTapZoom: false
    }
}

The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:

Ext.create('Ext.Widget', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

true

tpl : String / String[] / Ext.Template / Ext.XTemplate[]

A string, array of strings, or a function that returns JSX.

tpl = data =>

{data.first_name} {data.last_name}

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Defaults to:

null

tplWriteMode : String

The Ext.(X)Template method to use when updating the content area of the Component.

Valid modes are:

  • append
  • insertAfter
  • insertBefore
  • insertFirst
  • overwrite

Defaults to:

'overwrite'

ui : String

The ui style to render this button with. The valid default options are:

  • null - a basic gray button (default).
  • 'back' - a back button.
  • 'forward' - a forward button.
  • 'round' - a round button.
  • 'plain'
  • 'action' - shaded using the $active-color (dark blue by default).
  • 'decline' - shaded using the $alert-color (red by default).
  • 'confirm' - shaded using the $confirm-color (green by default).

You can also append -round to each of the last three UI's to give it a round shape:

  • action-round
  • decline-round
  • confirm-round

Defaults to:

null

userCls : String / String[]
immutable imm

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

For example:

 items: [{
     xtype: 'button',
     userCls: 'my-button'
 ...
 }]

Defaults to:

true

userSelectable : Boolean / String / Object

Set to true to allow users to select text within this component.

Can also be any valid value for the CSS3 user-select property.

A value of true implies auto, while false implies none.

May also be an object keyed by child element name.

By default, the user cannot click+drag+select text/elements of the UI. Applications may want to enable user selection for specific DOM elements, such as the bodyElement of a component used as a tab panel. The tab and tab text would not be user selectable in this example, but the content area when the tab is selected would.

 userSelectable: {
     element: true,       // optionally allow the element to be user selectable
     bodyElement: true    // optionally allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

value : String / Number

The value of this button. Only applicable when used as an item of a SegmentedButton.

Defaults to:

null

weight : Number

This value controls this item's order in a weighted Container (see parent).

Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.

Defaults to:

0

width : Number / String

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

x : Number

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

xtype : String
immutable imm

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom Ext.Component by specifying the alias config option with a prefix of widget. For example:

Ext.define('PressMeButton', {
    extend: 'Ext.button.Button',
    alias: 'widget.pressmebutton',
    text: 'Press Me'
});

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

Defaults to:

"component"

y : Number

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

zIndex : Number

The z-index to give this Component when it is rendered.

Not valid for cfg-floated Components. The Z ordering of cfg-floated Components is managed by ordering of the DOM elements.

Defaults to:

null

children

menu : Menu / String / Object

A Menu to show when the Button is clicked / tapped.

Example snippet:

<Button text="Style">
    <Menu>
        <MenuItem text="Single" value="single"/>
        <MenuItem text="Double" value="double"/>
    </Menu>
</Button>

Defaults to:

null

tooltip : String / Object

The ToolTip for this component.

<Button text="Basic Tip">
    <ToolTip>A simple tooltip</ToolTip>
</Button>

Defaults to:

null

methods

Instance Methods

addListener ( eventName, [fn], [scope], [options], [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

The name of the event to listen for. May also be an object who's property names are event names.

fn :  Function/String (optional)

The method the event invokes or the name of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners =  = myButton.on({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addManagedListener ( item, ename, [fn], [scope], [options] ) : Object

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

options :  Object (optional)

If the ename parameter was an event name, this is the addListener options.

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners = myButton.mon({
    destroyable: true
     mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addPlugin ( plugin )

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

 list.addPlugin({
     type: 'pullrefresh',
     pullRefreshText: 'Pull to refresh...'
 });

Available since: 6.2.0

Parameters

plugin :  Object/String/Ext.plugin.Abstract

The plugin or config object or alias to add.

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

enableBubble ( eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Parameters

eventNames :  String/String[]

The event name to bubble, or an Array of event names.

findPlugin ( type ) : Ext.plugin.Abstract

Retrieves plugin by its type alias. For example:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

 list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');

Note: See also getPlugin.

Available since: 6.2.0

Parameters

type :  String

The Plugin's type as specified by the class's alias configuration.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

fireEvent ( eventName, args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

fireEventArgs ( eventName, args ) : Boolean

Fires the specified event with the passed parameter list.

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

fireEventedAction ( eventName, args, fn, [scope], [fnArgs] )

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function/String

The action function.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

fnArgs :  Array/Boolean (optional)

Optional arguments for the action fn. If not given, the normal args will be used to call fn. If false is passed, the args are used but if the first argument is this instance it will be removed from the args passed to the action function.

focus ( [selectText] ) : Boolean

Try to focus this component.

If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.

Parameters

selectText :  Boolean/Number[] (optional)

If applicable, true to also select all the text in this component, or an array consisting of start and end (defaults to start) position of selection.

Returns

:Boolean

true if focus target was found and focusing was attempted, false if no focusing attempt was made.

getActive : Boolean

Sets the value of active

getArrow : Boolean

Sets the value of arrow

getArrowAlign : "right" / "bottom"

Sets the value of arrowAlign

getHideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

Sets the value of hideMode

getHtml : String

Sets the value of html

getIcon : String

Sets the value of icon

getIconAlign : 'top' / 'right' / 'bottom' / 'left'

Sets the value of iconAlign

getId String

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

:String

id

getInherited ( [inner] ) : Object

This method returns an object containing the inherited properties for this instance.

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

Pass true to return inheritedStateInner instead of the normal inheritedState object. This is only needed internally and should not be passed by user code.

Defaults to: false

Returns

:Object

The inheritedState object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

This method returns the value of a config property that may be inherited from some ancestor.

In some cases, a config may be explicitly set on a component with the intent of only being presented to its children while that component should act upon the inherited value (see referenceHolder for example). In these cases the skipThis parameter should be specified as true.

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

Pass true if the property should be ignored if found on this instance. In other words, true means the property must be inherited and not explicitly set on this instance.

Defaults to: false

Returns

:Mixed

The value of the requested property.

getMenu : Menu / String / Object

Sets the value of menu

getPlugin ( id ) : Ext.plugin.Abstract

Retrieves a plugin by its id.

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         xclass: 'Ext.plugin.PullRefresh',
         id: 'foo'
     }
 });

 list.getPlugin('foo').setPullRefreshText('Pull to refresh...');

Note: See also findPlugin.

Available since: 6.2.0

Parameters

id :  String

The id of the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

getScope : Object

Sets the value of scope

getShim : Boolean

Sets the value of shim

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

getText : String

Sets the value of text

getTextAlign : "left" / "right" / "center"

Sets the value of textAlign

getTitle : String

Sets the value of title

getUi : String

Sets the value of ui

getValue : String / Number

Sets the value of value

getX : Number

Sets the value of x

getY : Number

Sets the value of y

hasListener ( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

Parameters

eventName :  String

The name of the event to check for

Returns

:Boolean

true if the event is being listened for or bubbles, else false

isAncestor ( possibleDescendant )

Determines whether this Component is an ancestor of the passed Component. This will return true if the passed Component is anywhere within the subtree beneath this Component.

Parameters

possibleDescendant :  Ext.Component

The Component to test for presence within this Component's subtree.

isDescendantOf ( ancestor ) : Boolean

Determines whether this component is the descendant of a passed component.

Parameters

ancestor :  Ext.Component

A Component which may contain this Component.

Returns

:Boolean

true if the component is the descendant of the passed component, otherwise false.

isFocusable ( [deep] ) : Boolean

Determine if this Focusable can receive focus at this time.

Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see Container for more information.

Parameters

deep :  Boolean (optional)

Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.

Defaults to: false

Returns

:Boolean

True if component is focusable, false if not.

isSuspended ( [event] ) : Boolean

Checks if all events, or a specific event, is suspended.

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

mon ( item, ename, [fn], [scope], [options] ) : Object

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

options :  Object (optional)

If the ename parameter was an event name, this is the addListener options.

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners = myButton.mon({
    destroyable: true
     mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

mun ( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the ename parameter was an event name, this is the handler function.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

on ( eventName, [fn], [scope], [options], [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

The name of the event to listen for. May also be an object who's property names are event names.

fn :  Function/String (optional)

The method the event invokes or the name of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners =  = myButton.on({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

onAfter ( eventName, fn, [scope], [options] )

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

onBefore ( eventName, fn, [scope], [options] )

Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

relayEvents ( origin, events, [prefix] ) : Object

Relays selected events from the specified Observable as if the events were fired by this.

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]/Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event as a pop event.

prefix :  String (optional)

A common prefix to prepend to the event names. For example:

this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

:Object

A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Can be undone by calling

Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

removeListener ( eventName, fn, [scope] )

Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

removeManagedListener ( item, ename, [fn], [scope] )

Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the ename parameter was an event name, this is the handler function.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

removePlugin ( plugin, [destroy] ) : Ext.plugin.Abstract

Removes and (optionally) destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

destroy :  Boolean (optional)

Pass true to not call destroy() on the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

resumeEvent ( eventName )

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to resume.

resumeEvents ( [discardQueue] )

Resumes firing events (see suspendEvents).

If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Parameters

discardQueue :  Boolean (optional)

true to prevent any previously queued events from firing while we were suspended. See suspendEvents.

setActive ( active )

Returns the value of active

setActiveCls ( activeCls )

Returns the value of activeCls

setAllowDepress ( allowDepress )

Returns the value of allowDepress

setAlwaysOnTop ( alwaysOnTop )

Returns the value of alwaysOnTop

setAriaAttributes ( ariaAttributes )

Returns the value of ariaAttributes

setArrow ( arrow )

Returns the value of arrow

setArrowAlign ( arrowAlign )

Returns the value of arrowAlign

setAutoEvent ( autoEvent )

Returns the value of autoEvent

setAxisLock ( axisLock )

Returns the value of axisLock

setBadgeText ( badgeText )

Returns the value of badgeText

setBorder ( border )

Returns the value of border

setBottom ( bottom )

Returns the value of bottom

setButtonType ( buttonType )

Returns the value of buttonType

setCentered ( centered )

Returns the value of centered

setCls ( cls )

Returns the value of cls

setConstrainAlign ( constrainAlign )

Returns the value of constrainAlign

setContentEl ( contentEl )

Returns the value of contentEl

setData ( data )

Returns the value of data

setDestroyMenu ( destroyMenu )

Returns the value of destroyMenu

setDisabled ( disabled )

Returns the value of disabled

setDisplayed ( displayed )

Returns the value of displayed

setDocked ( docked )

Returns the value of docked

setDraggable ( draggable )

Returns the value of draggable

setEnableToggle ( enableToggle )

Returns the value of enableToggle

setFlex ( flex )

Returns the value of flex

setFloated ( floated )

Returns the value of floated

setHandler ( handler )

Returns the value of handler

setHeight ( height )

Returns the value of height

setHidden ( hidden )

Returns the value of hidden

setHideAnimation ( hideAnimation )

Returns the value of hideAnimation

setHideMode ( hideMode )

Returns the value of hideMode

setHideOnMaskTap ( hideOnMaskTap )

Returns the value of hideOnMaskTap

setHtml ( html )

Returns the value of html

setIcon ( icon )

Returns the value of icon

setIconAlign ( iconAlign )

Returns the value of iconAlign

setIconCls ( iconCls )

Returns the value of iconCls

setItemId ( itemId )

Returns the value of itemId

setKeyMap ( keyMap )

Returns the value of keyMap

setKeyMapEnabled ( keyMapEnabled )

Returns the value of keyMapEnabled

setLeft ( left )

Returns the value of left

setListeners ( listeners )

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

Parameters

listeners :  Object

The listeners

setMargin ( margin )

Returns the value of margin

setMaxHeight ( maxHeight )

Returns the value of maxHeight

setMaxWidth ( maxWidth )

Returns the value of maxWidth

setMenu ( menu )

Returns the value of menu

setMenuAlign ( menuAlign )

Returns the value of menuAlign

setMinHeight ( minHeight )

Returns the value of minHeight

setMinWidth ( minWidth )

Returns the value of minWidth

setModal ( modal )

Returns the value of modal

setPadding ( padding )

Returns the value of padding

setPlugins ( plugins )

Returns the value of plugins

setPressed ( pressed )

Returns the value of pressed

setPressedCls ( pressedCls )

Returns the value of pressedCls

setPressedDelay ( pressedDelay )

Returns the value of pressedDelay

setPublishes ( publishes )

Returns the value of publishes

setRecord ( record )

Returns the value of record

setRelative ( relative )

Returns the value of relative

setRight ( right )

Returns the value of right

setRipple ( ripple )

Returns the value of ripple

setScope ( scope )

Returns the value of scope

setScrollable ( scrollable )

Returns the value of scrollable

setSelfAlign ( selfAlign )

Returns the value of selfAlign

setShadow ( shadow )

Returns the value of shadow

setShim ( shim )

Returns the value of shim

setShowAnimation ( showAnimation )

Returns the value of showAnimation

setStyle ( style )

Returns the value of style

setTabIndex ( newTabIndex )

Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.

Parameters

newTabIndex :  Number

new tabIndex to set

setText ( text )

Returns the value of text

setTextAlign ( textAlign )

Returns the value of textAlign

setTitle ( title )

Returns the value of title

setToFrontOnShow ( toFrontOnShow )

Returns the value of toFrontOnShow

setToggleHandler ( toggleHandler )

Returns the value of toggleHandler

setTooltip ( tooltip )

Returns the value of tooltip

setTop ( top )

Returns the value of top

setTpl ( tpl )

Returns the value of tpl

setTplWriteMode ( tplWriteMode )

Returns the value of tplWriteMode

setUi ( ui )

Returns the value of ui

setUserSelectable ( userSelectable )

Returns the value of userSelectable

setValue ( value )

Returns the value of value

setWeight ( weight )

Returns the value of weight

setWidth ( width )

Returns the value of width

setX ( x )

Returns the value of x

setY ( y )

Returns the value of y

setZIndex ( zIndex )

Returns the value of zIndex

suspendEvent ( eventName )

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to suspend.

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

un ( eventName, fn, [scope] )

Shorthand for removeListener. Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

unAfter ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

unBefore ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

up ( [selector], [limit] ) : Ext.Container

Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.

Example:

var owningTabPanel = grid.up('tabpanel');

Parameters

selector :  String (optional)

The simple selector to test.

limit :  String/Number/Ext.Component (optional)

This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

Returns

:Ext.Container

The matching ancestor Container (or undefined if no match was found).

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

events

onActivate : function ( this, eOpts )

Fires when a tab is activated

Parameters

this :  Ext.tab.Tab

eOpts : Object

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

onAdded : function ( this, container, index, eOpts )

Fires after a Component had been added to a Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Parent Container

index :  Number

The index of the item within the Container.

eOpts : Object

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

onBeforeBottomChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeCenteredChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeDisabledChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeDockedChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeflexChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when flex changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String/Object

The current value of flex.

oldValue :  Number/String/Object

The previous value of flex.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeHiddenChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeHide : function ( this, eOpts )

Fires before the Component is hidden. Hide may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

onBeforeLeftChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeMaxHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeMaxWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeMinHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeMinWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforePressedChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when pressed changes.

Parameters

sender :  Ext.Button

The instance firing this event.

value :  Boolean

The current value of pressed.

oldValue :  Boolean

The previous value of pressed.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeRightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeScrollableChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeShow : function ( this, eOpts )

Fires before the Component is shown. Show may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

onBeforeTopChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBlur : function ( this, event, eOpts )

Fires when this Component's focusEl loses focus.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The blur event.

eOpts : Object

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

onBottomChange : function ( sender, value, oldValue, eOpts )

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

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

onCenteredChange : function ( sender, value, oldValue, eOpts )

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

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

onDeactivate : function ( this, eOpts )

Fires when a tab is deactivated

Parameters

this :  Ext.tab.Tab

eOpts : Object

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

onDestroy

Fires when the component is destroyed

onDisabledChange : function ( sender, value, oldValue, eOpts )

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

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

onDockedChange : function ( sender, value, oldValue, eOpts )

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

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

onErased : function ( this, eOpts )

Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

onFlexChange : function ( sender, value, oldValue, eOpts )

This event fires when flex changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String/Object

The current value of flex.

oldValue :  Number/String/Object

The previous value of flex.

eOpts : Object

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

onFocus : function ( this, event, eOpts )

Fires when this Component's focusEl receives focus.

Parameters

this :  Ext.Component/Ext.Widget

event :  Ext.event.Event

The focus event.

eOpts : Object

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

onFocusEnter : function ( this, event, eOpts )

Fires when focus enters this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusenter event.

eOpts : Object

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

onFocusLeave : function ( this, event, eOpts )

Fires when focus leaves this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusleave event.

eOpts : Object

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

onFullscreen : function ( this, eOpts )

Fires whenever a Component with the fullscreen config is instantiated

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

onHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

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

onHiddenChange : function ( sender, value, oldValue, eOpts )

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

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

onHide : function ( this, eOpts )

Fires whenever the Component is hidden

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

onInitialize : function ( this, eOpts )

Fires when the component has been initialized

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

onLeftChange : function ( sender, value, oldValue, eOpts )

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

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

onMaxHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

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

onMaxWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

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

onMinHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

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

onMinWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

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

onMoved : function ( this, container, toIndex, fromIndex, eOpts )

Fires when a component si moved within its Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

toIndex :  Number

The new index of the item.

fromIndex :  Number

The old index of the item.

eOpts : Object

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

onPainted : function ( element, eOpts )

Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.

Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly add at least one listener to it, for performance reasons.

Parameters

element :  Ext.dom.Element

The component's outer element (this.element)

eOpts : Object

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

onPositionedChange : function ( this, positioned, eOpts )

Fires whenever there is a change in the positioned status of a component

Parameters

this :  Ext.Component

The component instance

positioned :  Boolean

The component's new positioned state. This becomes true is a component is positioned using the cfg-top, cfg-right, cfg-bottom or cfg-left configs.

eOpts : Object

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

onPressedChange : function ( sender, value, oldValue, eOpts )

This event fires when pressed changes.

Parameters

sender :  Ext.Button

The instance firing this event.

value :  Boolean

The current value of pressed.

oldValue :  Boolean

The previous value of pressed.

eOpts : Object

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

onRelease : function ( this, e, eOpts )
preventable prev

Fires whenever the button is released.

Parameters

this :  Ext.Button

The item added to the Container.

e :  Ext.EventObject

The event object.

eOpts : Object

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

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onRemoved : function ( this, container, index, eOpts )

Fires when a component is removed from a Container

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

index :  Number

The index of the item that was removed.

eOpts : Object

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

onResize : function ( component, width, height, oldWidth, oldHeight, eOpts )

Fires asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:

Parameters

component :  Ext.Component

This Component.

width :  String/Number

The new width.

height :  String/Number

The new height.

oldWidth :  String/Number

The previous width.

oldHeight :  String/Number

The previous height.

eOpts : Object

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

onRightChange : function ( sender, value, oldValue, eOpts )

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

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

onScrollableChange : function ( sender, value, oldValue, eOpts )

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

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

onShow : function ( this, eOpts )

Fires whenever the Component is shown

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

onTap : function ( this, e, eOpts )
preventable prev

Fires whenever a button is tapped.

Parameters

this :  Ext.Button

The item added to the Container.

e :  Ext.EventObject

The event object.

eOpts : Object

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

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onTopChange : function ( sender, value, oldValue, eOpts )

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

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

onWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

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

theme variables

$button-action-ui : map

Parameters for the "action" button UI. Set to null to eliminate the UI from the CSS output.

$button-alt-ui : map

Parameters for the "alt" button UI. Set to null to eliminate the UI from the CSS output.

$button-arrow-horizontal-spacing : Number

The space between the button arrow and text when arrowAlign is 'right'

Defaults to:

5px

$button-arrow-horizontal-spacing-big : Number

The space between the button arrow and text when arrowAlign is 'right' in the big sizing scheme

Defaults to:

8px

$button-arrow-icon : String

Button arrow icon

Defaults to:

$fa-var-caret-down

$button-arrow-icon-color : color

Button arrow icon color

Defaults to:

$button-color

$button-arrow-icon-font-size : Number

Button arrow icon font-size

Defaults to:

null

$button-arrow-icon-font-size-big : Number

Button arrow icon font-size in the big sizing scheme

Defaults to:

null

$button-arrow-icon-size : Number

Button arrow icon size

Defaults to:

$button-line-height

$button-arrow-icon-size-big : Number

Button arrow icon size in the big sizing scheme

Defaults to:

$button-line-height-big

$button-arrow-vertical-spacing : Number

The space between the button arrow and text when arrowAlign is 'bottom'

Defaults to:

null

$button-arrow-vertical-spacing-big : Number

The space between the button arrow and text when arrowAlign is 'bottom' in the big sizing scheme

Defaults to:

null

$button-background-color : color

Button background-color

Defaults to:

$neutral-light-color

$button-background-gradient : String / list

Button background-gradient. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

button-background-gradient($button-background-color)

$button-badge-background-color : color

The background-color of the button's badge

Defaults to:

darken($alert-color, 10%)

$button-badge-background-gradient : String / list

The background-gradient of the button's badge Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

$base-background-gradient

$button-badge-border-color : color

The border-color of the button's badge

Defaults to:

darken($button-badge-background-color, 10%)

$button-badge-border-radius : Number / list

The border-radius of the button's badge

Defaults to:

3px

$button-badge-bottom : Number

Offset of the badge from the bottom of the button

Defaults to:

null

$button-badge-color : color

The text color of the button's badge

Defaults to:

color-by-background($button-badge-background-color)

$button-badge-font-family : String

The font-family of the button's badge

Defaults to:

$button-font-family

$button-badge-font-size : Number

The font-size of the button's badge

Defaults to:

12px

$button-badge-font-size-big : Number

The font-size of the button's badge in the big sizing scheme

Defaults to:

13px

$button-badge-font-weight : String / Number

The font-weight of the button's badge

Defaults to:

null

$button-badge-left : Number

Offset of the badge from the left of the button

Defaults to:

null

$button-badge-line-height : Number

The line-height of the button's badge

Defaults to:

14px

$button-badge-line-height-big : Number

The line-height of the button's badge in the big sizing scheme

Defaults to:

16px

$button-badge-max-width : Number

The max-width of the button's badge

Defaults to:

95%

$button-badge-min-width : Number

The min-width of the button's badge

Defaults to:

null

$button-badge-padding : Number

The padding of the button's badge

Defaults to:

1px 4px

$button-badge-padding-big : Number

The padding of the button's badge in the big sizing scheme

Defaults to:

$button-badge-padding

$button-badge-right : Number

Offset of the badge from the right of the button

Defaults to:

0

$button-badge-top : Number

Offset of the badge from the top of the button

Defaults to:

-3px

$button-border-color : color / list

Button border-color

Defaults to:

button-border-color($button-background-color)

$button-border-radius : Number

Button border-radius

Defaults to:

3px

$button-border-radius-big : Number

Button border-radius in the big sizing scheme

Defaults to:

3px

$button-border-style : String / list

Button border-style

Defaults to:

solid

$button-border-width : Number / list

Button border-width

Defaults to:

1px

$button-box-shadow : list

Button box-shadow

Defaults to:

null

$button-box-shadow-transition : list

Transition for the Button's box-shadow

Defaults to:

null

$button-color : color

Button text color

Defaults to:

button-color($button-background-color)

$button-confirm-ui : map

Parameters for the "confirm" button UI. Set to null to eliminate the UI from the CSS output.

$button-decline-ui : map

Parameters for the "decline" button UI. Set to null to eliminate the UI from the CSS output.

$button-disabled-arrow-icon-color : color

Button arrow icon color when disabled

Defaults to:

$button-disabled-icon-color

$button-disabled-background-color : color

Button background-color when disabled

Defaults to:

button-disabled-background-color($button-background-color)

$button-disabled-background-gradient : String / list

Button background-gradient when disabled. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

button-disabled-background-gradient($button-disabled-background-color)

$button-disabled-border-color : color / list

Button border-color when disabled

Defaults to:

button-disabled-border-color($button-disabled-background-color)

$button-disabled-box-shadow : list

Button box-shadow when disabled

Defaults to:

null

$button-disabled-color : color

Button color when disabled

Defaults to:

button-disabled-color($button-disabled-background-color)

$button-disabled-icon-color : color

Button icon color when disabled

Defaults to:

$button-disabled-color

$button-disabled-opacity : Number

Button opacity when disabled

Defaults to:

.5

$button-flat-ui : map

Parameters for the "flat" button UI. Set to null to eliminate the UI from the CSS output.

$button-focused-arrow-icon-color : color

Button arrow icon color when focused

Defaults to:

$button-focused-icon-color

$button-focused-background-color : color

Button background-color when focused

Defaults to:

button-focused-background-color($button-background-color)

$button-focused-background-gradient : String / list

Button background-gradient when focused. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

button-focused-background-gradient($button-focused-background-color)

$button-focused-border-color : color / list

Button border-color when focused

Defaults to:

button-focused-border-color($button-focused-background-color)

$button-focused-box-shadow : list

Button box-shadow when focused

Defaults to:

null

$button-focused-color : color

Button text color when focused

Defaults to:

button-focused-color($button-focused-background-color, $button-color)

$button-focused-icon-color : color

Button icon color when focused

Defaults to:

$button-focused-color

$button-focused-outline-color : color

Button focus outline color

Defaults to:

button-focused-outline-color($button-background-color, $button-focused-color)

$button-focused-outline-offset : Number

Button focus outline offset

Defaults to:

-2px

$button-focused-outline-style : String

Button focus outline style

Defaults to:

solid

$button-focused-outline-width : Number

Button focus outline width

Defaults to:

1px

$button-font-family : String

Button font-family

Defaults to:

$font-family

$button-font-size : Number

Button font-size

Defaults to:

$font-size

$button-font-size-big : Number

Button font-size in the big sizing scheme

Defaults to:

$font-size-big

$button-font-weight : String / Number

Button font-weight

Defaults to:

$font-weight-bold

$button-hovered-arrow-icon-color : color

Button arrow icon color when hovered

Defaults to:

$button-hovered-icon-color

$button-hovered-background-color : color

Button background-color when hovered

Defaults to:

button-hovered-background-color($button-background-color)

$button-hovered-background-gradient : String / list

Button background-gradient when hovered. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

button-hovered-background-gradient($button-hovered-background-color)

$button-hovered-border-color : color / list

Button border-color when hovered

Defaults to:

button-hovered-border-color($button-hovered-background-color)

$button-hovered-box-shadow : list

Button box-shadow when hovered

Defaults to:

null

$button-hovered-color : color

Button text color when hovered

Defaults to:

button-hovered-color($button-hovered-background-color, $button-color)

$button-hovered-icon-color : color

Button icon color when hovered.

Defaults to:

$button-hovered-color

$button-icon-color : color

Button icon color.

Defaults to:

$button-color

$button-icon-font-size : Number

Button icon font-size

Defaults to:

null

$button-icon-font-size-big : Number

Button icon font-size in the big sizing scheme

Defaults to:

null

$button-icon-horizontal-spacing : Number

The space between the button icon and text when the icon is horizontally aligned

Defaults to:

5px

$button-icon-horizontal-spacing-big : Number

The space between the button icon and text when the icon is horizontally aligned in the big sizing scheme

Defaults to:

8px

$button-icon-only-padding : Number / list

Button padding when an icon is present without text

Defaults to:

nth($button-padding, 1)

$button-icon-only-padding-big : Number / list

Button padding when an icon is present without text in the big sizing scheme

Defaults to:

nth($button-padding-big, 1)

$button-icon-size : Number

Button icon size.

Defaults to:

$button-line-height

$button-icon-size-big : Number

Button icon size in the big sizing scheme

Defaults to:

$button-line-height-big

$button-icon-vertical-spacing : Number

The space between the button icon and text when the icon is vertically aligned

Defaults to:

2px

$button-icon-vertical-spacing-big : Number

The space between the button icon and text when the icon is vertically aligned in the big sizing scheme

Defaults to:

3px

$button-line-height : Number

Button line-height

Defaults to:

16px

$button-line-height-big : Number

Button line-height in the big sizing scheme

Defaults to:

20px

$button-padding : Number / list

Button padding

Defaults to:

3px 8px

$button-padding-big : Number / list

Button padding in the big sizing scheme

Defaults to:

5px 10px

$button-plain-ui : map

Parameters for the "plain" button UI. Set to null to eliminate the UI from the CSS output.

$button-pressed-arrow-icon-color : color

Button arrow icon color when pressed

Defaults to:

$button-pressed-icon-color

$button-pressed-background-color : color

Button background-color when pressed

Defaults to:

button-pressed-background-color($button-background-color)

$button-pressed-background-gradient : String / list

Button background-gradient when pressed. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

button-pressed-background-gradient($button-pressed-background-color)

$button-pressed-border-color : color / list

Button border-color when pressed

Defaults to:

button-pressed-border-color($button-pressed-background-color)

$button-pressed-box-shadow : list

Button box-shadow when pressed

Defaults to:

null

$button-pressed-color : color

Button text color when pressed

Defaults to:

button-pressed-color($button-pressed-background-color, $button-color)

$button-pressed-icon-color : color

Button icon color when pressed.

Defaults to:

$button-pressed-color

$button-raised-ui : map

Parameters for the "raised" button UI. Set to null to eliminate the UI from the CSS output.

$button-round-ui : map

Parameters for the "round" button UI. Set to null to eliminate the UI from the CSS output.

$button-segmented-ui : map

Parameters for the "segmented" button UI. Set to null to eliminate the UI from the CSS output.

Defaults to:

null

$button-square-ui : map

Parameters for the "square" button UI. Set to null to eliminate the UI from the CSS output.

$button-text-transform : String

Button text-transform

Defaults to:

null

$button-text-transform-big : String

Button text-transform in the big sizing scheme

Defaults to:

$button-text-transform

$enable-inverted-alt-button : Boolean

Determines if styles are added to invert text and background colors for confirm & decline buttons UIs when combined with the 'alt' UI

Defaults to:

false

$tab-active-arrow-icon-color : color

Tab arrow icon color when active

Defaults to:

$tab-active-icon-color

$tab-active-background-color : color

Tab background-color when active

Defaults to:

$base-light-color

$tab-active-background-gradient : String / list

Tab background-gradient when active. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

none

$tab-active-border-color : color / list

Tab border-color when active

Defaults to:

null

$tab-active-box-shadow : list

Tab box-shadow when active

Defaults to:

null

$tab-active-close-icon-background-color : color

Tab close icon background-color when the tab is active

Defaults to:

null

$tab-active-close-icon-color : color

Tab close icon color when the tab is active

Defaults to:

null

$tab-active-close-icon-hovered-background-color : color

Tab close icon background-color when the tab is active and the close icon is hovered

Defaults to:

null

$tab-active-close-icon-hovered-color : color

Tab close icon color when the tab is active and the close icon is hovered

Defaults to:

null

$tab-active-close-icon-pressed-background-color : color

Tab close icon background-color when the tab is active and the close icon is pressed

Defaults to:

null

$tab-active-close-icon-pressed-color : color

Tab close icon color when the tab is active and the close icon is pressed

Defaults to:

null

$tab-active-color : color

Tab text color when active

Defaults to:

$base-color

$tab-active-focused-arrow-icon-color : color

Tab arrow icon color when active and focused

Defaults to:

$tab-active-arrow-icon-color

$tab-active-focused-background-color : color

Tab background-color when active and focused

Defaults to:

null

$tab-active-focused-background-gradient : String / list

Tab background-gradient when active and focused. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

none

$tab-active-focused-border-color : color / list

Tab border-color when active and focused

Defaults to:

null

$tab-active-focused-box-shadow : list

Tab box-shadow when active and focused

Defaults to:

null

$tab-active-focused-color : color

Tab text color when active and focused

Defaults to:

$tab-active-color

$tab-active-focused-icon-color : color

Tab icon color when active and focused

Defaults to:

$tab-active-icon-color

$tab-active-focused-outline-color : color

Tab focus outline color when active

Defaults to:

mix($tab-active-background-color, $tab-active-color, 20%)

$tab-active-icon-color : color

Tab icon color when active

Defaults to:

$tab-active-color

$tab-active-indicator-background-color : color

The background-color of the tab's "active indicator"

Defaults to:

null

$tab-active-indicator-height : Number

The height of the tab's "active indicator"

Defaults to:

null

$tab-arrow-horizontal-spacing : Number

The space between the tab arrow and text when arrowAlign is 'right'

Defaults to:

5px

$tab-arrow-horizontal-spacing-big : Number

The space between the tab arrow and text when arrowAlign is 'right' in the big sizing scheme

Defaults to:

8px

$tab-arrow-icon : String

Tab arrow icon

Defaults to:

null

$tab-arrow-icon-color : color

Tab arrow icon color

Defaults to:

$tab-color

$tab-arrow-icon-font-size : Number

Tab arrow icon font-size

Defaults to:

null

$tab-arrow-icon-font-size-big : Number

Tab arrow icon font-size in the big sizing scheme

Defaults to:

null

$tab-arrow-icon-size : Number

Tab arrow icon size

Defaults to:

$tab-line-height

$tab-arrow-icon-size-big : Number

Tab arrow icon size in the big sizing scheme

Defaults to:

$tab-line-height-big

$tab-arrow-vertical-spacing : Number

The space between the tab arrow and text when arrowAlign is 'bottom'

Defaults to:

null

$tab-arrow-vertical-spacing-big : Number

The space between the tab arrow and text when arrowAlign is 'bottom' in the big sizing scheme

Defaults to:

null

$tab-background-color : color

Tab background-color

Defaults to:

mix(#fff, $base-highlight-color, 10%)

$tab-background-gradient : String / list

Tab background-gradient. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

none

$tab-badge-background-color : color

The background-color of the tab's badge

Defaults to:

darken($alert-color, 10%)

$tab-badge-background-gradient : String / list

The background-gradient of the tab's badge Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

$base-background-gradient

$tab-badge-border-color : color

The border-color of the tab's badge

Defaults to:

darken($tab-badge-background-color, 10%)

$tab-badge-border-radius : Number / list

The border-radius of the tab's badge

Defaults to:

3px

$tab-badge-bottom : Number

Offset of the badge from the bottom of the tab

Defaults to:

null

$tab-badge-color : color

The text color of the tab's badge

Defaults to:

color-by-background($tab-badge-background-color)

$tab-badge-font-family : String

The font-family of the tab's badge

Defaults to:

$tab-font-family

$tab-badge-font-size : Number

The font-size of the tab's badge

Defaults to:

$button-badge-font-size

$tab-badge-font-size-big : Number

The font-size of the tab's badge in the big sizing scheme

Defaults to:

$button-badge-font-size-big

$tab-badge-font-weight : String / Number

The font-weight of the tab's badge

Defaults to:

null

$tab-badge-left : Number

Offset of the badge from the left of the tab

Defaults to:

null

$tab-badge-line-height : Number

The line-height of the tab's badge

Defaults to:

$button-badge-line-height

$tab-badge-line-height-big : Number

The line-height of the tab's badge in the big sizing scheme

Defaults to:

$button-badge-line-height-big

$tab-badge-max-width : Number

The max-width of the tab's badge

Defaults to:

95%

$tab-badge-min-width : Number

The min-width of the tab's badge

Defaults to:

$button-badge-min-width

$tab-badge-padding : Number

The padding of the tab's badge

Defaults to:

1px 4px

$tab-badge-padding-big : Number

The padding of the tab's badge in the big sizing scheme

Defaults to:

$tab-badge-padding

$tab-badge-right : Number

Offset of the badge from the right of the tab

Defaults to:

0

$tab-badge-top : Number

Offset of the badge from the top of the tab

Defaults to:

0

$tab-border-color : color / list

Tab border-color

Defaults to:

null

$tab-border-radius : Number

Tab border-radius

Defaults to:

3px 3px 0 0

$tab-border-radius-big : Number

Tab border-radius in the big sizing scheme

Defaults to:

$tab-border-radius

$tab-border-style : String / list

Tab border-style

Defaults to:

null

$tab-border-width : Number / list

Tab border-width

Defaults to:

0

$tab-box-shadow : list

Tab box-shadow

Defaults to:

null

$tab-close-icon : String

Tab close icon

Defaults to:

$fa-var-close

$tab-close-icon-background-color : color

Tab close icon background-color

Defaults to:

null

$tab-close-icon-border-radius : Number / list

Tab close icon border-radius

Defaults to:

3px

$tab-close-icon-border-radius-big : Number / list

Tab close icon border-radius in the big sizing scheme

Defaults to:

null

$tab-close-icon-color : color

Tab close icon color

Defaults to:

null

$tab-close-icon-font-size : Number

Tab close icon font-size

Defaults to:

null

$tab-close-icon-font-size-big : Number

Tab close icon font-size in the big sizing scheme

Defaults to:

null

$tab-close-icon-hovered-background-color : color

Tab close icon background-color when the close icon is hovered

Defaults to:

rgba(0, 0, 0, 0.1)

$tab-close-icon-hovered-color : color

Tab close icon color when the close icon is hovered

Defaults to:

null

$tab-close-icon-margin : Number / list

Tab close icon margin. Used to position the close icon relative to the top right corner of the tab.

Defaults to:

3px

$tab-close-icon-margin-big : Number / list

Tab close icon margin in the big sizing scheme. Used to position the close icon relative to the top right corner of the tab.

Defaults to:

null

$tab-close-icon-pressed-background-color : color

Tab close icon background-color when the close icon is pressed

Defaults to:

rgba(0, 0, 0, 0.2)

$tab-close-icon-pressed-color : color

Tab close icon color when the close icon is pressed

Defaults to:

null

$tab-close-icon-size : Number

Tab close icon size

Defaults to:

12px

$tab-close-icon-size-big : Number

Tab close icon size in the big sizing scheme

Defaults to:

18px

$tab-close-icon-spacing : Number

Additional spacing to add to the side of the tab that contains the close icon when closable

Defaults to:

10px

$tab-close-icon-spacing-big : Number

Additional spacing to add to the side of the tab that contains the close icon when closable in the big sizing scheme

Defaults to:

20px

$tab-color : color

Tab text color

Defaults to:

$light-color

$tab-disabled-arrow-icon-color : color

Tab arrow icon color when disabled

Defaults to:

$tab-disabled-icon-color

$tab-disabled-background-color : color

Tab background-color when disabled

Defaults to:

null

$tab-disabled-background-gradient : String / list

Tab background-gradient when disabled. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

none

$tab-disabled-border-color : color / list

Tab border-color when disabled

Defaults to:

null

$tab-disabled-box-shadow : list

Tab box-shadow when disabled

Defaults to:

null

$tab-disabled-color : color

Tab color when disabled

Defaults to:

$tab-color

$tab-disabled-icon-color : color

Tab icon color when disabled

Defaults to:

$tab-disabled-color

$tab-disabled-opacity : Number

Tab opacity when disabled

Defaults to:

.5

$tab-focused-arrow-icon-color : color

Tab arrow icon color when focused

Defaults to:

$tab-focused-icon-color

$tab-focused-background-color : color

Tab background-color when focused

Defaults to:

null

$tab-focused-background-gradient : String / list

Tab background-gradient when focused. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

none

$tab-focused-border-color : color / list

Tab border-color when focused

Defaults to:

null

$tab-focused-box-shadow : list

Tab box-shadow when focused

Defaults to:

null

$tab-focused-color : color

Tab text color when focused

Defaults to:

$tab-color

$tab-focused-icon-color : color

Tab icon color when focused

Defaults to:

$tab-focused-color

$tab-focused-outline-color : color

Tab focus outline color

Defaults to:

mix($tab-background-color, $tab-color, 20%)

$tab-focused-outline-offset : Number

Tab focus outline offset

Defaults to:

-2px

$tab-focused-outline-style : String

Tab focus outline style

Defaults to:

solid

$tab-focused-outline-width : Number

Tab focus outline width

Defaults to:

1px

$tab-font-family : String

Tab font-family

Defaults to:

$font-family

$tab-font-size : Number

Tab font-size

Defaults to:

$font-size

$tab-font-size-big : Number

Tab font-size in the big sizing scheme

Defaults to:

$font-size-big

$tab-font-weight : String / Number

Tab font-weight

Defaults to:

$font-weight-bold

$tab-hovered-arrow-icon-color : color

Tab arrow icon color when hovered

Defaults to:

$tab-hovered-icon-color

$tab-hovered-background-color : color

Tab background-color when hovered

Defaults to:

mix(#fff, $base-highlight-color, 20%)

$tab-hovered-background-gradient : String / list

Tab background-gradient when hovered. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

none

$tab-hovered-border-color : color / list

Tab border-color when hovered

Defaults to:

null

$tab-hovered-box-shadow : list

Tab box-shadow when hovered

Defaults to:

null

$tab-hovered-color : color

Tab text color when hovered

Defaults to:

$tab-color

$tab-hovered-icon-color : color

Tab icon color when hovered.

Defaults to:

$tab-hovered-color

$tab-icon-color : color

Tab icon color.

Defaults to:

$tab-color

$tab-icon-font-size : Number

Tab icon font-size

Defaults to:

null

$tab-icon-font-size-big : Number

Tab icon font-size in the big sizing scheme

Defaults to:

null

$tab-icon-horizontal-spacing : Number

The space between the tab icon and text when the icon is horizontally aligned

Defaults to:

5px

$tab-icon-horizontal-spacing-big : Number

The space between the tab icon and text when the icon is horizontally aligned in the big sizing scheme

Defaults to:

8px

$tab-icon-only-padding : Number / list

Tab padding when an icon is present without text

Defaults to:

$tab-padding

$tab-icon-only-padding-big : Number / list

Tab padding when an icon is present without text in the big sizing scheme

Defaults to:

$tab-padding-big

$tab-icon-size : Number

Tab icon size

Defaults to:

$tab-line-height

$tab-icon-size-big : Number

Tab icon size in the big sizing scheme

Defaults to:

$tab-line-height-big

$tab-icon-vertical-spacing : Number

The space between the tab icon and text when the icon is vertically aligned

Defaults to:

2px

$tab-icon-vertical-spacing-big : Number

The space between the tab icon and text when the icon is vertically aligned in the big sizing scheme

Defaults to:

3px

$tab-line-height : Number

Tab line-height

Defaults to:

16px

$tab-line-height-big : Number

Tab line-height in the big sizing scheme

Defaults to:

20px

$tab-padding : Number / list

Tab padding

Defaults to:

8px 12px 7px

$tab-padding-big : Number / list

Tab padding in the big sizing scheme

Defaults to:

10px 10px 9px

$tab-pressed-arrow-icon-color : color

Tab arrow icon color when pressed

Defaults to:

$tab-pressed-icon-color

$tab-pressed-background-color : color

Tab background-color when pressed

Defaults to:

$tab-hovered-background-color

$tab-pressed-background-gradient : String / list

Tab background-gradient when pressed. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

none

$tab-pressed-border-color : color / list

Tab border-color when pressed

Defaults to:

null

$tab-pressed-box-shadow : list

Tab box-shadow when pressed

Defaults to:

null

$tab-pressed-color : color

Tab text color when pressed

Defaults to:

$tab-color

$tab-pressed-icon-color : color

Tab icon color when pressed.

Defaults to:

$tab-pressed-color

$tab-stacked-font-size : Number

Tab font-size when iconAlign is 'top' or 'bottom'

Defaults to:

null

$tab-stacked-font-size-big : Number

Tab font-size in the big sizing scheme when iconAlign is 'top' or 'bottom'

Defaults to:

null

$tab-text-transform : String

Tab text-transform

Defaults to:

null

$tab-text-transform-big : String

Tab text-transform in the big sizing scheme

Defaults to:

null

theme mixins

button-alt-invert-ui ( ...list... )
private pri

alt uis + decline/confirm have some magic to swap foreground and background colors. this creates a "alt decline" and "alt confirm".

Parameters

$ui :  Object

$background-color :  Object (optional)

Defaults to: map_get($ui

button-ui ( ...list... )

Creates a visual theme for a Button.

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: button

$background-color :  color

Button background-color

$hovered-background-color :  color

Button background-color when hovered

$pressed-background-color :  color

Button background-color when pressed

$focused-background-color :  color

Button background-color when focused

$disabled-background-color :  color

Button background-color when disabled

$box-shadow :  list

Button box-shadow

$hovered-box-shadow :  list

Button box-shadow when hovered

$pressed-box-shadow :  list

Button box-shadow when pressed

$focused-box-shadow :  list

Button box-shadow when focused

$disabled-box-shadow :  list

Button box-shadow when disabled

$box-shadow-transition :  list

The transition for the Button's box-shadow

$background-gradient :  String/list

Button background-gradient. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$hovered-background-gradient :  String/list

Button background-gradient when hovered. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$pressed-background-gradient :  String/list

Button background-gradient when pressed. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$focused-background-gradient :  String/list

Button background-gradient when focused. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$disabled-background-gradient :  String/list

Button background-gradient when disabled. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$color :  color

Button text color

$hovered-color :  color

Button text color when hovered

$pressed-color :  color

Button text color when pressed

$focused-color :  color

Button text color when focused

$disabled-color :  color

Button color when disabled

$border-color :  color/list

Button border-color

$hovered-border-color :  color/list

Button border-color when hovered

$pressed-border-color :  color/list

Button border-color when pressed

$focused-border-color :  color/list

Button border-color when focused

$disabled-border-color :  color/list

Button border-color when disabled

$focused-outline-color :  color

Button focus outline color

$focused-outline-style :  String

Button focus outline style

$focused-outline-width :  Number

Button focus outline width

$focused-outline-offset :  Number

Button focus outline offset

$border-width :  Number/list

Button border-width

$border-style :  String/list

Button border-style

$border-radius :  Number

Button border-radius

$border-radius-big :  Number

Button border-radius in the big sizing scheme

$font-weight :  String/Number

Button font-weight

$font-size :  Number

Button font-size

$font-size-big :  Number

Button font-size in the big sizing scheme

$line-height :  Number

Button line-height

$line-height-big :  Number

Button line-height in the big sizing scheme

$font-family :  String

Button font-family

$text-transform :  String

Button text-transform

$text-transform-big :  String

Button text-transform in the big sizing scheme

$padding :  Number/list

Button padding

$padding-big :  Number/list

Button padding in the big sizing scheme

$icon-only-padding :  Number/list

Button padding when an icon is present without text

$icon-only-padding-big :  Number/list

Button padding when an icon is present without text in the big sizing scheme

$icon-color :  color

Button icon color.

$hovered-icon-color :  color

Button icon color when hovered.

$pressed-icon-color :  color

Button icon color when pressed.

$focused-icon-color :  color

Button icon color when focused

$disabled-icon-color :  color

Button icon color when disabled

$icon-size :  Number

Button icon size.

$icon-size-big :  Number

Button icon size in the big sizing scheme

$icon-font-size :  Number

Button icon font-size

$icon-font-size-big :  Number

Button icon font-size in the big sizing scheme

$icon-horizontal-spacing :  Number

The space between the button icon and text when the icon is horizontally aligned

$icon-horizontal-spacing-big :  Number

The space between the button icon and text when the icon is horizontally aligned in the big sizing scheme

$icon-vertical-spacing :  Number

The space between the button icon and text when the icon is vertically aligned

$icon-vertical-spacing-big :  Number

The space between the button icon and text when the icon is vertically aligned in the big sizing scheme

$disabled-opacity :  Number

Button opacity when disabled

$arrow-icon :  String

Button arrow icon

$arrow-icon-color :  color

Button arrow icon color

$hovered-arrow-icon-color :  color

Button arrow icon color when hovered

$pressed-arrow-icon-color :  color

Button arrow icon color when pressed

$focused-arrow-icon-color :  color

Button arrow icon color when focused

$disabled-arrow-icon-color :  color

Button arrow icon color when disabled

$arrow-icon-size :  Number

Button arrow icon size

$arrow-icon-size-big :  Number

Button arrow icon size in the big sizing scheme

$arrow-icon-font-size :  Number

Button arrow icon font-size

$arrow-icon-font-size-big :  Number

Button arrow icon font-size in the big sizing scheme

$arrow-horizontal-spacing :  Number

The space between the button arrow and text when arrowAlign is 'right'

$arrow-horizontal-spacing-big :  Number

The space between the button arrow and text when arrowAlign is 'right' in the big sizing scheme

$arrow-vertical-spacing :  Number

The space between the button arrow and text when arrowAlign is 'bottom'

$arrow-vertical-spacing-big :  Number

The space between the button arrow and text when arrowAlign is 'bottom' in the big sizing scheme

$badge-background-color :  color

The background-color of the button's badge

$badge-background-gradient :  String/list

The background-gradient of the button's badge Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$badge-color :  color

The text color of the button's badge

$badge-border-color :  color

The border-color of the button's badge

$badge-border-radius :  Number/list

The border-radius of the button's badge

$badge-min-width :  Number

The min-width of the button's badge

$badge-max-width :  Number

The max-width of the button's badge

$badge-font-weight :  String/Number

The font-weight of the button's badge

$badge-font-size :  Number

The font-size of the button's badge

$badge-font-size-big :  Number

The font-size of the button's badge in the big sizing scheme

$badge-font-family :  String

The font-family of the button's badge

$badge-line-height :  Number

The line-height of the button's badge

$badge-line-height-big :  Number

The line-height of the button's badge in the big sizing scheme

$badge-top :  Number

Offset of the badge from the top of the button

$badge-right :  Number

Offset of the badge from the right of the button

$badge-bottom :  Number

Offset of the badge from the bottom of the button

$badge-left :  Number

Offset of the badge from the left of the button

$badge-padding :  Number

The padding of the button's badge

$badge-padding-big :  Number

The padding of the button's badge in the big sizing scheme

$derive-colors :  Boolean (optional)

Private

Defaults to: true

$derive-border-colors :  Boolean (optional)

Private

Defaults to: true

$derive-outline-colors :  Boolean (optional)

Private

Defaults to: true

$derive-background-colors :  Boolean (optional)

Private

Defaults to: true

$derive-background-gradients :  Boolean (optional)

Private

Defaults to: true

$derive-icon-colors :  Boolean (optional)

Private

Defaults to: true

$derive-arrow-colors :  Boolean (optional)

Private

Defaults to: true

sencha-button-ui ( ...list... )
deprecated dep

Creates a theme UI for buttons. Also automatically generates UIs for {ui-label}-round and {ui-label}-small.

// SCSS
@include sencha-button-ui('secondary', #99A4AE, 'glossy');

// JS
var cancelBtn = new Ext.Button({text: 'Cancel', ui: 'secondary'});

Parameters

$ui-label :  String

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

$color :  color

Base color for the UI.

$gradient :  String

Default gradient for the UI.

Deprecated since version 6.0
Use button-ui instead

sencha-toolbar-ui ( ...list... )
deprecated dep

Creates a theme UI for toolbars.

// SCSS
@include sencha-toolbar-ui('sub', #58710D, 'glossy');

// JS
var myTb = new Ext.Toolbar({title: 'My Green Glossy Toolbar', ui: 'sub'})

Parameters

$ui-label :  String

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

$color :  color

Base color for the UI.

$gradient :  String (optional)

Background gradient style for the UI.

Defaults to: $toolbar-background-gradient

Deprecated since version 6.0
Use ui instead

tab-ui ( ...list... )

Creates a visual theme for a Tab.

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: tab

$background-color :  color

Tab background-color

$hovered-background-color :  color

Tab background-color when hovered

$pressed-background-color :  color

Tab background-color when pressed

$active-background-color :  color

Tab background-color when active

$focused-background-color :  color

Tab background-color when focused

$active-focused-background-color :  color

Tab background-color when active and focused

$disabled-background-color :  color

Tab background-color when disabled

$box-shadow :  list

Tab box-shadow

$hovered-box-shadow :  list

Tab box-shadow when hovered

$pressed-box-shadow :  list

Tab box-shadow when pressed

$active-box-shadow :  list

Tab box-shadow when active

$focused-box-shadow :  list

Tab box-shadow when focused

$active-focused-box-shadow :  list

Tab box-shadow when active and focused

$disabled-box-shadow :  list

Tab box-shadow when disabled

$background-gradient :  String/list

Tab background-gradient. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$hovered-background-gradient :  String/list

Tab background-gradient when hovered. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$pressed-background-gradient :  String/list

Tab background-gradient when pressed. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$active-background-gradient :  String/list

Tab background-gradient when active. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$focused-background-gradient :  String/list

Tab background-gradient when focused. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$active-focused-background-gradient :  String/list

Tab background-gradient when active and focused. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$disabled-background-gradient :  String/list

Tab background-gradient when disabled. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$color :  color

Tab text color

$hovered-color :  color

Tab text color when hovered

$pressed-color :  color

Tab text color when pressed

$active-color :  color

Tab text color when active

$focused-color :  color

Tab text color when focused

$active-focused-color :  color

Tab text color when active and focused

$disabled-color :  color

Tab color when disabled

$border-color :  color/list

Tab border-color

$hovered-border-color :  color/list

Tab border-color when hovered

$pressed-border-color :  color/list

Tab border-color when pressed

$active-border-color :  color/list

Tab border-color when active

$focused-border-color :  color/list

Tab border-color when focused

$active-focused-border-color :  color/list

Tab border-color when active and focused

$disabled-border-color :  color/list

Tab border-color when disabled

$focused-outline-color :  color

Tab focus outline color

$active-focused-outline-color :  color

Tab focus outline color when active

$focused-outline-style :  String

Tab focus outline style

$focused-outline-width :  Number

Tab focus outline width

$focused-outline-offset :  Number

Tab focus outline offset

$border-width :  Number/list

Tab border-width

$border-style :  String/list

Tab border-style

$border-radius :  Number

Tab border-radius

$border-radius-big :  Number

Tab border-radius in the big sizing scheme

$font-weight :  String/Number

Tab font-weight

$font-size :  Number

Tab font-size

$font-size-big :  Number

Tab font-size in the big sizing scheme

$stacked-font-size :  Number

Tab font-size when iconAlign is 'top' or 'bottom'

$stacked-font-size-big :  Number

Tab font-size in the big sizing scheme when iconAlign is 'top' or 'bottom'

$line-height :  Number

Tab line-height

$line-height-big :  Number

Tab line-height in the big sizing scheme

$font-family :  String

Tab font-family

$text-transform :  String

Tab text-transform

$text-transform-big :  String

Tab text-transform in the big sizing scheme

$padding :  Number/list

Tab padding

$padding-big :  Number/list

Tab padding in the big sizing scheme

$icon-only-padding :  Number/list

Tab padding when an icon is present without text

$icon-only-padding-big :  Number/list

Tab padding when an icon is present without text in the big sizing scheme

$icon-color :  color

Tab icon color.

$hovered-icon-color :  color

Tab icon color when hovered.

$pressed-icon-color :  color

Tab icon color when pressed.

$active-icon-color :  color

Tab icon color when active

$focused-icon-color :  color

Tab icon color when focused

$active-focused-icon-color :  color

Tab icon color when active and focused

$disabled-icon-color :  color

Tab icon color when disabled

$icon-size :  Number

Tab icon size

$icon-size-big :  Number

Tab icon size in the big sizing scheme

$icon-font-size :  Number

Tab icon font-size

$icon-font-size-big :  Number

Tab icon font-size in the big sizing scheme

$icon-horizontal-spacing :  Number

The space between the tab icon and text when the icon is horizontally aligned

$icon-horizontal-spacing-big :  Number

The space between the tab icon and text when the icon is horizontally aligned in the big sizing scheme

$icon-vertical-spacing :  Number

The space between the tab icon and text when the icon is vertically aligned

$icon-vertical-spacing-big :  Number

The space between the tab icon and text when the icon is vertically aligned in the big sizing scheme

$disabled-opacity :  Number

Tab opacity when disabled

$arrow-icon :  String

Tab arrow icon

$arrow-icon-color :  color

Tab arrow icon color

$hovered-arrow-icon-color :  color

Tab arrow icon color when hovered

$pressed-arrow-icon-color :  color

Tab arrow icon color when pressed

$active-arrow-icon-color :  color

Tab arrow icon color when active

$focused-arrow-icon-color :  color

Tab arrow icon color when focused

$active-focused-arrow-icon-color :  color

Tab arrow icon color when active and focused

$disabled-arrow-icon-color :  color

Tab arrow icon color when disabled

$arrow-icon-size :  Number

Tab arrow icon size

$arrow-icon-size-big :  Number

Tab arrow icon size in the big sizing scheme

$arrow-icon-font-size :  Number

Tab arrow icon font-size

$arrow-icon-font-size-big :  Number

Tab arrow icon font-size in the big sizing scheme

$arrow-horizontal-spacing :  Number

The space between the tab arrow and text when arrowAlign is 'right'

$arrow-horizontal-spacing-big :  Number

The space between the tab arrow and text when arrowAlign is 'right' in the big sizing scheme

$arrow-vertical-spacing :  Number

The space between the tab arrow and text when arrowAlign is 'bottom'

$arrow-vertical-spacing-big :  Number

The space between the tab arrow and text when arrowAlign is 'bottom' in the big sizing scheme

$badge-background-color :  color

The background-color of the tab's badge

$badge-background-gradient :  String/list

The background-gradient of the tab's badge Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$badge-color :  color

The text color of the tab's badge

$badge-border-color :  color

The border-color of the tab's badge

$badge-border-radius :  Number/list

The border-radius of the tab's badge

$badge-min-width :  Number

The min-width of the tab's badge

$badge-max-width :  Number

The max-width of the tab's badge

$badge-font-weight :  String/Number

The font-weight of the tab's badge

$badge-font-size :  Number

The font-size of the tab's badge

$badge-font-size-big :  Number

The font-size of the tab's badge in the big sizing scheme

$badge-font-family :  String

The font-family of the tab's badge

$badge-line-height :  Number

The line-height of the tab's badge

$badge-line-height-big :  Number

The line-height of the tab's badge in the big sizing scheme

$badge-top :  Number

Offset of the badge from the top of the tab

$badge-right :  Number

Offset of the badge from the right of the tab

$badge-bottom :  Number

Offset of the badge from the bottom of the tab

$badge-left :  Number

Offset of the badge from the left of the tab

$badge-padding :  Number

The padding of the tab's badge

$badge-padding-big :  Number

The padding of the tab's badge in the big sizing scheme

$active-indicator-background-color :  color

The background-color of the tab's "active indicator"

$active-indicator-height :  Number

The height of the tab's "active indicator"

$close-icon :  String

Tab close icon

$close-icon-color :  color

Tab close icon color

$close-icon-hovered-color :  color

Tab close icon color when the close icon is hovered