ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

Or in the case of an ExtReact component class this indicates a member of type prop

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

ExtReact 6.7.0


top

Ext.ux.colorpick.Selector xtype: colorselector

Summary

Sencha Pro Services presents xtype "colorselector". API has been kept as close to the regular colorpicker as possible. The Selector can be rendered to any container.

The defaul selected color is configurable via value config and The Format is configurable via format. Usually used in forms via Ext.ux.colorpick.Button or Ext.ux.colorpick.Field.

Typically you will need to listen for the change event to be notified when the user chooses a color. Alternatively, you can bind to the "value" config

No members found using the current filters

configs

Optional Configs

alphaDecimalFormat : String
bindable bind

The format used by Ext.util.Format#number to format the alpha channel's value.

Defaults to:

#.##

Available since: 7.0.0

getAlphaDecimalFormat : String

Returns the value of alphaDecimalFormat

Returns

String

setAlphaDecimalFormat (alphaDecimalFormat)

Sets the value of alphaDecimalFormat

Parameters

alphaDecimalFormat :  String

cancelButtonText : String

Text value for "Cancel" button; these are relied upon by the Ext.ux.colorpick.Button and the Ext.ux.colorpick.Field.

Defaults to:

'Cancel'

color : Object
bindable bind private pri

This config property is used internally by the UI to maintain the full color. Changes to this config are automatically reflected in value and vise-versa. Setting value can, however, cause the alpha to be dropped if the new value does not contain an alpha component.

Defaults to:

null

getColor : Object

Returns the value of color

Returns

Object

setColor (color)

Sets the value of color

Parameters

color :  Object

fieldPad : Number

padding between the sliders and HEX/R/G/B fields.

Defaults to:

5

fieldWidth : Number

Width of the text fields on the container (excluding HEX); since the width of the slider containers is the same as the text field under it (it's the same vbox column), changing this value will also affect the spacing between the sliders.

Defaults to:

50

format : "hex6" / "hex8" / "#hex6" / "#hex8" / "HEX6" / "HEX8" / "#HEX6" / "#HEX8"
bindable bind

The color format to for the value config. The value can be set using any supported format or named color, but the stored value will always be in this format.

Supported formats are:

  • hex6 - For example "ffaa00" (Note: does not preserve transparency).
  • hex8 - For eaxmple "ffaa00ff" - the last 2 digits represent transparency
  • hex6 - For example "#ffaa00" (same as "hex6" but with a leading "#").

  • hex8 - For example "#ffaa00ff" (same as "hex8" but with a leading "#").

  • HEX6 - Same as "hex6" but upper case.
  • HEX8 - Same as "hex8" but upper case.
  • HEX6 - Same as "#hex6" but upper case.

  • HEX8 - Same as "#hex8" but upper case.

Defaults to:

hex6

getFormat : "hex6" / "hex8" / "#hex6" / "#hex8" / "HEX6" / "HEX8" / "#HEX6" / "#HEX8"

Returns the value of format

Returns

"hex6" / "hex8" / "#hex6" / "#hex8" / "HEX6" / "HEX8" / "#HEX6" / "#HEX8"

setFormat (format)

Sets the value of format

Parameters

format :  "hex6" / "hex8" / "#hex6" / "#hex8" / "HEX6" / "HEX8" / "#HEX6" / "#HEX8"

okButtonText : String

Text value for "Ok" button; these are relied upon by the Ext.ux.colorpick.Button and the Ext.ux.colorpick.Field.

Defaults to:

'OK'

showOkCancelButtons : Boolean

Whether Ok and Cancel buttons (in upper right, below the selected color preview) should be shown; these are relied upon by the Ext.ux.colorpick.Button and the Ext.ux.colorpick.Field.

Defaults to:

false

showPreviousColor : Boolean

Whether "previous color" region (in upper right, below the selected color preview) should be shown; these are relied upon by the Ext.ux.colorpick.Button and the Ext.ux.colorpick.Field.

Defaults to:

false

value : String
bindable bind

The initial color to highlight; see format for supported formats.

Defaults to:

FF0000

getValue : String

Returns the value of value

Returns

String

setValue (value)

Sets the value of value

Parameters

value :  String

properties

Instance Properties

width

default width and height gives 255x255 color map in Crisp

Defaults to:

Ext.platformTags.phone ? 'auto' : 580

methods

Static Methods

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

events

cancel ( this, eOpts )

Fires when Cancel button is clicked (see showOkCancelButtons).

Parameters

this :  Ext.ux.colorpick.Selector

eOpts : Object

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

change ( this, color, previousColor, eOpts )

Fires when a color is selected. Simply dragging sliders around will trigger this.

Parameters

this :  Ext.ux.colorpick.Selector

color :  String

The value of the selected color as per specified format.

previousColor :  String

The previous color value.

eOpts : Object

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

ok ( this, color, eOpts )

Fires when OK button is clicked (see showOkCancelButtons).

Parameters

this :  Ext.ux.colorpick.Selector

color :  String

The value of the selected color as per specified format.

eOpts : Object

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

ExtReact 6.7.0