Sqwidget configuration

Sqwidget has global configuration options that apply to Sqwidget as a whole — that is, to all the widgets on the page where Sqwidget is loaded. These usually don’t need to be set but may be useful for advanced or strange situations.

Each widget template and widget itself has its own configuration separate to this. Use this for the global configuration of Sqwidget — which will mostly happen for development purposes or for special circumstances. You can do this from and page that has sqwidget.js loaded. When you load sqwidget.js, it provides the global sqwidget object, Sqwidget.

Setting global Sqwidget configuration

Sqwidget.globalConfig({
 ... configuration options ...
});

Getting Global Configuration

You can read the global configuration back into and object like this:

config = Sqwidget.globalConfig();

Global Configuration options

The following global config options are available:

Name	Type	Description	Default Value
development	Boolean	Set to true to turn on development options (see Developing Sqwidgets)	false
experimental	Boolean	Set to true to turn on experimantal (non-core) features (see Experimental Features	false
automatic	Boolean	Set to false to prevent Sqwidget from automatically finding, loading and starting all widgets in the page. Normally leave this on automatic, but set to false if you want to add your own Sqwidget.ready() function to load widgets (see Sqwidget.ready())	true
charset	String	Set to the default charset for widget template documents	'utf-8'
jQuery	Object	It’s complicated. See the source for sqwidget.js :-)	see source
basePath	String	The base path or relative path to sqwidget.js or an absolute URL (including http:// etc) for widget resources, like plugins, CSS and other external loads. This is overridden by the basePath setting in widget.config in templates.	’’ (empty string) (so that makes the basePath the same folder that the widget page where the embed code is.
pluginPath	String	Either an absolute URL for a path to the place plugins are kept, or a path relative to the baseURL. This is overridden by the pluginPath setting in widget.config in templates.	plugins/