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 6.2.1 - Modern Toolkit


top

Global_CSS

Summary

Global CSS variables and mixins.

No members found using the current filters

methods

Instance Methods

brightness ( $color ) : Number

Returns the brightness (out of 100) of a specified color.

Parameters

$color :  color

The color you want the brightness value of

Returns

:Number

color-difference ( $sc1 )
private pri

Parameters

$sc1 :  color

color-luminance ( $value )
private pri

Parameters

$value :  color

contrast-ratio ( $color1, $color2 ) : Number

Returns the contrast ratio between two colors

Parameters

$color1 :  color

The color to check

$color2 :  color

The color to check against

Returns

:Number

luminosity ( color ) : Number

Returns the luminosity for a specified color

Parameters

color :  color

The color to check

Returns

:Number

theme variables

$active-color : color

Color used for elements like selected rows and certain overlays like the picker mask.

Defaults to:

darken(saturate($base-color, 55%), 10%)

$active-color : color

Color used for elements like selected rows, "action" UIs (eg. on buttons) and certain overlays like the picker mask.

$alert-color : color

Color used for elements like badges, errors, and "decline" UIs (eg. on buttons).

Defaults to:

#c30

$base-background-gradient : String

The primary gradient variable from which most elements derive their color scheme.

See background-gradient mixin.

Defaults to:

if($enable-highlights, matte, null)

$base-color : color

The primary color variable from which most elements derive their color scheme.

Defaults to:

#808080

$base-color : color

The primary color variable from which most elements derive their color scheme.

Defaults to:

#157fcc

$base-color : color

The primary color variable from which most elements derive their color scheme.

$base-dark-color : color

A dark shade of the base color

Defaults to:

mix(#000, $base-color, 14%)

$base-highlight-color : color

A slightly lightened shade of the base color

Defaults to:

mix(#fff, $base-color, 15%)

$base-light-color : color

A light shade of the base color

Defaults to:

mix(#fff, $base-color, 65%)

$basic-slider : Boolean

Optionally remove CSS3 effects from the slider component for improved performance.

Defaults to:

false

$color : color

Base text color to be used throughout the theme

Defaults to:

#000

$confirm-color : color

Color used for elements like success messages, and "confirm" UIs (eg. on buttons).

$css-shadow-border-radius : Number

The border radius for CSS shadows in the Classic toolkit.

Defaults to:

5px

$css-variable-selector : String

Selector to determine where CSS variables are inserted

Defaults to:

':root'

$enable-big : Boolean

true to enable support for a "big" sizing scheme. "Big" sizing is enabled by a 'x-big' CSS class on the <html> element. Typically used to provide "tappable sizing for touch-enabled devices.

Defaults to:

true

$enable-border-radius : Boolean

Optionally disable all border-radius. Useful for CSS debugging, non-performant browsers, or minimalist designs.

$enable-default-uis : Boolean

Decides whether or not to include the default UIs for all components.

$enable-floated-shadows : Boolean

Determines if Ext.Component#floated items have shadows

Defaults to:

true

$enable-font-smoothing : Boolean

True to add font-smoothing styles to all components

Defaults to:

true

$enable-missing-images : Boolean

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

$enable-status-bar-padding : Boolean

Determines if a padding is applied to the whole application when inside a webview on iOS disable this if your hybrid application is not using a overlay status bar on iOS

Defaults to:

true

$font-family : String

The font-family to be used throughout the theme.

See background-gradient mixin.

Defaults to:

helvetica, arial, sans-serif

$font-icon-font-family : String
private pri

The font-family to use for font icons throughout the theme.

Defaults to:

FontAwesome

$font-size : Number

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

Defaults to:

pxToRootPct(13px)

$font-size-big : Number

The base font-size to be used throughout the theme in the big sizing scheme

Defaults to:

pxToRootPct(15px)

$font-weight-bold : String / Number

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

Defaults to:

bold

$font-weight-normal : String / Number

The "normal" font-weight to be used throughout the theme.

Defaults to:

normal

$global-list-height : measurement
private pri

The minimum row height for items like toolbars.

Defaults to:

46px

$global-list-height : measurement

The minimum row height for items like toolbars.

Defaults to:

46px

$global-row-height : measurement
private pri

The minimum row height for items like toolbars.

Defaults to:

2.6em

$global-row-height : measurement

The minimum row height for items like toolbars.

Defaults to:

2.6em

$highlight-color : color

A somewhat lightened shade of the base text color

Defaults to:

#666

$image-extension : String

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

Defaults to:

'png'

$include-default-uis : Boolean

Decides whether or not to include the default UIs for all components.

Defaults to:

true

$include-form-sliders : Boolean

Decides if default HTML styles are included (for components with styleHtmlContent: true). Class is applied to .x-html.

Defaults to:

true

$include-highlights : Boolean

$enable-highlights=true Optionally disable all gradients, text-shadows, and box-shadows. Useful for CSS debugging, non-performant browsers, or minimalist designs.

Defaults to:

true

$include-html-style : Boolean

Optionally remove included HTML styles/typography (for components with styleHtmlContent: true). Styles are scoped to .x-html. Set t o false to reduce CSS weight.

Defaults to:

true

$light-color : color

A light text color for use on dark backgrounds

Defaults to:

#fff

$line-height : Number

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

Defaults to:

1.25

$loading-spinner-color : color

Background-color for the bars in the loading spinner.

Defaults to:

#aaa

$loading-spinner-color : color

Background-color for the bars in the loading spinner.

Defaults to:

#aaa

$neutral-color : color

Base neutral color from which neutral colors throughout the theme are derived

Defaults to:

#e1e1e1

$neutral-dark-color : color

A dark shade of the neutral color

Defaults to:

mix(#000, $neutral-color, 22%)

$neutral-highlight-color : color

A light shade of the neutral color

Defaults to:

mix(#fff, $neutral-color, 50%)

$neutral-light-color : color

A light shade of the neutral color

Defaults to:

mix(#fff, $neutral-color, 68%)

$neutral-medium-dark-color : color

A medium-dark shade of the neutral color

Defaults to:

mix(#000, $neutral-color, 14%)

$page-bg-color : color

Background color for fullscreen components.

$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

$shadow-blur-radius : Number

The width in pixels by which the specified Global_CSS#$shadow-width is blurred to create a soft shadow effect. If set to 0 the shadow will be sharp, the higher the number, the more blurred it will be, and the further out the shadow will extend. For instance a shadow with Global_CSS#$shadow-width of 5px that also has a 5px blur radius will be 10px of total shadow..

Defaults to:

8px

$shadow-color : color

The color of the shadow in the Modern toolkit. Usually with a transparency element, eg: rgba(0, 0, 0, 0.4).

Defaults to:

rgba(0, 0, 0, 0.4)

$shadow-width : Number

The width in pixels by which shadows exceed their owning component borders all round in the Modern toolkit. A light source direction may be added to skew this in any direction by use of Global_CSS#$shadow-x-offset and Global_CSS#$shadow-y-offset.

Defaults to:

0

$shadow-x-offset : Number

The X pixel offset by which to shift drop shadows behind floated components in the Modern toolkit. By default, shadows are centered below their component, and spread by Global_CSS#$shadow-width pixels.

Defaults to:

2px

$shadow-y-offset : Number

The Y pixel offset by which to shift drop shadows behind floated components in the Modern toolkit. By default, shadows are centered below their component, and spread by Global_CSS#$shadow-width pixels.

Defaults to:

2px

$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:

''

default-calc-value : Number
private pri

Number that is used to replace null values in calc formulas

Defaults to:

0%

enable-css-variables : Boolean

When true will reference CSS variables for all exported variables used in the theme. Otherwise normal sass conversion will apply.

theme mixins

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

Adds a background gradient into a specified selector.

@include background-gradient(#444, 'glossy');

You can also use color-stops if you want full control of the gradient:

@include background-gradient(#444, color-stops(#333, #222, #111));

Parameters

$bg-color :  Color

The base color of the gradient.

$type :  String/List (optional)

The style of the gradient, one of five pre-defined options: matte, bevel, glossy, recessed, or linear: @include background-gradient(red, 'glossy'); It can also accept a list of color-stop values:; @include background-gradient(black, color-stops(#333, #111, #000)); Values 'flat' and 'none' will result in no gradient, just flat background-color

Defaults to: matte

$direction :  String

The direction of the gradient.

bevel-box ( ...list... )

Adds a small box shadow (or highlight) to give the impression of being beveled.

Parameters

$type :  String

Either shadow or highlight, decides whether to apply a light shadow or dark.

bevel-by-background ( ...list... )

Bevels the text based on its background.

Parameters

$bg-color :  color

Background color of element. See bevel-text.

bevel-text ( ...list... )

Adds a small text shadow (or highlight) to give the impression of beveled text.

Parameters

$type :  String

Either shadow or highlight, decides whether to apply a light shadow or dark.

border ( ...list... )
private pri

Creates a border on an element. If any of the parameters is specified as a list, or if any paramter is null, border-style, border-width, and border-color will be specified as separate properties, otherwise all will be collapsed into a single "border" property.

Parameters

$width :  Number/list

The border-width

$style :  String/list

The border-style

$color :  color/list

The border-color

border-bottom ( ...list... )
private pri

Creates a bottom border. If all arguments are non-null they will be collapsed into a single border property.

Parameters

$width :  Number/list

The border-width

$style :  String/list

The border-style

$color :  color/list

The border-color

border-left ( ...list... )
private pri

Creates a left border. If all arguments are non-null they will be collapsed into a single border property.

Parameters

$width :  Number/list

The border-width

$style :  String/list

The border-style

$color :  color/list

The border-color

border-right ( ...list... )
private pri

Creates a right border. If all arguments are non-null they will be collapsed into a single border property.

Parameters

$width :  Number/list

The border-width

$style :  String/list

The border-style

$color :  color/list

The border-color

border-side ( ...list... )
private pri

Convenience mixin for border-top, border-right, border-bottom, and border-left

Parameters

$side :  Object

border-top ( ...list... )
private pri

Creates a top border. If all arguments are non-null they will be collapsed into a single border property.

Parameters

$width :  Number/list

The border-width

$style :  String/list

The border-style

$color :  color/list

The border-color

color-by-background ( ...list... )

Colors the text of an element based on lightness of its background.

.my-element {
  @include color-by-background(#fff); // Colors text black.
}

.my-element {
  @include color-by-background(#fff, 40%); // Colors text gray.
}

Parameters

$bg-color :  color

Background color of element.

$contrast :  percent

Contrast of text color to its background.

font ( ...list... )
private pri

Adds a font specification to an element. Uses a single "font" property if possible, otherwise uses separate font-family, font-size, font-weight and line-height properties.

Parameters

$font-weight :  Number/String

The font-weight

$font-size :  Number/String

The font-size

$line-height :  Number/String

The line-height

$font-family :  String

The font-family

font-icon ( ...list... )
private pri

Applies a font icon to an element.

Parameters

$glyph :  list/String

A unicode character to use as the icon, or a list specifying the character to use followed by font-size, font-family, and degrees of rotation (90, 180, or 270). All parameters in the list are optional except for glyph. For example, each of the following is valid: Use the letter "A" as the icon, inherit the font-size from the parent element, and use the default font-family specified by Global_CSS#$font-icon-font-family. .my-icon { @include font-icon('\0041'); } Use the letter "A" as the icon with a font-size of 16px, and the default font-family .my-icon { @include font-icon('\0041' 16px); } Use the letter "A" as the icon, inherit font-size, and use FontAwesome as the font-family .my-icon { @include font-icon('\0041' FontAwesome); } Use the letter "A" as the icon, inherit font-size, use the default font-family, and rotate the icon 90 degrees clockwise. .my-icon { @include font-icon('\0041' 90); } Use the letter "A" as the icon with a 16px font-size, and a FontAwesome as the font-family. .my-icon { @include font-icon('\0041' 16px FontAwesome); } Use the letter "A" as the icon with a 16px font-size, default font-family, and rotate the icon 90 degrees clockwise. .my-icon { @include font-icon('\0041' 16px 90); } Use the letter "A" as the icon, inherit the font-size, use FontAwesome as the font-family, and rotate the icon 90 degrees clockwise. .my-icon { @include font-icon('\0041' FontAwesome 90); } Use the letter "A" as the icon with a font-size of 16px, use FontAwesome as the font-family, and rotate the icon 90 degrees clockwise. .my-icon { @include font-icon('\0041' 16px FontAwesome 90); } NOTE: Only numeric values with units are accepted for font-size, e.g. `16px` or `2em`.

$pseudo :  Boolean/String (optional)

By default this mixin generates a "before" pseudo element ruleset to contain the icon. Set this parameter to "after" to use an after pseudo element. Set to `false` if you are invoking the font-icon() mixin from within a pseudo element ruleset.

Defaults to: true

$line-height :  Number (optional)

Optional line-height to apply to the icon. Pass `null` to avoid setting line-height and inherit from parent element.

Defaults to: 1

$color :  color

Optional color for the glyph.

$style-pseudo :  Boolean (optional)

By default, font and color styles are placed on the icon-containing element, not the pseudo. This allows for easier customization of font-icons by users since many font-icon generators also place the font styles on the containing element. Set this to `true` to set font and color styles on the pseudo element instead. This is necessary in cases where the icon-containing element is not exclusively dedicated to containing the icon and may contain other text as well, for example, grid headers and grid grouping headers.

Defaults to: false

icon ( ...list... )
private pri

Generates style rules for an icon element

Parameters

$glyph :  list/String

A unicode character to use as the icon, or a list specifying the character to use followed by font-family and degrees of rotation (90, 180, or 270). All parameters in the list are optional except for glyph. For example, each of the following is valid: Use the letter "A" as the icon and use the default font-family @include font-icon('\0041'); Use the letter "A" as the icon and use FontAwesome as the font-family @include font-icon('\0041' FontAwesome); Use the letter "A" as the icon and rotate the icon 90 degrees clockwise. @include font-icon('\0041' 90); Use the letter "A" as the icon, use FontAwesome as the font-family, and rotate the icon 90 degrees clockwise. @include font-icon('\0041' FontAwesome 90);

$color :  color

$size :  Number

The size of the icon element

$size-big :  Number

The size of the icon element in the big sizing scheme

$font-size :  Number

The font-size of the icon. Applied to the :before pseudo element so that it does not affect `$size` when `$size` is specified in `em` units.

$font-size-big :  Number

The font-size of the icon in the big sizing scheme. Applied to the :before pseudo element so that it does not affect `$size-big` when `$size-big` is specified in `em` units.

insertion ( ...list... )

Adds basic styles to :before or :after pseudo-elements.

.my-element:after {
  @include insertion(50px, 50px);
}

Parameters

$width :  measurement

Height of pseudo-element.

$height :  measurement

Height of pseudo-element.

$top :  measurement

Top positioning of pseudo-element.

$left :  measurement

Left positioning of pseudo-element.

margin ( ...list... )
private pri

Creates a margin on an element. If any item in the list is null it will be excluded.

Parameters

$margin :  Number/list

The margin size.

$len :  Number

$top :  Number

Top margin

$right :  Number

Right margin

$bottom :  Number

Bottom margin

$left :  Number

Left margin

mask-by-background ( ...list... )

Creates a background gradient for masked elements, based on the lightness of their background.

Parameters

$bg-color :  color

Background color of element.

$percent :  percent

Contrast of the new gradient to its background.

$style :  percent

Gradient style of the gradient. See background-gradient mixin.

mask-by-background ( ...list... )

Creates a background gradient for masked elements, based on the lightness of their background.

Parameters

$bg-color :  color

Background color of element.

$percent :  percent

Contrast of the new gradient to its background.

$style :  percent

Gradient style of the gradient.

padding ( ...list... )
private pri

Creates a padding on an element. If any item in the list is null it will be excluded.

Parameters

$padding :  Number/list

The padding size.

$len :  Number

$top :  Number

Top padding

$right :  Number

Right padding

$bottom :  Number

Bottom padding

$left :  Number

Left padding

toolbar-button ( ...list... )

Includes the default styles for toolbar buttons, mostly used as a helper function.

Parameters

$bg-color :  color

Base color to be used for the button.

Ext JS 6.2.1 - Modern Toolkit