axe-core/typings/axe-core/axe-core-tests.js

Accessibility engine for automated Web UI testing

"use strict";
exports.__esModule = true;
var axe = require("../../axe");
var context = document;
var $fixture = {};
var options = { iframes: false, selectors: false, elementRef: false };
axe.run(context, {}, function (error, results) {
    if (error) {
        console.log(error);
    }
    console.log(results.passes.length);
    console.log(results.incomplete.length);
    console.log(results.inapplicable.length);
    console.log(results.violations.length);
    console.log(results.violations[0].nodes[0].failureSummary);
});
axe.run().then(function (done) {
    done();
});
// additional configuration options
axe.run(context, options, function (error, results) {
    console.log(error || results.passes.length);
});
// axe.run include/exclude
axe.run({ include: [['#id1'], ['#id2']] }, {}, function (error, results) {
    console.log(error || results);
});
axe.run({ exclude: [$fixture[0]] }, {}, function (error, results) {
    console.log(error || results);
});
// additional configuration options
axe.run(context, options, function (error, results) {
    console.log(error || results.passes.length);
});
var tagConfigRunOnly = {
    type: 'tag',
    values: ['wcag2a']
};
var tagConfig = {
    runOnly: tagConfigRunOnly
};
axe.run(context, tagConfig, function (error, results) {
    console.log(error || results);
});
axe.run(context, {
    runOnly: {
        type: 'tags',
        values: ['wcag2a', 'wcag2aa']
    }
}, function (error, results) {
    console.log(error || results);
});
axe.run(context, {
    runOnly: ['wcag2a', 'wcag2aa']
}, function (error, results) {
    console.log(error || results);
});
axe.run(context, {
    runOnly: ['color-contrast', 'heading-order']
}, function (error, results) {
    console.log(error || results);
});
var someRulesConfig = {
    rules: {
        'color-contrast': { enabled: false },
        'heading-order': { enabled: true }
    }
};
axe.run(context, someRulesConfig, function (error, results) {
    console.log(error || results);
});
// just context
axe.run(context).then(function (done) {
    done();
});
// just options
axe.run(options).then(function (done) {
    done();
});
// just callback
axe.run(function (error, results) {
    console.log(error || results);
});
// context and callback
axe.run(context, function (error, results) {
    console.log(error || results);
});
// options and callback
axe.run(options, function (error, results) {
    console.log(error || results);
});
// context and options
axe.run(context, options).then(function (done) {
    done();
});
// context, options, and callback
axe.run(context, options, function (error, results) {
    console.log(error || results);
});
// axe.configure
var spec = {
    branding: {
        brand: 'foo',
        application: 'bar'
    },
    reporter: 'v1',
    checks: [
        {
            id: 'custom-check',
            evaluate: function () {
                return true;
            }
        }
    ],
    standards: {
        ariaRoles: {
            'custom-role': {
                type: 'widget',
                requiredAttrs: ['aria-label']
            }
        },
        ariaAttrs: {
            'custom-attr': {
                type: 'boolean'
            }
        },
        htmlElms: {
            'custom-elm': {
                contentTypes: ['flow'],
                allowedRoles: false
            }
        },
        cssColors: {
            customColor: [0, 1, 2, 3]
        }
    },
    rules: [
        {
            id: 'custom-rule',
            any: ['custom-check']
        }
    ]
};
axe.configure(spec);
var source = axe.source;
var version = axe.version;
axe.reset();
axe.getRules(['wcag2aa']);
typeof axe.getRules() === 'object';
var rules = axe.getRules();
rules.forEach(function (rule) {
    rule.ruleId.substr(1234);
});
// Plugins
var pluginSrc = {
    id: 'doStuff',
    run: function (data, callback) {
        callback();
    },
    commands: [
        {
            id: 'run-doStuff',
            callback: function (data, callback) {
                axe.plugins['doStuff'].run(data, callback);
            }
        }
    ]
};
axe.registerPlugin(pluginSrc);
axe.cleanup();
axe.configure({
    locale: {
        checks: {
            foo: {
                fail: 'failure',
                pass: 'success',
                incomplete: {
                    foo: 'nar'
                }
            }
        }
    }
});
axe.configure({
    locale: {
        lang: 'foo',
        rules: {
            foo: {
                description: 'desc',
                help: 'help'
            }
        },
        checks: {
            foo: {
                pass: 'pass',
                fail: 'fail',
                incomplete: {
                    foo: 'bar'
                }
            }
        }
    }
});