QUnit.config.urlConfig

Categories: QUnit.config, Extension interface.

version added: 1.0.0.

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

type	`array`
default	`[]`

This property controls which form controls display in the QUnit toolbar. By default, the noglobals and notrycatch checkboxes are registered. By adding to this array, the HTML Reporter will add extra checkboxes and select dropdowns for your custom configuration.

Each array item should be an object shaped as follows:

QUnit.config.urlConfig.push({
  id: string,
  label: string,
  tooltip: string, // optional
  value: undefined | string | array | object // optional
});

The id property is used as URL query parameter name, and corresponding key under QUnit.urlParams.
The label property is used as text for the HTML label element in the user interface.
The optional tooltip property is used as the title attribute and should explain what you code will do with this option.

Each item may also have a value property:

If value is undefined, the item 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 item 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 item will render as a “select one” dropdown 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.

If value is an object, the item will render as a dropdown menu. The URL parameter will be set to the key of the selected property, and this will also be available via QUnit.urlParams[id]. The object values will be used as display label for each option in the dropdown menu. The corresponding URL parameter will be absent when the empty option is selected.

Examples

Add a new checkbox to the toolbar. You can then use the QUnit.urlParams.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 a dropdown to the toolbar.

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

QUnit.config.urlConfig.push({
  id: 'jquery',
  label: 'jQuery',
  value: { '1.7.2': 'v1.7.2 (LTS)', '1.8.3': 'v1.8.3 (Current)' },
  tooltip: 'Which version of jQuery to test against.'
});

if (QUnit.urlConfig.jquery) {
  // Load jQuery
}

Description

Examples

Add toolbar checkbox

Add dropdown menu