urlConfig.md

layout	page-api
title	QUnit.config.urlConfig
excerpt	Register additional input fields in the toolbar (HTML Reporter).
groups	config extension
redirect_from	/config/urlConfig/
version_added	1.0.0

In the HTML Reporter, this array is used to generate additional input fields in the toolbar.

type	`array`
default	`[]`

This property controls which form controls to put into the QUnit toolbar. By default, the noglobals and notrycatch checkboxes are registered. By adding to this array, you can add your own checkboxes and select dropdowns.

Each array item should be an object shaped as follows:

({
  id: string,
  label: string,
  tooltip: string, // optional
  value: string | array | object // optional
});

• The id property is used as the key for storing the value under QUnit.config, and as URL query parameter.
• The label property is used as text label in the user interface.
• The optional tooltip property is used as the title attribute and should explain what the control is used for.

Each element should also have a value property controlling available options and rendering.

If value is undefined, the option will render as a checkbox. The corresponding URL parameter will be set to "true" when the checkbox is checked, and otherwise will be absent.

If value is a string, the option will render as a checkbox. The corresponding URL parameter will be set to the value when the checkbox is checked, and otherwise will be absent.

If value is an array, the option will render as a "select one" menu with an empty value as first default option, followed by one option for each item in the array. The corresponding URL parameter will be absent when the empty option is selected, and otherwise will be set to the value of the selected array item.

value = [ 'foobar', 'baz' ];

If value is an object, the option will render as a "select one" menu as for an array. The keys will be used as option values, and the values will be used as option display labels. The corresponding URL parameter will be absent when the empty option is selected, and otherwise will be set to the object key of the selected property.

value = {
  foobar: 'Foo with bar',
  baz: 'Baz'
};

Examples

Add toolbar checkbox

Add a new checkbox to the toolbar. You can then use the QUnit.config.min property in your code to implement a behaviour based on it.

QUnit.config.urlConfig.push({
  id: 'min',
  label: 'Minified source',
  tooltip: 'Load minified source files instead of the regular unminified ones.'
});

Add dropdown menu

Add a dropdown to the toolbar.

QUnit.config.urlConfig.push({
  id: 'jquery',
  label: 'jQuery version',
  value: [ '1.7.2', '1.8.3', '1.9.1' ],
  tooltip: 'Which jQuery version to test against.'
});