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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
Global CSS variables and mixins.
Color used for elements like selected rows and certain overlays like the picker mask.
Defaults to:
darken(saturate($base-color, 55%), 10%)
Color used for elements like selected rows, "action" UIs (eg. on buttons) and certain overlays like the picker mask.
Color used for elements like badges, errors, and "decline" UIs (eg. on buttons).
Defaults to:
red
The primary gradient variable from which most elements derive their color scheme.
See background-gradient mixin.
Defaults to:
if($include-highlights, matte, null)
The primary color variable from which most elements derive their color scheme.
Defaults to:
#808080
The primary color variable from which most elements derive their color scheme.
Defaults to:
#157fcc
A slightly lightened shade of the base color
Defaults to:
mix(#fff, $base-color, 15%)
Optionally remove CSS3 effects from the slider component for improved performance.
Defaults to:
false
Color used for elements like success messages, and "confirm" UIs (eg. on buttons).
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
True to add font-smoothing styles to all components
Defaults to:
true
The font-family to be used throughout the theme.
See background-gradient mixin.
Defaults to:
helvetica, arial, sans-serif
The font-family to use for font icons throughout the theme.
Defaults to:
FontAwesome
The base font-size to be used throughout the theme in the big sizing scheme
Defaults to:
93.75%
The "bold" font-weight to be used throughout the theme.
Defaults to:
bold
The "normal" font-weight to be used throughout the theme.
Defaults to:
normal
default file extension to use for images (defaults to 'png').
Defaults to:
'png'
Optionally disable all border-radius. Useful for CSS debugging, non-performant browsers, or minimalist designs.
Decides whether or not to include the default UIs for all components.
Defaults to:
true
Decides whether or not to include the default UIs for all components.
Defaults to:
true
Decides if default HTML styles are included (for components with styleHtmlContent: true). Class is applied to .x-html.
Defaults to:
true
$include-highlights=true Optionally disable all gradients, text-shadows, and box-shadows. Useful for CSS debugging, non-performant browsers, or minimalist designs.
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
True to include files which are not found when compiling your SASS
Defaults to:
true
Background-color for the bars in the loading spinner.
Defaults to:
#aaa
Background-color for the bars in the loading spinner.
Defaults to:
#aaa
Base neutral color from which neutral colors throughout the theme are derived
Defaults to:
#e1e1e1
A dark shade of the neutral color
Defaults to:
mix(#000, $neutral-color, 22%)
A light shade of the neutral color
Defaults to:
mix(#fff, $neutral-color, 50%)
A light shade of the neutral color
Defaults to:
mix(#fff, $neutral-color, 68%)
A medium-dark shade of the neutral color
Defaults to:
mix(#000, $neutral-color, 14%)
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
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:
''
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));
$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.
Adds a small box shadow (or highlight) to give the impression of being beveled.
$type : String
Either shadow or highlight, decides whether to apply a light shadow or dark.
Bevels the text based on its background.
$bg-color : color
Background color of element.
See bevel-text.
Adds a small text shadow (or highlight) to give the impression of beveled text.
$type : String
Either shadow or highlight, decides whether to apply a light shadow or dark.
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.
$width : Number/list
The border-width
$style : String/list
The border-style
$color : color/list
The border-color
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.
}
$bg-color : color
Background color of element.
$contrast : percent
Contrast of text color to its background.
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.
$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
Applies a font icon to an element.
$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
Adds basic styles to :before or :after pseudo-elements.
.my-element:after {
@include insertion(50px, 50px);
}
$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.
Creates a background gradient for masked elements, based on the lightness of their background.
$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.
Creates a background gradient for masked elements, based on the lightness of their background.
$bg-color : color
Background color of element.
$percent : percent
Contrast of the new gradient to its background.
$style : percent
Gradient style of the gradient.
Ext JS | Terms of Use