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

Ext JS 8.0.0


top

What's New in Ext JS 8.0

Introduction

We’re excited to announce the release of Sencha Ext JS 8.0 with new features and enhancements across both the Modern and Classic toolkits.
This release focuses on improving accessibility, adding powerful UI components, and expanding support for modern web standards such as Font Awesome 7.

Highlights

Font Awesome 7 Support (Core)

Ext JS now ships with Font Awesome 7.x as the default icon set for both Modern and Classic toolkits.

Key Aspects:

  • Framework now supports the most recent Font Awesome 7 icon set across Classic and Modern toolkits.
  • Ensures icons align with the official FA7 website cheat sheet for consistent usage.
  • Official docs now include guidance for developers on using FA7 in applications.
  • Default icons updated to point to FA7.x.
  • Font Awesome

    Font-Awesome


Responsive Digital Signature Pad (Core)

New addon component for smooth, responsive signature capture with support for both toolkits.

Key Aspects:

  • Works seamlessly with Ext JS Modern and Classic, built by extending Ext JS components, and uses Font Awesome icons.

  • Can be rendered inside Grid, Form, or Panels, supporting Ext JS configs, events, methods, properties, and themes (variables & mixins).

- Includes Undo / Redo, Clear, Pen Width/Size, Background Color, Color Picker, Save As (JPG, PNG, SVG), plus Preview, Title, and Signature placeholders.

{
    xtype: 'signature',
    penColor: '#000',
    penStrokeWidth: 2,
    minStrokeRatio: 0.7,
    listeners: {
        beginStroke: function(cmp) {
            console.log('Signature beginStroke:', cmp);
        },
        endStroke: function(cmp) {
            console.log('Signature endStroke:', cmp);
        }
    }
}

Signature Pad


QR Code Reader & Generator (Core)

Ext JS introduces a QR Code Reader/Generator component available for both Modern and Classic toolkits. This component enables developers to easily generate and read QR codes directly within their Ext JS applications, supporting a variety of use cases such as payments, and data sharing.

Key Aspects

  • Works with Ext JS Modern and Classic, exposing a API to generate and read QR codes, with support for configs, events, methods, and themes.

  • Generate QR codes for **URLs, text, VCARD/MeCard, calendar events, geolocation, phone & SMS, email, Wi-Fi configs and payments with customizable options as per requirement.

  • Supports SVG, Canvas, and PNG rendering, with options to download as image (PNG/SVG), copy data to clipboard, and preview before saving.

  • Allows custom foreground/background colors, size control (e.g., 128px, 256px, etc.), responsive UI for desktop & mobile, and input sanitization for security.

  • Outlined steps for self-upgrading the QR Code library to access the latest features and ensure smoother future upgrades.

  • QR Code Modern

  • QR Code Classic
{
        xtype: 'qrcode',
        padding: 20,
        type: 'email',
        data: {
            email: '[email protected]',
            subject: 'QR code generation example',
            body: 'QR code generated through sencha'
        },
        listeners:{
            qrgenerated: function(QRCodeClassInstance, dataPassed) {
                console.log("QR Code Generated");
            }
        }

  }

QR Code


New Lockable Grid Plugin for Modern Toolkit

Introducing a new Lockable Grid plugin for the Modern toolkit to provide full lockable grid functionality. This plugin is designed to be simple to use, easy to configure, and supports flexible customizations.

Key Aspects:

  • Implements column locking/unlocking behavior natively in the Modern Grid.
  • Supports horizontal/vertical scrolling sync between locked and normal regions.
  • Maintains feature compatibility (selection models, cell editing, summaries, etc.).
  • Kitchen Sink Example
  {
    xtype: 'grid',
    plugins: [{
        type: 'lockable'
    }],
    store: myStore,
    columns: [{
        text: 'ID',
        dataIndex: 'id',
        locked: true
    },{
        text: 'Name',
        dataIndex: 'name'
    },{
        text: 'Email',
        dataIndex: 'email'
    }]
}

Lockable Plugin


Buffered Renderer with Horizontal Buffering (Modern)

Improved grid rendering with column virtualization for large datasets.

Key Aspects:

  • Renders only visible + buffered cells.
  • Greatly boosts performance for 1000+ columns.
  • Works with row/column locking, grouping, filtering, editing, accessibility, RTL, themes.
  • Enhanced scroller for very wide grids.
  • Kitchen Sink Example
Ext.create('Ext.grid.Grid', {
    title: 'Simpsons',

    store: store,
    bufferedColumns: true, // Enable virtual column rendering

    columns: [
        { text: 'Name',  dataIndex: 'name', width: 200 },
        { text: 'Email', dataIndex: 'email', width: 250 },
        { text: 'Phone', dataIndex: 'phone', width: 120 }
    ],

    height: 200,
    layout: 'fit',
    fullscreen: true
});

Dialog Boundary Control (Modern)

Ext.Dialog now supports boundary-aware maximize, minimize, and drag.

Key Aspects:

  • Ext.Dialog should maximize, minimize, and drag only within the boundaries of its parent container/panel, rather than defaulting to the full viewport.

  • Added a new owner value to the constrainDrag configuration, enabling developers to constrain dialog dragging to the bounds of its owner component

  • Added a new owner value to the maximizable configuration, enabling developers to constrain maximize to the bounds of its owner component

  • Even though dialogs are floated, they should still respect the boundaries of their parent container/panel when maximized, minimized, or dragged.

Ext.create({
    xtype: 'panel',
    title: 'Parent Container',
    width: 600,
    height: 400,
    renderTo: Ext.getBody(),
    items: [{
        title: 'Dialog',
        closable: true,
        modal: false,

        constrainDrag: 'owner',
        maximizable: 'owner',

        bodyPadding: 30,
        maxWidth: 300,
        html: 'This is a dialog, which extends from Panel and adds some extra features.'
    }]
});

Dialog Control


Accessibility: ARIA Support for Fields (Modern)

Full ARIA support for form fields and triggers.

Key Aspects:

  • Proper ARIA properties and roles applied during render.
  • Ensures compatibility with screen readers (JAWS, Narrator, TalkBack, VoiceOver).

Tri-State Checkbox (Classic)

TreePanel checkboxes now support tri-state (checked, unchecked, indeterminate).

Key Aspects:

  • Config enableTri: true enables feature.
  • Parent node reflects children’s state automatically.
  • Matches Material Design and accessibility expectations.
  • Minimal developer effort (no event changes).
  • Kitchen Sink Example
  Ext.create('Ext.tree.Panel', {
    title: 'Tri-State Tree Example',
    width: 400,
    height: 300,
    rootVisible: false,
    renderTo: Ext.getBody(),
    enableTri: true,
    checkable: true,
    checkOnTriTap: false,
    store: {
        root: {
            expanded: true,
            children: [
                {
                    text: 'Parent Node',
                    expanded: true,
                    children: [
                        { text: 'Child 1', leaf: true, checked: true },
                        { text: 'Child 2', leaf: true, checked: false }
                    ]
                }
            ]
        }
    }
});

Tri-state checkboxes


Ext JS 8.0.0