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 5.1.4


top

Global_CSS

No members found using the current filters

theme variables

$base-color : color

The base color to be used throughout the theme.

Defaults to:

#808080

$base-gradient : String

The base gradient to be used throughout the theme.

Defaults to:

'matte'

$body-background-color : color

Background color to apply to the body element. If set to transparent or 'none' no background-color style will be set on the body element.

Defaults to:

transparent

$color : color

The default text color to be used throughout the theme.

Defaults to:

#000

$css-shadow-border-radius : Number

The border radius for CSS shadows

Defaults to:

5px

$enable-font-smoothing : Boolean

True to add font-smoothing styles to all components

Defaults to:

true

$font-family : String

The default font-family to be used throughout the theme.

Defaults to:

helvetica, arial, verdana, sans-serif

$font-size : Number

The default font-size to be used throughout the theme.

Defaults to:

13px

$font-weight : String / Number

The default font-weight to be used throughout the theme.

Defaults to:

normal

$font-weight-bold : String / Number

The default font-weight for bold font to be used throughout the theme.

Defaults to:

bold

$grid-cell-field-src-included : Boolean
private pri

Flag to ensure GridField rules only get set once

Defaults to:

false

$image-extension : String

default file extension to use for images (defaults to 'png').

Defaults to:

'png'

$image-search-path : String

Default search path for images

Defaults to:

'.'

$include-chrome : Boolean

True to include Chrome specific rules

Defaults to:

$include-webkit

$include-default-uis : Boolean

True to include the default UI for each component.

Defaults to:

true

$include-ff : Boolean

True to include Firefox specific rules

Defaults to:

true

$include-ie : Boolean

True to include Internet Explorer specific rules for IE9 and lower. IE10 and up are considered to be "modern" browsers, and as such do not need any of the CSS hacks required for IE9 and below. Setting this property to false will result in a significantly smaller CSS file size, and may also result in a slight performance improvement, because the browser will have fewer rules to process.

Defaults to:

true

$include-not-found-images : Boolean

True to include files which are not found when compiling your SASS

Defaults to:

true

$include-opera : Boolean

True to include Opera specific rules

Defaults to:

true

$include-rtl : Boolean
readonly ro

True to include right-to-left style rules. This variable gets set to true automatically for rtl builds. You should not need to ever assign a value to this variable, however it can be used to suppress rtl-specific rules when they are not needed. For example: @if $include-rtl { .x-rtl.foo { margin-left: $margin-right; margin-right: $margin-left; } }

Defaults to:

true

$include-safari : Boolean

True to include Safari specific rules

Defaults to:

$include-webkit

$include-slicer-border-radius : Boolean

True to include rules for rounded corners produced by the slicer. Enables emulation of CSS3 border-radius in browsers that do not support it.

Defaults to:

$include-ie

$include-slicer-gradient : Boolean

True to include rules for background gradients produced by the slicer. Enables emulation of CSS3 background-gradient in browsers that do not support it.

Defaults to:

$include-ie

$include-webkit : Boolean

True to include Webkit specific rules

Defaults to:

true

$line-height : String / Number

The default line-height to be used throughout the theme.

Defaults to:

normal

$neutral-color : color

The neutral color to be used throughout the theme.

Defaults to:

#dcdcdc

$prefix : String

The prefix to be applied to all CSS selectors. If this is changed, it must also be changed in your JavaScript application.

Defaults to:

'x-'

$relative-image-path-for-uis : Boolean / String

True to use a relative image path for all new UIs. If true, the path will be "../images/". It can also be a string of the path value. It defaults to false, which means it will look for the images in the ExtJS SDK folder.

Defaults to:

false

$slicer-image-extension : String

default file extension to use for slicer images (defaults to 'gif').

Defaults to:

'gif'

$theme-resource-path : String

The base path relative to the CSS output directory to use for theme resources. For example if the theme's images live one directory up from the generated CSS output in a directory named 'foo/images/', you would need to set this variable to '../foo/' in order for the image paths in the CSS output to be generated correctly. By default this is the same as the CSS output directory.

Defaults to:

''

theme mixins

background-gradient ( ...list... )

Creates a background gradient.

Example usage: .foo { @include background-gradient(#808080, matte, left); }

Parameters

$bg-color :  Color

The background color of the gradient

$type :  String/List (optional)

The type of gradient to be used. Can either be a String which is a predefined gradient name, or it can can be a list of color stops. If null is passed, this mixin will still set the background-color to $bg-color. The available predefined gradient names are:

  • bevel
  • glossy
  • recessed
  • matte
  • matte-reverse
  • panel-header
  • tabbar
  • tab
  • tab-active
  • tab-over
  • tab-disabled
  • grid-header
  • grid-header-over
  • grid-row-over
  • grid-cell-special
  • glossy-button
  • glossy-button-over
  • glossy-button-pressed

Each of these gradient names corresponds to a function named linear-gradient[name]. Themes can override these functions to customize the color stops that they return. For example, to override the glossy-button gradient function add a function named "linear-gradient-glossy-button" to a file named "sass/etc/mixins/background-gradient.scss" in your theme. The function should return the result of calling the Compass linear-gradient function with the desired direction and color-stop information for the gradient. For example:

@function linear-gradient-glossy-button($direction, $bg-color) {
    @return linear-gradient($direction, color_stops(
        mix(#fff, $bg-color, 10%),
        $bg-color 50%,
        mix(#000, $bg-color, 5%) 51%,
        $bg-color
    ));
}

Defaults to: $base-gradient

$direction :  String (optional)

The direction of the gradient. Can either be top or left.

Defaults to: top

css-outline ( ...list... )

adds a css outline to an element with compatibility for IE8/outline-offset NOTE: the element receiving the outline must be positioned (either relative or absolute) in order for the outline to work in IE8

Parameters

$width :  Number (optional)

The width of the outline

Defaults to: 1px

$style :  String (optional)

The style of the outline

Defaults to: solid

$color :  color (optional)

The color of the outline

Defaults to: #000

$offset :  Number (optional)

The offset of the outline

Defaults to: 0

$border-width :  Number/list (optional)

The border-width of the element receiving the outline. Required in order for outline-offset to work in IE8

Defaults to: 0

google-webfont ( ...list... )

Includes a google webfont for use in your theme.

Parameters

$font-name :  String

The name of the font. If the font name contains spaces use "+" instead of space.

$font-weights :  String (optional)

Comma-separated list of font weights to include.

Example usage:

@include google-webfont(
    $font-name: Exo,
    $font-weights: 200 300 400
);

Outputs:

@import url(//fonts.googleapis.com/css?family=Exo:200,300,400);

Defaults to: 400

Ext JS 5.1.4