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.

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

### Member Types

- Config - The configuration options for a class.
- Property - Set once a class is instantiated. *See Read Only below.
- Method - Actions that can be performed by a class. Methods should be read as instance methods and can only be called from a instance of a given class. Static methods that can be called directly from the class itself will have a `static` label next to the method name. *See Static below.
- Event - Events are specific to the framework event system allowing for classes to programmatically raise an event to be handled by one or more event handler methods. DOM events, while handled by the framework event system, are not specifically described within the API documentation. *For DOM events refer to the event reference page from MDN.
- Theme Variable - Variables used by the visual theme engine employed by the framework.
- Theme Mixin - Functions used by the visual theme engine employed by the framework and may use values set in various Theme Variables.

### 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).

Ext.container.Container
view source
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:

- Expand/Collapse - On the left-hand size of the member row is a control used to expand and collapse each member row to show / hide member details.
- Member Name - The name of the class member (`lookupComponent` in this example)
- Method Param - Any required or optional params used by a method (or passed to an event handler method) will be listed next to the method name within parenthesis (`( item )` in this example)
- Return type - The class instance or javascript object returned by the method or property (`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`).
- Flags - Any flags applicable to the member will be displayed next (`PROTECTED` in this example - see the Flags section below)
- Member Origin - On the right-hand side of the member row is the class where the member was initially described (`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.
- Member Source - On the right-hand side below the member origin class is a link to view the member's source (`view source` in the example)
- Params List - Each param for a class method will be listed using the same name found above in parenthesis, the type of class or object expected, and a description of the param (`item : Object` in the example).
- Returns - If a class returns a value other than `undefined` a "Returns" section will note the type of class or object returned and a description (`Ext.Component` in the example)
- Since (not shown in the example) - Some members will show which version of the product the member was first introduced (i.e. `Available since 3.4.0` - not pictured in the example) just after the member description
- Default (not shown in the example) - Configs often show the default config value to be applied to a class instance if not overridden (i.e. `Defaults to: false`)

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

- Required - Required config when instantiating a class
- Bindable - The config has a setter which allows this config to be set via ViewModel binding
- Read Only - The property may be read, but cannot be used to configure / re-configure a class instance at runtime
- Singleton - Singleton classes are instantiated immediately once defined and may not be instantiated manually
- Static - A static method or property is a method or property belonging to the class itself, not an instance of the class
- Chainable - Refers to methods that return the class instance back when called.
  This enables chained method calls like: `classInstance.method1().method2().etc();`
- Deprecated - A class or member that is scheduled for removal in a future framework version and is provided in the current version for backwards compatibility.
  Deprecated classes and members will have a message directing you to the preferred class / method going forward.
- Removed - A removed class or member that exists in documentation only as a reference for users upgrading between framework versions
- Template - A method defined within a base class designed to be overridden by subclasses
- Abstract - A class or member may be be defined as abstract. Abstract classes and members establish a class structure and provide limited, if any, code. Class-specific code will be furnished via overrides in subclasses.
- Preventable - Events marked preventable will not fire if `false` is returned from an event handler

### 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

## Navigation and Features

### 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 and inheritance. This is done using the checkboxes at the top of the page. Note that filtering out `private` members also filters the API class navigation tree.

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:

- Alternate Name - One or more additional class name synonymns (in Ext JS 6.0.0 the `Ext.button.Button` class has an alternate class name of `Ext.Button`). Alternate class names are commonly maintained for backward compatibility.
- Hierarchy - The hierararchy view lists the inheritance chain of the current class up through its ancestor classes up to the root base class.
- Mixins - A list of classes that are mixed into the current class
- Inherited Mixins - A list of classes that are mixed into an ancestor of the current class
- Requires - All classes required to be defined for the class to be instantiated
- Uses - A list of classes potentially used by the class at some point in its lifecycle, but not necessarily requried for the class to initially be instantiated
- Subclasses - Classes that extend the current class

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

- Global navigation will be located in a menu on the left-hand side accessible via the hamburger menu icon. The menu houses the following (on most pages):
  - The name of the current product (as a link to the product landing page)
  - The Sencha icon used to navigate back to the documentation home page
  - The product menu drop-down button
  - Tabs of navigation trees for the API docs and guides
- Current context navigation and tools is located on the right-hand side accessible via the gear icon. The context menu houses teh following:
  - The global search input field
  - (API doc) A "Filters" tab with the member filter, expand / collapse all examples button, expand / collapse all member rows button, the access level filter checkboxes, and the counts of each member
  - (API doc) A "Related Classes" tab containing the menu of metadata related to the current class
  - (Guides) The table of contents for the guide

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

Sample Login App
Classic Toolkit

##
Ext JS 6.2.0 - Modern Toolkit

Guides
API
▸ Ext
▸ app
▸ bind
▸ AbstractStub
▸ BaseBinding
▸ Binding
▸ Formula
▸ LinkStub
▸ Multi
▸ Parser
▸ RootStub
▸ Stub
▸ Template
▸ TemplateBinding
▸ domain
▸ Component
▸ Controller
▸ Direct
▸ Global
▸ Store
▸ View
▸ route
▸ Queue
▸ Route
▸ Router
▸ Application
▸ BaseController
▸ Controller
▸ EventBus
▸ EventDomain
▸ Profile
▸ Util
▸ ViewController
▸ ViewModel
▸ behavior
▸ Behavior
▸ Draggable
▸ Translatable
▸ calendar
▸ date
▸ Range
▸ Util
▸ dd
▸ DaysAllDaySource
▸ DaysAllDayTarget
▸ DaysBodySource
▸ DaysBodyTarget
▸ DaysProxy
▸ WeeksProxy
▸ WeeksSource
▸ WeeksTarget
▸ form
▸ AbstractForm
▸ Add
▸ Base
▸ CalendarPicker
▸ Edit
▸ Form
▸ header
▸ Base
▸ Days
▸ Weeks
▸ model
▸ Calendar
▸ CalendarBase
▸ Event
▸ EventBase
▸ panel
▸ AbstractBase
▸ AbstractPanel
▸ Base
▸ Day
▸ Days
▸ Month
▸ Panel
▸ Week
▸ Weeks
▸ store
▸ Calendars
▸ Events
▸ EventSource
▸ theme
▸ Palette
▸ Theme
▸ util
▸ Dom
▸ view
▸ Base
▸ Day
▸ Days
▸ DaysRenderer
▸ Month
▸ Multi
▸ Week
▸ Weeks
▸ WeeksRenderer
▸ AbstractList
▸ Event
▸ EventBase
▸ List
▸ carousel
▸ Carousel
▸ Indicator
▸ Infinite
▸ Item
▸ chart
▸ axis
▸ layout
▸ CombineDuplicate
▸ Continuous
▸ Discrete
▸ Layout
▸ segmenter
▸ Names
▸ Numeric
▸ Segmenter
▸ Time
▸ sprite
▸ Axis
▸ Axis3D
▸ Axis
▸ Axis3D
▸ Category
▸ Category3D
▸ Numeric
▸ Numeric3D
▸ Time
▸ Time3D
▸ grid
▸ CircularGrid
▸ HorizontalGrid
▸ HorizontalGrid3D
▸ RadialGrid
▸ VerticalGrid
▸ VerticalGrid3D
▸ interactions
▸ Abstract
▸ Crosshair
▸ CrossZoom
▸ ItemEdit
▸ ItemHighlight
▸ ItemInfo
▸ PanZoom
▸ Rotate
▸ RotatePie3D
▸ label
▸ Callout
▸ legend
▸ sprite
▸ Border
▸ Item
▸ store
▸ Item
▸ Store
▸ Legend
▸ LegendBase
▸ SpriteLegend
▸ plugin
▸ ItemEvents
▸ series
▸ sprite
▸ Aggregative
▸ Area
▸ Bar
▸ Bar3D
▸ Box
▸ CandleStick
▸ Cartesian
▸ Line
▸ Pie3DPart
▸ PieSlice
▸ Polar
▸ Radar
▸ Scatter
▸ Series
▸ StackedCartesian
▸ Area
▸ Bar
▸ Bar3D
▸ CandleStick
▸ Cartesian
▸ Gauge
▸ Line
▸ Pie
▸ Pie3D
▸ Polar
▸ Radar
▸ Scatter
▸ Series
▸ StackedCartesian
▸ sprite
▸ Label
▸ theme
▸ Base
▸ Default
▸ AbstractChart
▸ CartesianChart
▸ MarkerHolder
▸ Markers
▸ PolarChart
▸ SpaceFillingChart
▸ d3
▸ axis
▸ Axis
▸ Color
▸ Data
▸ canvas
▸ Canvas
▸ HiDPI
▸ hierarchy
▸ partition
▸ Icicle
▸ Partition
▸ Sunburst
▸ tree
▸ HorizontalTree
▸ Tree
▸ Hierarchy
▸ Pack
▸ Partition
▸ Tree
▸ TreeMap
▸ interaction
▸ Abstract
▸ PanZoom
▸ legend
▸ Color
▸ Legend
▸ mixin
▸ Detached
▸ ToolTip
▸ svg
▸ Svg
▸ Component
▸ HeatMap
▸ Helpers
▸ data
▸ amf
▸ Encoder
▸ Packet
▸ Proxy
▸ Reader
▸ RemotingMessage
▸ XmlDecoder
▸ XmlEncoder
▸ field
▸ Boolean
▸ Date
▸ Field
▸ Integer
▸ Number
▸ String
▸ flash
▸ BinaryXhr
▸ identifier
▸ Generator
▸ Negative
▸ Sequential
▸ Uuid
▸ matrix
▸ Matrix
▸ Side
▸ Slice
▸ operation
▸ Create
▸ Destroy
▸ Operation
▸ Read
▸ Update
▸ proxy
▸ Ajax
▸ Client
▸ Direct
▸ JsonP
▸ LocalStorage
▸ Memory
▸ Proxy
▸ Rest
▸ Server
▸ SessionStorage
▸ WebStorage
▸ reader
▸ Array
▸ Json
▸ Reader
▸ Xml
▸ request
▸ Ajax
▸ Base
▸ Form
▸ schema
▸ Association
▸ HasMany
▸ HasOne
▸ ManyToMany
▸ ManyToOne
▸ Namer
▸ OneToOne
▸ Reference
▸ Role
▸ Schema
▸ session
▸ BatchVisitor
▸ ChangesVisitor
▸ ChildChangesVisitor
▸ soap
▸ Proxy
▸ Reader
▸ validator
▸ Bound
▸ Email
▸ Exclusion
▸ Format
▸ Inclusion
▸ Length
▸ List
▸ Presence
▸ Range
▸ Validator
▸ writer
▸ Json
▸ Writer
▸ Xml
▸ AbstractStore
▸ ArrayStore
▸ Batch
▸ BufferedStore
▸ ChainedStore
▸ Connection
▸ DirectStore
▸ Error
▸ ErrorCollection
▸ JsonP
▸ JsonPStore
▸ JsonStore
▸ LocalStore
▸ Model
▸ ModelManager
▸ NodeInterface
▸ NodeStore
▸ PageMap
▸ ProxyStore
▸ Request
▸ ResultSet
▸ Session
▸ SortTypes
▸ Store
▸ StoreManager
▸ TreeModel
▸ TreeStore
▸ Types
▸ Validation
▸ XmlStore
▸ dataview
▸ component
▸ Container
▸ DataItem
▸ element
▸ Container
▸ List
▸ plugin
▸ ItemTip
▸ DataView
▸ IndexBar
▸ ItemHeader
▸ List
▸ ListItem
▸ ListItemBody
▸ ListItemDisclosure
▸ NestedList
▸ SimpleListItem
▸ direct
▸ AmfRemotingProvider
▸ Event
▸ ExceptionEvent
▸ JsonProvider
▸ Manager
▸ PollingProvider
▸ Provider
▸ RemotingEvent
▸ RemotingMethod
▸ RemotingProvider
▸ Transaction
▸ dom
▸ CompositeElement
▸ CompositeElementLite
▸ Element
▸ ElementEvent
▸ Fly
▸ GarbageCollector
▸ Helper
▸ Query
▸ Shadow
▸ Shim
▸ TouchAction
▸ Underlay
▸ UnderlayPool
▸ drag
▸ proxy
▸ None
▸ Original
▸ Placeholder
▸ Constraint
▸ Info
▸ Item
▸ Manager
▸ Source
▸ Target
▸ draw
▸ engine
▸ SvgContext
▸ Gradient
▸ Canvas
▸ excanvas
▸ Svg
▸ gradient
▸ Gradient
▸ GradientDefinition
▸ Linear
▸ Radial
▸ modifier
▸ Animation
▸ Highlight
▸ Modifier
▸ Target
▸ overrides
▸ hittest
▸ sprite
▸ Instancing
▸ Path
▸ Path
▸ Surface
▸ plugin
▸ SpriteEvents
▸ sprite
▸ AnimationParser
▸ Arc
▸ Arrow
▸ AttributeDefinition
▸ AttributeParser
▸ Circle
▸ Composite
▸ Cross
▸ Diamond
▸ Ellipse
▸ EllipticalArc
▸ Image
▸ Instancing
▸ Line
▸ Path
▸ Plus
▸ Rect
▸ Sector
▸ Sprite
▸ Square
▸ Text
▸ Tick
▸ Triangle
▸ Animator
▸ Container
▸ Draw
▸ LimitedCache
▸ Matrix
▸ Path
▸ PathUtil
▸ Point
▸ SegmentTree
▸ Surface
▸ SurfaceBase
▸ TextMeasurer
▸ TimingFunctions
▸ env
▸ Browser
▸ OS
▸ Ready
▸ event
▸ gesture
▸ DoubleTap
▸ Drag
▸ EdgeSwipe
▸ LongPress
▸ MultiTouch
▸ Pinch
▸ Recognizer
▸ Rotate
▸ SingleTouch
▸ Swipe
▸ Tap
▸ publisher
▸ Dom
▸ ElementPaint
▸ ElementSize
▸ Focus
▸ Gesture
▸ Publisher
▸ Event
▸ exporter
▸ data
▸ Base
▸ Cell
▸ Column
▸ Group
▸ Row
▸ Table
▸ excel
▸ Xlsx
▸ Xml
▸ file
▸ excel
▸ Cell
▸ Column
▸ Row
▸ Style
▸ Table
▸ Workbook
▸ Worksheet
▸ html
▸ Doc
▸ Style
▸ ooxml
▸ excel
▸ Border
▸ BorderPr
▸ Cell
▸ CellAlignment
▸ CellStyleXf
▸ CellXf
▸ Column
▸ Fill
▸ Font
▸ NumberFormat
▸ Row
▸ SharedStrings
▸ Sheet
▸ Stylesheet
▸ Workbook
▸ Worksheet
▸ Base
▸ ContentType
▸ ContentTypes
▸ CoreProperties
▸ Excel
▸ Relationship
▸ Relationships
▸ zip
▸ Archive
▸ File
▸ Folder
▸ Base
▸ Style
▸ text
▸ CSV
▸ Html
▸ TSV
▸ Base
▸ File
▸ Plugin
▸ field
▸ trigger
▸ Clear
▸ Date
▸ Expand
▸ Reveal
▸ Search
▸ SpinDown
▸ SpinUp
▸ Trigger
▸ Checkbox
▸ DatePicker
▸ DatePickerNative
▸ Email
▸ Field
▸ File
▸ FileInput
▸ Hidden
▸ Input
▸ Number
▸ Password
▸ Picker
▸ Radio
▸ Search
▸ Select
▸ SingleSlider
▸ Slider
▸ Spinner
▸ Text
▸ TextArea
▸ TextAreaInput
▸ TextInput
▸ Toggle
▸ Url
▸ form
▸ FieldContainer
▸ FieldSet
▸ Panel
▸ fx
▸ animation
▸ Abstract
▸ Cube
▸ Fade
▸ FadeOut
▸ Flip
▸ Pop
▸ PopOut
▸ Slide
▸ SlideOut
▸ Wipe
▸ WipeOut
▸ easing
▸ Abstract
▸ Bounce
▸ BoundMomentum
▸ EaseIn
▸ EaseOut
▸ Easing
▸ Linear
▸ Momentum
▸ layout
▸ card
▸ Abstract
▸ Cover
▸ Cube
▸ Fade
▸ Flip
▸ Pop
▸ Reveal
▸ Scroll
▸ ScrollCover
▸ ScrollReveal
▸ Slide
▸ Style
▸ Card
▸ runner
▸ Css
▸ CssAnimation
▸ CssTransition
▸ Animation
▸ Runner
▸ State
▸ google
▸ data
▸ AbstractProxy
▸ CalendarsProxy
▸ EventsProxy
▸ ux
▸ Client
▸ grid
▸ cell
▸ Base
▸ Boolean
▸ Cell
▸ Check
▸ Date
▸ Expander
▸ Number
▸ RowNumberer
▸ Summary
▸ Text
▸ Tree
▸ Widget
▸ column
▸ Boolean
▸ Check
▸ Column
▸ Date
▸ Number
▸ RowNumberer
▸ Selection
▸ Tree
▸ plugin
▸ ColumnResizing
▸ Editable
▸ Exporter
▸ MultiSelection
▸ PagingToolbar
▸ RowExpander
▸ SummaryRow
▸ ViewOptions
▸ Grid
▸ HeaderContainer
▸ HeaderGroup
▸ PagingToolbar
▸ Row
▸ RowBody
▸ RowHeader
▸ Tree
▸ layout
▸ wrapper
▸ BoxDock
▸ Dock
▸ Inner
▸ Abstract
▸ Box
▸ Card
▸ Default
▸ Fit
▸ FlexBox
▸ Float
▸ HBox
▸ VBox
▸ list
▸ AbstractTreeItem
▸ RootTreeItem
▸ Tree
▸ TreeItem
▸ mixin
▸ Accessible
▸ Bindable
▸ ComponentDelegation
▸ ConfigState
▸ Container
▸ Dirty
▸ Factoryable
▸ Hookable
▸ Identifiable
▸ Inheritable
▸ Keyboard
▸ Mashup
▸ Observable
▸ Pluggable
▸ Progressable
▸ Queryable
▸ Responsive
▸ Selectable
▸ StyleCacher
▸ Templatable
▸ Traversable
▸ panel
▸ Header
▸ Title
▸ Tool
▸ parse
▸ symbol
▸ Constant
▸ Infix
▸ InfixRight
▸ Paren
▸ Prefix
▸ Parser
▸ Symbol
▸ Tokenizer
▸ perf
▸ Accumulator
▸ Monitor
▸ picker
▸ Date
▸ Picker
▸ Slot
▸ pivot
▸ axis
▸ Base
▸ Item
▸ Local
▸ cell
▸ Cell
▸ Group
▸ dimension
▸ Item
▸ feature
▸ PivotStore
▸ filter
▸ Base
▸ Label
▸ Value
▸ matrix
▸ Base
▸ Local
▸ Remote
▸ plugin
▸ configurator
▸ model
▸ Select
▸ store
▸ Select
▸ Column
▸ Container
▸ DragZone
▸ DropZone
▸ Field
▸ FieldSettings
▸ Form
▸ FormController
▸ Panel
▸ PanelController
▸ rangeeditor
▸ Panel
▸ PanelController
▸ Configurator
▸ DrillDown
▸ Exporter
▸ RangeEditor
▸ result
▸ Base
▸ Collection
▸ Local
▸ update
▸ Base
▸ Increment
▸ Overwrite
▸ Percentage
▸ Uniform
▸ Aggregators
▸ Grid
▸ MixedCollection
▸ Row
▸ plugin
▸ field
▸ PlaceHolderLabel
▸ Abstract
▸ LazyItems
▸ ListPaging
▸ MouseEnter
▸ PullRefresh
▸ Responsive
▸ SortableList
▸ promise
▸ Consequence
▸ Deferred
▸ Promise
▸ scroll
▸ Scroller
▸ slider
▸ Slider
▸ Thumb
▸ Toggle
▸ sparkline
▸ Bar
▸ BarBase
▸ Base
▸ Box
▸ Bullet
▸ CanvasBase
▸ CanvasCanvas
▸ Discrete
▸ Line
▸ Pie
▸ RangeMap
▸ Shape
▸ TriState
▸ VmlCanvas
▸ tab
▸ Bar
▸ Panel
▸ Tab
▸ table
▸ Table
▸ tip
▸ Manager
▸ Tip
▸ ToolTip
▸ util
▸ paintmonitor
▸ Abstract
▸ CssAnimation
▸ OverflowChange
▸ sizemonitor
▸ Abstract
▸ OverflowChange
▸ Scroll
▸ TaskRunner
▸ Task
▸ translatable
▸ Abstract
▸ CssPosition
▸ CssTransform
▸ Dom
▸ ScrollParent
▸ ScrollPosition
▸ AbstractMixedCollection
▸ Audio
▸ Bag
▸ Base64
▸ BufferedCollection
▸ Cache
▸ Collection
▸ CollectionKey
▸ Color
▸ CSS
▸ CSV
▸ DelayedTask
▸ DelimitedValue
▸ Draggable
▸ Droppable
▸ Event
▸ Filter
▸ FilterCollection
▸ Fly
▸ Format
▸ Geolocation
▸ Group
▸ GroupCollection
▸ Grouper
▸ HashMap
▸ History
▸ Inflector
▸ InputBlocker
▸ ItemCollection
▸ LineSegment
▸ LocalStorage
▸ LruCache
▸ MixedCollection
▸ ObjectTemplate
▸ Observable
▸ Offset
▸ Operators
▸ PaintMonitor
▸ Point
▸ Positionable
▸ PositionMap
▸ Region
▸ Schedulable
▸ Scheduler
▸ SizeMonitor
▸ Sortable
▸ Sorter
▸ SorterCollection
▸ TapRepeater
▸ TaskManager
▸ TextMetrics
▸ Translatable
▸ TranslatableGroup
▸ TranslatableList
▸ TSV
▸ Wrapper
▸ XTemplateCompiler
▸ XTemplateParser
▸ ux
▸ ajax
▸ DataSimlet
▸ JsonSimlet
▸ PivotSimlet
▸ Simlet
▸ SimManager
▸ SimXhr
▸ XmlSimlet
▸ event
▸ Driver
▸ Maker
▸ Player
▸ Recorder
▸ google
▸ Api
▸ Feeds
▸ Gauge
▸ viewport
▸ Android
▸ Default
▸ Ios
▸ Viewport
▸ WindowsPhone
▸ AbstractComponent
▸ AbstractManager
▸ ActionSheet
▸ Ajax
▸ Anim
▸ AnimationQueue
▸ anims
▸ Array
▸ Assert
▸ Audio
▸ Base
▸ browser
▸ Button
▸ Class
▸ ClassManager
▸ Component
▸ ComponentManager
▸ ComponentQuery
▸ Config
▸ Configurator
▸ Container
▸ Date
▸ Decorator
▸ Deferred
▸ Error
▸ Evented
▸ Factory
▸ feature
▸ Function
▸ GlobalEvents
▸ Glyph
▸ Img
▸ Inventory
▸ JSON
▸ Label
▸ Loader
▸ LoadMask
▸ Mask
▸ Media
▸ MessageBox
▸ Mixin
▸ Msg
▸ Number
▸ Object
▸ os
▸ Panel
▸ Progress
▸ ProgressBase
▸ Promise
▸ SegmentedButton
▸ Sheet
▸ Sortable
▸ Spacer
▸ String
▸ supports
▸ TaskQueue
▸ Template
▸ Title
▸ Titlebar
▸ TitleBar
▸ Toast
▸ Toolbar
▸ Version
▸ Video
▸ Viewport
▸ Widget
▸ XTemplate
▸ Array
▸ Boolean
▸ CanvasRenderingContext2D
▸ CanvasRenderingContext2D_
▸ Date
▸ Function
▸ Global_CSS
▸ Number
▸ Object
▸ RegExp
▸ String
▸ Getting Started
▸ Setup & Getting Started
▸ Ext JS - FAQ
▸ Sample Login App
▸ API Diffs
▸ Modern - 6.0.2 and 6.2.0
▸ Classic - 6.0.2 and 6.2.0
▸ Examples
▸ 6.2.0 Examples
▸ What's New?
▸ Release Notes
▸ Core Concepts
▸ The Class System
▸ Layouts and Containers
▸ Components
▸ Data Package
▸ Events and Gestures
▸ Drag and Drop
▸ Theming System
▸ Material Theme
▸ Memory Management
▸ Draw Package
▸ Draw Package
▸ Creating Images - Pt 1
▸ Creating Images - Pt 2
▸ Creating Images - Pt 3
▸ Accessibility
▸ Localization
▸ Right to Left in Ext JS
▸ Sencha Font Packages
▸ Tablet Support
▸ Architecture
▸ Intro to App Architecture
▸ Multiple Screens
▸ View Controllers
▸ View Models & Binding
▸ View Model Internals
▸ Using the Router
▸ UI Components
▸ Carousel
▸ Forms
▸ Introduction to Charting
▸ Trees
▸ Grids
▸ Pivot Grid
▸ Widgets and Widget Cols
▸ Backend Connectors
▸ SOAP Services
▸ AMF Data Sources
▸ Ext Direct
▸ Ext Direct Specification
▸ Using MySQL and PHP
▸ Other Resources
▸ Basics of OOP
▸ Ext JS Ecosystem
▸ From the Sencha Blog
▸ Supported Browsers
top

# Building a Login System

One of the most frequently requested tutorials is how to make a login system. We're going to start off this ongoing tutorial by building just that. Please note that this is only one way of creating a login system. There are many other viable options. This is simply meant to show you an approach to creating an application with login/logout functionality. For this guide we'll be building the sample login app with the classic toolkit in Ext JS 6.

Note: Ext JS 6 gives you the option to create applications using the classic toolkit, the modern toolkit, or both (within a "universal application). This guide focuses specifically on the classic toolkit. That said, the application structure will be the same for an application using the modern toolkit, so you shouldn't have any trouble following along if you translate the view components appropriately. Universal applications house their views within `classic` and `modern` directories in the app root folder. If you're following this guide and have created a universal app, your views will be located in the `{appRoot}/classic/view/` instead of `{appRoot}/app/view/`.

Disclaimer: This tutorial is meant to show users one way in which they can design an application to contain a "logged in" and "logged out" view. This tutorial does not attempt to achieve secure data connections, session management, true authentication, etc. It is for educational purposes only.

## Step 1 - Generate your Application

The first thing we want to do is generate an application using Sencha Cmd. You can do so by issuing the following command from your command line interface, or CLI:

Sample Code

    sencha -sdk /path/to/ExtSDK generate app -classic TutorialApp ./TutorialApp

Note: For completeness, the following statement would generate a modern app:

Sample Code

    sencha -sdk /path/to/ExtSDK generate app -modern TutorialApp ./TutorialApp

and the following would generate a universal app:

Sample Code

    sencha -sdk /path/to/ExtSDK generate app TutorialApp ./TutorialApp

Note: If you do not have Sencha Cmd, or are unfamiliar with using it, please read the Cmd Introduction guide before proceeding.

The resulting TutorialApp is a fully functional Cmd generated application that we will use as a foundation for our login/logout application. You can view this application by navigating to the application's location on your webserver. For instance:

Sample Code

    http://localhost/TutorialApp

Or by starting "sencha app watch" from within the newly generated TutorialApp folder. This will spin up a Jetty server, which removes the need for a traditional web server. If you use "sencha app watch", you can find the application here:

Sample Code

    http://localhost:1841/

## Step 2 - Create the Login View Components

Next, we're going to navigate to our newly generated TutorialApp. Drill down into your generated application's "app/view/" folder. You should see the default generated "main" folder. This folder contains the Main.js, MainController.js, and MainModel.js files.

Let's go ahead and prepare our project for the login functionality by creating a new app/view folder called "login". After creating the "app/view/login/" folder, add the following files to said folder:

Sample Code

    - Login.js
    - LoginController.js

The resulting file structure should look like this:

## Step 3 - Disable mainView

The mainView config of application is a very handy way to automatically load and instantiate "TutorialApp.view.main.Main" by utilizing the Viewport Plugin. However, we have some evaluations to perform in Ext.application's launch method prior to picking our initial view. For instance, we do not want to create the Main view if the user is not yet logged in.

For the purposes of this exercise, let's remove the `mainView` config from the application config in "{appRoot}/app.js".

Note: Since we have removed `mainView`, refreshing your application will result in a blank page as no classes are being instantiated.

## Step 4 - Create the Login Window

Next, let's create a login view. To do this, we'll open our blank "{appRoot}/app/view/login/Login.js" file and begin defining the Login Window.

First, let's define our Class and extend the base Window class. That looks like so:

Sample Code

    Ext.define('TutorialApp.view.login.Login', {
        extend: 'Ext.window.Window',
        xtype: 'login'
    });

Now, we've defined our Login class as an extension of Ext.window.Window, which can be instantiated using the xtype `login`. Let's start giving our class some unique properties. We'll start by adding some additional configurations to the window itself.

Sample Code

    Ext.define('TutorialApp.view.login.Login', {
        extend: 'Ext.window.Window',
        xtype: 'login',

        requires: [
            'TutorialApp.view.login.LoginController',
            'Ext.form.Panel'
        ],

        controller: 'login',
        bodyPadding: 10,
        title: 'Login Window',
        closable: false,
        autoShow: true
    });

Let's walk through what these configurations mean.

### requires

The requires block makes sure that we're including any classes that may be relied upon before instantiating our Login window. We need to include `LoginController.js` because we're about to designate it as our controller on the next line. We also need to include Ext.form.Panel since our view contains a Form panel.

### controller

The controller config designates a ViewController, which will then be attached to instances of the Login window. This controller provides a place to include all logic relating to the Login window or its child components. Here, we designate controller to be `login`, which will be our controller's alias.

### bodyPadding

The bodyPadding config is purely aesthetic. This config applies "10px" of padding around the exterior of the window's body content.

### title

The string passed to the title config results in the creation of a header and adds the string value as its title.

### closable

closable determines whether or not the window can be closed. Windows have a closable button by default. However, since this is a login window, we don't want the user closing it. If they DID close it, they would be left with a blank page.

### autoShow

Windows are hidden by default. Setting autoShow to `true` will show the Window once it's created. The alternative would be call the Window's show method programmatically when we want the Window to be visible.

Now that we've discussed the Window's configuration, let's give it some child components. Since this will be a login form, we'll create a Form panel as a child of the Window. Then we'll add two textfields, a Display field, and a submit Button.

The final code for this file should appear as follows:

Sample Code

    Ext.define('TutorialApp.view.login.Login', {
        extend: 'Ext.window.Window',
        xtype: 'login',

        requires: [
            'TutorialApp.view.login.LoginController',
            'Ext.form.Panel'
        ],

        controller: 'login',
        bodyPadding: 10,
        title: 'Login Window',
        closable: false,
        autoShow: true,

        items: {
            xtype: 'form',
            reference: 'form',
            items: [{
                xtype: 'textfield',
                name: 'username',
                fieldLabel: 'Username',
                allowBlank: false
            }, {
                xtype: 'textfield',
                name: 'password',
                inputType: 'password',
                fieldLabel: 'Password',
                allowBlank: false
            }, {
                xtype: 'displayfield',
                hideEmptyLabel: false,
                value: 'Enter any non-blank password'
            }],
            buttons: [{
                text: 'Login',
                formBind: true,
                listeners: {
                    click: 'onLoginClick'
                }
            }]
        }
    });

Let's discuss these additions.

### Window items

The first configuration we've added to the Login window is the items config. In containers, like the Form panel and the Login window itself, the `items` config may hold a Component or a Component configuration object. The `items` config may also be an array of Components or Component config objects. These Components will be displayed in the Container's body using the Container's layout.

### xtype

Every Component class has it's own xtype. You can think of an `xtype` as a shortcut to easily create an instance of a Component. In this case, we have configured the Login window with a child item with an `xtype` of "form" ("form" being the `xtype` of the Ext.form.Panel class). Form panels are special types of Panels that include convenient configuration options for working with input fields.

### Form Items

Next, you'll see the familiar face of another `items` array. Here we're nesting additional items by using the items array a level deeper. We're placing more Components inside of the parent component, which is the Form panel. In this case, our nested Components are the form fields that make up the login form.

We can walk quickly through this array of components as they're pretty self explanatory. The first item has an `xtype` of [[ext: Ext.form.field.Text textfield]], a name of "username", a fieldLabel of "username", and allowBlank of "false". This boils down to a textfield with a name value and a field label. The field cannot be left blank and pass validation (see "formBind" below).

The next field is almost identical aside from the type being set to "password". This turns your input into `*` for security's sake.

The last member of this `items` array is a displayfield. A Display field is a text field that is not submitted with your form. It's useful for conveying data without the user interacting with said data. In this case, we're notifying the user that any non-blank password will allow the form to be submitted.

### buttons

The last bit that we've added here is a buttons array. This is a convenience config used for adding Buttons to a footer Toolbar in your panel. This particular button will contain the text 'Login' and will be what users will click to submit the login form.

### formBind

Our Button contains a config called formBind, which is set to "true". When a Component has `formBind` set to "true", it will be disabled/enabled depending on the validity state of the Form. This means that the Button will not be clickable until the two input fields contain values.

### listeners

The listeners object is configured with events and the methods / functions that will respond to the firing of those events. In this case, we're waiting for someone to click the Button. Upon a click, we "forward" the event to a method called `onLoginClick`. The `onLoginClick` method will later be defined in our Login controller.

Note: We have not yet instantiated the Login view in any way, so refreshing the application will not show any changes.

## Step 5 - Add Login Logic

Next, let's create the Login controller, which is a class that contains any logic used to handle user interactions with the Login view. To do this, we'll open our blank `{appRoot}/app/view/login/LoginController.js` file and begin defining our Login window's logic.

The entirety of `LoginController.js` is as follows:

Sample Code

    Ext.define('TutorialApp.view.login.LoginController', {
        extend: 'Ext.app.ViewController',
        alias: 'controller.login',

        onLoginClick: function() {

            // This would be the ideal location to verify the user's credentials via
            // a server-side lookup. We'll just move forward for the sake of this example.

            // Set the localStorage value to true
            localStorage.setItem("TutorialLoggedIn", true);

            // Remove Login Window
            this.getView().destroy();

            // Add the main view to the viewport
            Ext.create({
                xtype: 'app-main'
            });

        }
    });

The above code may be a little out of context, but it will make more sense when we discuss the `launch` method in the next section. This class contains the `onLoginClick` method that is called by clicking on the login button.

These bits of code have annotations to describe each statement's purpose, but let's look at them piece by piece for further explanation.

### onLoginClick()

First of all, we're creating a method called `onLoginClick`. This is the method to which we directed our login button's click event in the Login view.

As mentioned in the comments, this is where you'd call your server to verify that the user's credentials are valid. This would generally come in the form of an AJAX or REST request. However, for this tutorial, we will accept any non-blank input. Upon success, you'd follow through with the rest of the code. On failure, you would allow the user to re-enter their credentials. Of course, there's no failure possibility in this case, so let's move forward!

### localStorage

We are utilizing localStorage in this tutorial to maintain user login state. After a successful credentials check, we can determine that the user has the appropriate access to the Main application view. We can then set a key/value pair in localStorage to let the application know that the user is valid. Next, we will check that the `TutorialLoggedIn` localStorage key is set to "true" in our initial `launch` method (covered in more detail in the "launch" section below).

### getView()

ViewControllers introduce a very helpful method called getView(). The `getView()` method returns the current view associated with the ViewController from which it is called. In this case, the view is the Login window. Since we're treating the login click as a successful login, we no longer want to present the Login window. So, we are using `this.getView().destroy()` to get a reference to the Login window and then destroy it.

### Ext.create({ xtype: 'app-main' })

Now that we've destroyed the Login window, we want to change the view to display the Main view. In this case, we use `Ext.create({ xtype: 'app-main' })` to instantiate the "{appRoot}/app/view/main/Main.js" view.

Note: `'app-main'` refers to the xtype that is defined on our Sencha Cmd generated "TutorialApp.view.main.Main" class located in "{appRoot}/app/view/main.Main.js".

## Step 6 - Add Launch Logic to Application.js

Next, let's discuss "{appRoot}/app/Application.js" and the `launch` function.

"Application.js" is the heart of your application. You can find "Application.js" at the same level as your "view", "store", and "model" folders. It provides a handy method called `launch`, which fires when your application has loaded all of its required classes. Here is the full code for this tutorial's "Application.js" file.

Sample Code

    Ext.define('TutorialApp.Application', {
        extend: 'Ext.app.Application',

        name: 'TutorialApp',

        stores: [
            // TODO: add global / shared stores here
        ],

        views: [
            'TutorialApp.view.login.Login',
            'TutorialApp.view.main.Main'
        ],
        launch: function () {

            // It's important to note that this type of application could use
            // any type of storage, i.e., Cookies, LocalStorage, etc.
            var loggedIn;

            // Check to see the current value of the localStorage key
            loggedIn = localStorage.getItem("TutorialLoggedIn");

            // This ternary operator determines the value of the TutorialLoggedIn key.
            // If TutorialLoggedIn isn't true, we display the login window,
            // otherwise, we display the main view
            Ext.create({
                xtype: loggedIn ? 'app-main' : 'login'
            });

        },

        onAppUpdate: function () {
            Ext.Msg.confirm('Application Update', 'This application has an update, reload?',
                function (choice) {
                    if (choice === 'yes') {
                        window.location.reload();
                    }
                }
            );
        }
    });

Let's examine what these pieces are doing.

### requires

We've already described what requires does, but let's touch on this particular array. For the purposes of "Application.js", we need to prepare the application to load either the Login or Main view, depending on the results of the logged in evaluation to come. To that end, we must require both "TutorialApp.view.main.Main" and "TutorialApp.view.login.Login" so that either result is available.

### launch

As previously mentioned, the `launch` method is a function that executes when your application has loaded everything it needs to run. This is an ideal place to perform logic regarding user state for a login/logout application.

### localStorage.getItem()

Tthe next step is to check for a previously set localStorage key called `TutorialLoggedIn`. We are simply setting the loggedIn variable to the result of that key's value. If it doesn't exist, loggedIn will be null. If it does exist, we've previously set `TutorialLoggedIn` to be true in our LoginController's logic.

### Create Ternary

Most programming languages contain a form of conditional shorthand called ternary operators. Ternary operators allow you to minimize the amount of code required for a traditional if/else statement. In this case, we're using a ternary to say, "if loggedIn exists (isn't null), let's load the Main view, otherwise, load the Login view". We are then using the `Ext.create` method to instantiate the result of the ternary operator.

## Step 7 - Add Viewport Plugin / Logout Button

As you may remember, we removed the `mainView` config from "{appRoot}/app.js" early on in this tutorial. Since we don't have a Viewport defined, your Main view will not know where to render. We are going to change that by mixing in the viewport plugin so that "{appRoot}/app/view/main/Main.js" will operate as our application's viewport. This way, the Main view takes up all available width and height within the browser. It's as simple as adding the following line to "{appRoot}/app/view/main/Main.js":

Sample Code

    plugins: 'viewport',

We should also add a Logout button to the application's main navigation view. We'll add it to the Main Tab panel's header so that it's accessible from any tab in the application. Our logout button will handle `click` events using the `onClickButton` method we'll configure in the next section.

Our resulting `{appRoot}/app/view/main/Main.js` file will look like this:

Sample Code

    Ext.define('TutorialApp.view.main.Main', {
        extend: 'Ext.tab.Panel',
        xtype: 'app-main',

        requires: [
            'Ext.plugin.Viewport',
            'Ext.window.MessageBox',

            'TutorialApp.view.main.MainController',
            'TutorialApp.view.main.MainModel',
            'TutorialApp.view.main.List'
        ],

        controller: 'main',
        viewModel: 'main',
        plugins: 'viewport',

        ui: 'navigation',

        tabBarHeaderPosition: 1,
        titleRotation: 0,
        tabRotation: 0,

        header: {
            layout: {
                align: 'stretchmax'
            },
            title: {
                bind: {
                    text: '{name}'
                },
                flex: 0
            },
            iconCls: 'fa-th-list',
            items: [{
                xtype: 'button',
                text: 'Logout',
                margin: '10 0',
                handler: 'onClickButton'
            }]
        },

        tabBar: {
            flex: 1,
            layout: {
                align: 'stretch',
                overflowHandler: 'none'
            }
        },

        responsiveConfig: {
            tall: {
                headerPosition: 'top'
            },
            wide: {
                headerPosition: 'left'
            }
        },

        defaults: {
            bodyPadding: 20,
            tabConfig: {
                plugins: 'responsive',
                responsiveConfig: {
                    wide: {
                        iconAlign: 'left',
                        textAlign: 'left'
                    },
                    tall: {
                        iconAlign: 'top',
                        textAlign: 'center',
                        width: 120
                    }
                }
            }
        },

        items: [{
            title: 'Home',
            iconCls: 'fa-home',
            // The following grid shares a store with the classic version's grid as well!
            items: [{
                xtype: 'mainlist'
            }]
        }, {
            title: 'Users',
            iconCls: 'fa-user',
            bind: {
                html: '{loremIpsum}'
            }
        }, {
            title: 'Groups',
            iconCls: 'fa-users',
            bind: {
                html: '{loremIpsum}'
            }
        }, {
            title: 'Settings',
            iconCls: 'fa-cog',
            bind: {
                html: '{loremIpsum}'
            }
        }]
    });

## Step 8 - Add Main Logic

We're almost finished! All that's left now is to give the user some way to logout of the application, which will destroy the `TutorialLoggedIn` key from localStorage. This logic should take place in the "{appRoot}/app/view/main/MainController.js" file. We will add the `onClickButton` method to the ViewController to handle the logout operation.
This is the final definition of "MainController.js" for this tutorial:

Sample Code

    Ext.define('TutorialApp.view.main.MainController', {
        extend: 'Ext.app.ViewController',

        alias: 'controller.main',

        onItemSelected: function (sender, record) {
            Ext.Msg.confirm('Confirm', 'Are you sure?', 'onConfirm', this);
        },

        onConfirm: function (choice) {
            if (choice === 'yes') {
                //
            }
        },

        onClickButton: function () {
            // Remove the localStorage key/value
            localStorage.removeItem('TutorialLoggedIn');

            // Remove Main View
            this.getView().destroy();

            // Add the Login Window
            Ext.create({
                xtype: 'login'
            });
        }
    });

We shouldn't need to go into much depth here since it is basically the inverse of our `{appRoot}/app/view/login/LoginController.js` code.

To summarize this functionality, `onClickButton` is the function that is called by the button handler in our generated "{appMain}/app/view/main/Main.js" view. Once the `click` event is detected, the following steps are taken:

- Remove the localStorage key that maintains the user's logged in state.

- Destroy the current view, which is TutorialApp.view.main.Main.

- Recreate the login view.

You should now be able to load your application in your browser and see a fully functioning login/logout application.

## Wrap Up

We hope that you have enjoyed this tutorial. This is simply the foundation for an application, but hopefully we have introduced a few concepts that make your future projects simpler. Please feel free to suggest ideas for future tutorials via our forums. Also, feel free to follow up with questions via the support portal or forums.

## Ext JS 6.2.0 - Modern Toolkit

## Ext JS

### 6.x

6.2.0 EA (classic) (modern)
6.0.2 (classic) (modern)
6.0.1 (classic) (modern)
6.0.0 (classic) (modern)

### 5.x

5.1.3 5.1.2 5.1.1 5.1.0 5.0.1 5.0.0

### 4.x

4.2.5 4.1.3 4.0.7

### 3.x

3.4.0

## Sencha Test

Sencha Test

## Cmd

Cmd

## GXT

4.x 3.x

## IDE Plugins

IDE Plugins

## Sencha Inspector

Sencha Inspector

## Architect

Architect 3 Architect 4 EA

## Touch

### 2.x

Touch 2.4 Touch 2.3 Touch 2.2 Touch 2.0

## Web Application Manager

Web Application Manager
Current Product / Version
All
Show product details in the history bar