Properties Methods Events Direct Link

# Class Ext.QuickTips

Package: | Ext
Defined In: | QuickTips.js
Class: | QuickTips
Extends: | Object

Provides attractive and customizable tooltips for any element. The QuickTips singleton is used to configure and manage tooltips globally for multiple elements in a generic manner. To create individual tooltips with maximum customizability, you should consider either Ext.Tip or Ext.ToolTip.

Quicktips can be configured via tag attributes directly in markup, or by registering quick tips programmatically via the register method.

The singleton's instance of Ext.QuickTip is available via getQuickTip, and supports all the methods, and all the all the configuration properties of Ext.QuickTip. These settings will apply to all tooltips shown by the singleton.

Below is the summary of the configuration properties which can be used. For detailed descriptions see getQuickTip

QuickTips singleton configs (all are optional)

- dismissDelay
- hideDelay
- maxWidth
- minWidth
- showDelay
- trackMouse

Target element configs (optional unless otherwise noted)

- autoHide
- cls
- dismissDelay (overrides singleton value)
- target (required)
- text (required)
- title
- width

Here is an example showing how some of these config options could be used:

    // Init the singleton.  Any tag-based quick tips will start working.
    Ext.QuickTips.init();

    // Apply a set of config properties to the singleton
    Ext.apply(Ext.QuickTips.getQuickTip(), {
        maxWidth: 200,
        minWidth: 100,
        showDelay: 50,
        trackMouse: true
    });

    // Manually register a quick tip for a specific element
    Ext.QuickTips.register({
        target: 'my-div',
        title: 'My Tooltip',
        text: 'This tooltip was added in code',
        width: 100,
        dismissDelay: 20
    });

To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with the ext: namespace. The HTML element itself is automatically set as the quick tip target. Here is the summary of supported attributes (optional unless otherwise noted):

- hide: Specifying "user" is equivalent to setting autoHide = false. Any other value will be the same as autoHide = true.
- qclass: A CSS class to be applied to the quick tip (equivalent to the 'cls' target element config).
- qtip (required): The quick tip text (equivalent to the 'text' target element config).
- qtitle: The quick tip title (equivalent to the 'title' target element config).
- qwidth: The quick tip width (equivalent to the 'width' target element config).

Here is an example of configuring an HTML element to display a tooltip from markup:

    // Add a quick tip to an HTML button
    <input type="button" value="OK" ext:qtitle="OK Button" ext:qwidth="100"
         ext:qtip="This is a quick tip from markup!"></input>

This class is a singleton and cannot be created directly.

## Public Properties

This class has no public properties.

## Public Methods

Method | Defined By
--- | ---
| disable() : void Disable quick tips globally. Disable quick tips globally. Parameters: None. Returns: `void` | QuickTips
| enable() : void Enable quick tips globally. Enable quick tips globally. Parameters: None. Returns: `void` | QuickTips
| getQuickTip() : void Gets the global QuickTips instance. Gets the global QuickTips instance. Parameters: None. Returns: `void` | QuickTips
| init( `Boolean autoRender` ) : void Initialize the global QuickTips instance and prepare any quick tips. Initialize the global QuickTips instance and prepare any quick tips. Parameters: `autoRender` : Boolean True to render the QuickTips container immediately to preload images. (Defaults to true) Returns: `void` | QuickTips
| isEnabled() : Boolean Returns true if quick tips are enabled, else false. Returns true if quick tips are enabled, else false. Parameters: None. Returns: `Boolean` | QuickTips
| register( `Object config` ) : void Configures a new quick tip instance and assigns it to a target element. See Ext.QuickTip.register for details. Configures a new quick tip instance and assigns it to a target element. See Ext.QuickTip.register for details. Parameters: `config` : Object The config object Returns: `void` | QuickTips
| tips( `Object config` ) : void Alias of register. Alias of register. Parameters: `config` : Object The config object Returns: `void` | QuickTips
| unregister( `String/HTMLElement/Element el` ) : void Removes any registered quick tip from the target element and destroys it. Removes any registered quick tip from the target element and destroys it. Parameters: `el` : String/HTMLElement/Element The element from which the quick tip is to be removed. Returns: `void` | QuickTips

## Public Events

This class has no public events.