An overview of kimsQ RC, including how to download and use it, some basic templates and examples, and more.
Plugins can be included individually (using kimsQ RC’s individual
*.js files), or all at once using
kimsQ RC.js or the minified
kimsQ RC.min.js (don’t include both).
Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs. Also note that all plugins depend on jQuery (this means jQuery must be included before the plugin files). Consult our
bower.json to see which versions of jQuery are supported.
However, in some situations it may be desirable to disable this functionality. To disable the data attribute API, unbind all events on the document namespaced with
data-api like so:
Alternatively, to target a specific plugin, just include the plugin’s name as a namespace along with the data-api namespace like this:
All methods should accept an optional options object, a string which targets a particular method, or nothing (which initiates a plugin with default behavior):
Each plugin also exposes its raw constructor on a
$.fn.popover.Constructor. If you’d like to get a particular plugin instance, retrieve it directly from an element:
You can change the default settings for a plugin by modifying the plugin’s
Sometimes it is necessary to use kimsQ RC plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call
.noConflict on the plugin you wish to revert the value of.
kimsQ RC provides custom events for most plugins’ unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex.
show) is triggered at the start of an event, and its past participle form (ex.
shown) is triggered on the completion of an action.
All infinitive events provide
preventDefault() functionality. This provides the ability to stop the execution of an action before it starts.
The version of each of kimsQ RC’s jQuery plugins can be accessed via the
VERSION property of the plugin’s constructor. For example, for the tooltip plugin:
.noConflict and namespaced events, there may be compatibility problems that you need to fix on your own.
For simple transition effects, include
transition.js once alongside the other JS files. If you’re using the compiled (or minified)
kimsQ RC.js, there is no need to include this—it’s already there.
Transition.js is a basic helper for
transitionEnd events as well as a CSS transition emulator. It’s used by the other plugins to check for CSS transition support and to catch hanging transitions.