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 7.0.0


top
premium

Froala WYSIWYG editor in ExtJS 7.0

The ExtJS 7.0 has a Premium code package that lets you use the Froala WYSIWYG editor within your applications.

There are two versions of the component: a field version, for use in forms, and a regular component version, used anywhere else.

Both classes are simple wrappers around the Froala WYSIWYG editor, documented at https://www.froala.com/wysiwyg-editor. These are ExtJS components, so you can use them like any other component, including setting up listeners to detect component events and Froala native events. You can also run native Froala methods directly on the Froala instance.

Froala Editor

Installation

The Froala code package is available via Open Tooling (ext-gen) as an npm package as well as a Sencha Cmd package hosted on Sencha's CDN.

Install via Open Tools and npm

Links to detailed installation steps are given below, but in a nutshell you must:

  1. Log in to the Sencha npm repository npm login --registry=https://sencha.myget.org/F/community/npm/ --scope=@sencha
  2. Use a terminal window and navigate to your ext-gen project and run npm -i --save @sencha/ext-froala-editor
  3. Configure your app to use the new code package by updating your app's app.json and workspace.json

For details on npm repo login see Login to the npm repository.

For details on adding a package see Premium Packages - Add App Functionality Quickly.

Install via Sencha Cmd Packages on Sencha's CDN

  1. Configure your app to use the new code package by updating your app's app.json requires array to include the package
  2. Sencha Cmd will automatically download and install the new code package the next time you build your application

Using the Froala Editor

There are two versions of the Froala Editor:

  • A component version — Ext.froala.Editor
  • A field version — Ext.froala.EditorField

These components are wrappers around a Froala Editor instance. They are configured and used identically, but the field version extends Ext.field.Field, and consequently, can be given a name and value, and be used in field panels and form panels.

Basic usage

There are two primary configs: value, which is the HTML value of the editor, and editor, which is the configuration for the Froala Editor instance being created.

The value config

The value config specifies the initial value of the editor. value is bindable and is the default bind property. Note that value is HTMl and therefore, will contain HTML tags.

Getting the value example:

myFroalaComponent.setValue('Hello world!');
console.log(myFroalaComponent.getValue()); // Logs "<p>Hello world!</p>"

Simple example:

Within a form you can use the field version. Its name-value pair will be reflected in form submits, or when calling getValue() on the form.

Froala instance configuration

The editor config lets you configure the Froala editor instance. You can use any Froala config, as documented at Froala Options.

Events

To listen to events, use the standard listeners component config. You can listen to native Froala events by using the froala prefix on the event name. Froala events are documented at Froala Events.

This example shows a Froala editor configured with listener for its change event, and in addition, a listener to the native Froala click event, specified by using the _froala-+ prefix.

Running Froala native methods

To run native Froala methods, use getEditor() to get a reference to the Froala instance, then run any method you wish. Froala methods are documented at Froala Methods.

For example, to get the character count you'd use this expression:

myFroalaComponent.getEditor().charCounter.count()

Startup time

When the FroalaEditor or FroalaEditorField is created, it takes a few milliseconds for the wrapped Froala instance to be created and initialized. When setting up events, this is transparent, but if you need to detect when the instance is ready, use the ready event. The instance also has a isReady boolean property that starts out false, and changes to true when the component is initialized.

This code illustrates the relationship between the property and event.

Specifying a Froala activation key

To use a licensed copy of the Froala Editor, you need an activation key, as documented at What is an Activation Key?

Note: The Froala Editor will display a red unlicensed banner when it is deployed to a published site without the activation key. Sencha Enterprise customers can request a free 12-month Froala Enterprise license for use with the Froala component by sending an email to support@froala.com with their Sencha ID/customer account in an email, using "Sencha Ext JS 7.0 Froala Key Request" as the subject line.

You then specify the key in your applications app.json, within a config block named froala. This is an example that shows a section of app.json with the requires entry for the froala-editor code package, as well as the specification for the activation key.

{
    "name": "MyApp",
    "namespace": "MyApp",
    "framework": "ext",
    "requires": ["font-awesome", "froala-editor"],
    "froala" {
        "activation-key": "my-activation-key"
    }

    //...
}

Ext JS 7.0.0