Docs Help

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.

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

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

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 and inheritance. 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.

Ext JS 5.1.0

Guides
API
top

Right-to-Left Support in Ext JS

Ext JS has an extensive locale library with support for over 40 languages from around the world. Some of these languages are read from right to left. This makes right-to-left (RTL) support a must. Combining Ext JS's localization package with RTL support gives your application a voice for the entire globe.

In this guide, we will walk through enabling RTL support for your application.

Note: To enable localization in your application, please check out the Ext JS locale guide.

RTL with Sencha Cmd

Let's start by generating an application using Sencha Cmd. Simply open your terminal and issue the following commands:

sencha generate app -ext MyApp ./app
cd app
sencha app watch

Note: If you are not familiar with what is happening above, please check out our Getting Started guide.

Enabling RTL

It's incredibly simple to enable RTL in your Cmd generated app. All you need to do is require Ext.rtl.* and set rtl: true.

Ext.define('MyApp.view.main.Main', {
    extend: 'Ext.container.Container',
    requires: [
        'Ext.rtl.*'
    ],
    rtl: true,
    ...

In the case of our generated application, you would add the above code to your Main.js. This can be found in your app/view/main folder. This is the designated Viewport in this instance. If you are not using the generated application, you may also add it to your top level container or Viewport.

Upon adding the above code snippet, you can then rebuild your application:

sencha app build

Once you refresh your application, you should see that your page elements are flipped horizontally and your text is written from right to left.

All children of your top level container with rtl: true will inherit the same functionality. You may indicate rtl:false on a child element to disable RTL for that particular piece of your application.

Locales with RTL

Using locales with RTL, such as Hebrew, will flip your application to RTL by default in the near future. However, at this time, that functionality is tied to Viewport and is not activated when using mainView with a container other than Ext.container.Viewport.

In this case, you can enable RTL for your application as mentioned above.

However, you may not want to hardcode RTL support into your application if you are incorporating multiple locales. In this case, you would need to add a locale override for the language in your application's root directory.

RTL Locale Override

In this section, we will discuss adding an override for the Hebrew locale. This same logic will apply for any other locale needing an override for dynamic RTL support. You would simply replace the "he" with your locale's abbreviation.

  1. Create a folder named "locale" in the root of your application. This would appear at the same level as the app, build, ext, etc.

  2. Add a folder with your locale's abbreviation inside of the locale folder. In this case, we will create a folder called "he".

  3. Create a file called Viewport.js inside of your "he" folder. The resulting file structure should look similar to this:

    You can then add the following override to your Viewport.js override file:

     Ext.define('MyApp.locale.he.Viewport', {
         override: 'Ext.plugin.Viewport',
         requires: 'Ext.rtl.*',
         setCmp: function (cmp) {
    
             this.callParent([cmp]);
    
             cmp.rtl = true;
         }    
     })
    
  4. Now that your override is in place you'll need to alert app.json to its presence so that Cmd recognizes the override and compiles it within your next build. Add the following line to your app.json file:

    "overrides": "${app.dir}/overrides,${app.dir}/locale/${app.locale},
    

This will tell Cmd that it should utilize any file located within your application's overrides and locale folder.

With this override in place, you should be better equipped to generate an application that supports multiple locales without having to hardcode RTL support into your parent container.

RTL without Sencha Cmd

While we encourage users to utilize the powerful tools within Sencha Cmd, we recognize that some folks are not able to use Sencha Cmd. This portion of the guide will walk you through setting up RTL support without using Sencha Cmd.

  1. Update your index.html file to point to your particular flavor of RTL framework file, included with all Ext JS framework downloads after Ext JS 4.2.0. For example:

     build/ext-all-rtl-debug.js
     build/ext-all-rtl.js
    

    This will modify your application to load the RTL-specific library.

  2. Update your index.html file to point to your selected theme's RTL CSS file, included with all Ext JS framework downloads after Ext JS 4.2.0. The default location for these live here:

    build/packages/ext-theme-{themename}/build/resources/ext-theme-{themename}-all-rtl.css
    
  3. Lastly, add rtl: true to your Viewport

This is a sample index.html file using Neptune with RTL support enabled:

<!DOCTYPE html>
<html>
    <head>
        <title>Hello RTL</title>

        <link rel="stylesheet" type="text/css" href="build/packages/ext-theme-neptune/build/resources/ext-theme-neptune-all-rtl.css">
        <script type="text/javascript" src="/releases/extjs/5.0.0/build/ext-all-rtl.js"></script>
        <script type="text/javascript" src="build/packages/ext-theme-neptune/build/ext-theme-neptune.js"></script>

        <script>

            Ext.application({
                name: 'MyApp',
                launch: function() {

                    Ext.create('Ext.container.Viewport', {
                        renderTo: Ext.getBody(),
                        rtl : true,
                        html: "hello I am a bunch of text"
                    });              

                }
            });

        </script>

    </head>
    <body>
    </body>
</html>

Note: Make sure to include the Theme override JS file as seen above

Ext JS 5.1.0

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.0 EA 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation