aria-api 0.2.7 → 0.4.2

package/lib/constants.js

@@ -1,64 +1,57 @@
+// https://www.w3.org/TR/wai-aria/#state_prop_def
 exports.attributes = {
-	// widget
+	'activedescendant': 'id',
+	'atomic': 'bool',
 	'autocomplete': 'token',
+	'busy': 'bool',
 	'checked': 'tristate',
+	'colcount': 'int',
+	'colindex': 'int',
+	'colspan': 'int',
+	'controls': 'id-list',
 	'current': 'token',
+	'describedby': 'id-list',
+	'details': 'id',
 	'disabled': 'bool',
+	'dropeffect': 'token-list',
+	'errormessage': 'id',
 	'expanded': 'bool-undefined',
+	'flowto': 'id-list',
+	'grabbed': 'bool-undefined',
 	'haspopup': 'token',
-	'hidden': 'bool',  // !
+	'hidden': 'bool-undefined',
 	'invalid': 'token',
 	'keyshortcuts': 'string',
 	'label': 'string',
+	'labelledby': 'id-list',
 	'level': 'int',
+	'live': 'token',
 	'modal': 'bool',
 	'multiline': 'bool',
 	'multiselectable': 'bool',
 	'orientation': 'token',
+	'owns': 'id-list',
 	'placeholder': 'string',
+	'posinset': 'int',
 	'pressed': 'tristate',
 	'readonly': 'bool',
+	'relevant': 'token-list',
 	'required': 'bool',
 	'roledescription': 'string',
-	'selected': 'bool-undefined',
-	'valuemax': 'number',
-	'valuemin': 'number',
-	'valuenow': 'number',
-	'valuetext': 'string',
-
-	// live
-	'atomic': 'bool',
-	'busy': 'bool',
-	'live': 'token',
-	'relevant': 'token-list',
-
-	// dragndrop
-	'dropeffect': 'token-list',
-	'grabbed': 'bool-undefined',
-
-	// relationship
-	'activedescendant': 'id',
-	'colcount': 'int',
-	'colindex': 'int',
-	'colspan': 'int',
-	'controls': 'id-list',
-	'describedby': 'id-list',
-	'details': 'id',
-	'errormessage': 'id',
-	'flowto': 'id-list',
-	'labelledby': 'id-list',
-	'owns': 'id-list',
-	'posinset': 'int',
 	'rowcount': 'int',
 	'rowindex': 'int',
 	'rowspan': 'int',
+	'selected': 'bool-undefined',
 	'setsize': 'int',
 	'sort': 'token',
+	'valuemax': 'number',
+	'valuemin': 'number',
+	'valuenow': 'number',
+	'valuetext': 'string',
 };
 
 exports.attributeStrongMapping = {
 	'disabled': 'disabled',
-	'hidden': 'hidden',
 	'placeholder': 'placeholder',
 	'readonly': 'readOnly',
 	'required': 'required',
@@ -73,209 +66,452 @@ exports.attributeWeakMapping = {
 	'selected': 'selected',
 };
 
-// https://www.w3.org/TR/html-aria/#docconformance
-exports.extraSelectors = {
-	article: ['article'],
-	button: [
-		'button',
-		'input[type="button"]',
-		'input[type="image"]',
-		'input[type="reset"]',
-		'input[type="submit"]',
-		'summary',
-	],
-	cell: ['td'],
-	checkbox: ['input[type="checkbox"]'],
-	combobox: [
+// https://www.w3.org/TR/html-aam-1.0/#html-element-role-mappings
+// https://www.w3.org/TR/wai-aria/roles
+exports.roles = {
+	alert: {
+		childRoles: ['alertdialog'],
+		defaults: {
+			'live': 'assertive',
+			'atomic': true,
+		},
+	},
+	article: {
+		selectors: ['article'],
+	},
+	button: {
+		selectors: [
+			'button',
+			'input[type="button"]',
+			'input[type="image"]',
+			'input[type="reset"]',
+			'input[type="submit"]',
+			'summary',
+		],
+		nameFromContents: true,
+	},
+	cell: {
+		selectors: ['td'],
+		childRoles: ['gridcell', 'rowheader'],
+		nameFromContents: true,
+	},
+	checkbox: {
+		selectors: ['input[type="checkbox"]'],
+		childRoles: ['menuitemcheckbox', 'switch'],
+		nameFromContents: true,
+		defaults: {
+			'checked': 'false',
+		},
+	},
+	columnheader: {
+		selectors: ['th[scope="col"]'],
+		nameFromContents: true,
+	},
+	combobox: {
+		selectors: [
 		'input:not([type])[list]',
-		'input[type="email"][list]',
-		'input[type="search"][list]',
-		'input[type="tel"][list]',
-		'input[type="text"][list]',
-		'input[type="url"][list]',
-		'select:not([size]):not([multiple])',
-		'select[size="0"]:not([multiple])',
-		'select[size="1"]:not([multiple])',
-	],
-	complementary: ['aside'],
-	definition: ['dd'],
-	dialog: ['dialog'],
-	document: ['body'],
-	figure: ['figure'],
-	form: ['form[aria-label]', 'form[aria-labelledby]'],
-	group: ['details', 'optgroup'],
-	heading: ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'],
-	img: ['img:not([alt=""])', 'graphics-symbol'],
-	link: ['a[href]', 'area[href]', 'link[href]'],
-	list: ['dl', 'ol', 'ul'],
-	listbox: [
-		'select[multiple]',
-		'select[size]:not([size="0"]):not([size="1"])',
-	],
-	listitem: ['dt', 'ul > li', 'ol > li'],
-	main: ['main'],
-	math: ['math'],
-	menuitemcheckbox: ['menuitem[type="checkbox"]'],
-	menuitem: ['menuitem[type="command"]'],
-	menuitemradio: ['menuitem[type="radio"]'],
-	menu: ['menu[type="context"]'],
-	navigation: ['nav'],
-	option: ['option'],
-	progressbar: ['progress'],
-	radio: ['input[type="radio"]'],
-	region: ['section[aria-label]', 'section[aria-labelledby]', 'section[title]'],
-	rowgroup: ['tbody', 'thead', 'tfoot'],
-	row: ['tr'],
-	searchbox: ['input[type="search"]:not([list])'],
-	separator: ['hr'],
-	slider: ['input[type="range"]'],
-	spinbutton: ['input[type="number"]'],
-	status: ['output'],
-	table: ['table'],
-	term: ['dfn', 'dt'],
-	textbox: [
-		'input:not([type]):not([list])',
-		'input[type="email"]:not([list])',
-		'input[type="tel"]:not([list])',
-		'input[type="text"]:not([list])',
-		'input[type="url"]:not([list])',
-		'textarea',
-	],
-
-	// if scope is missing, it is calculated automatically
-	rowheader: ['th[scope="row"]'],
-	columnheader: ['th[scope="col"]'],
+			'input[type="email"][list]',
+			'input[type="search"][list]',
+			'input[type="tel"][list]',
+			'input[type="text"][list]',
+			'input[type="url"][list]',
+			'select:not([size]):not([multiple])',
+			'select[size="0"]:not([multiple])',
+			'select[size="1"]:not([multiple])',
+		],
+		defaults: {
+			'expanded': false,
+			'haspopup': 'listbox',
+		},
+	},
+	command: {
+		childRoles: ['button', 'link', 'menuitem'],
+	},
+	complementary: {
+		selectors: ['aside'],
+	},
+	composite: {
+		childRoles: ['grid', 'select', 'spinbutton', 'tablist'],
+	},
+	definition: {
+		selectors: ['dd'],
+	},
+	dialog: {
+		selectors: ['dialog'],
+		childRoles: ['alertdialog'],
+	},
+	'doc-backlink': {
+		nameFromContents: true,
+	},
+	'doc-biblioref': {
+		nameFromContents: true,
+	},
+	'doc-glossref': {
+		nameFromContents: true,
+	},
+	'doc-noteref': {
+		nameFromContents: true,
+	},
+	document: {
+		selectors: ['body'],
+		childRoles: ['article', 'graphics-document'],
+	},
+	figure: {
+		selectors: ['figure'],
+	},
+	form: {
+		selectors: ['form[aria-label]', 'form[aria-labelledby]', 'form[title]'],
+	},
+	grid: {
+		childRoles: ['treegrid'],
+	},
+	gridcell: {
+		childRoles: ['columnheader', 'rowheader'],
+		nameFromContents: true,
+	},
+	group: {
+		selectors: ['details', 'optgroup'],
+		childRoles: ['row', 'select', 'toolbar', 'graphics-object'],
+	},
+	heading: {
+		selectors: ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'],
+		nameFromContents: true,
+		defaults: {
+			'level': 2,
+		},
+	},
+	img: {
+		selectors: ['img:not([alt=""])', 'graphics-symbol'],
+		childRoles: ['doc-cover'],
+	},
+	input: {
+		childRoles: ['checkbox', 'option', 'radio', 'slider', 'spinbutton', 'textbox'],
+	},
+	landmark: {
+		childRoles: [
+			'banner',
+			'complementary',
+			'contentinfo',
+			'doc-acknowledgments',
+			'doc-afterword',
+			'doc-appendix',
+			'doc-bibliography',
+			'doc-chapter',
+			'doc-conclusion',
+			'doc-credits',
+			'doc-endnotes',
+			'doc-epilogue',
+			'doc-errata',
+			'doc-foreword',
+			'doc-glossary',
+			'doc-introduction',
+			'doc-part',
+			'doc-preface',
+			'doc-prologue',
+			'form',
+			'main',
+			'navigation',
+			'region',
+			'search',
+		],
+	},
+	link: {
+		selectors: ['a[href]', 'area[href]', 'link[href]'],
+		childRoles: ['doc-backlink', 'doc-biblioref', 'doc-glossref', 'doc-noteref'],
+		nameFromContents: true,
+	},
+	list: {
+		selectors: ['dl', 'ol', 'ul'],
+		childRoles: ['directory', 'feed'],
+	},
+	listbox: {
+		selectors: [
+			'select[multiple]',
+			'select[size]:not([size="0"]):not([size="1"])',
+		],
+		defaults: {
+			'orientation': 'vertical',
+		},
+	},
+	listitem: {
+		selectors: ['dt', 'ul > li', 'ol > li'],
+		childRoles: ['doc-biblioentry', 'doc-endnote', 'treeitem'],
+	},
+	log: {
+		defaults: {
+			'live': 'polite',
+		},
+	},
+	main: {
+		selectors: ['main'],
+	},
+	math: {
+		selectors: ['math'],
+	},
+	menu: {
+		selectors: ['menu[type="context"]'],
+		childRoles: ['menubar'],
+		defaults: {
+			'orientation': 'vertical',
+		},
+	},
+	menubar: {
+		defaults: {
+			'orientation': 'horizontal',
+		},
+	},
+	menuitem: {
+		selectors: ['menuitem[type="command"]'],
+		childRoles: ['menuitemcheckbox'],
+		nameFromContents: true,
+	},
+	menuitemcheckbox: {
+		selectors: ['menuitem[type="checkbox"]'],
+		childRoles: ['menuitemradio'],
+		nameFromContents: true,
+		defaults: {
+			'checked': 'false',
+		},
+	},
+	menuitemradio: {
+		selectors: ['menuitem[type="radio"]'],
+		nameFromContents: true,
+		defaults: {
+			'checked': 'false',
+		},
+	},
+	navigation: {
+		selectors: ['nav'],
+		childRoles: ['doc-index', 'doc-pagelist', 'doc-toc'],
+	},
+	note: {
+		childRoles: ['doc-notice', 'doc-tip'],
+	},
+	option: {
+		selectors: ['option'],
+		childRoles: ['treeitem'],
+		nameFromContents: true,
+		defaults: {
+			'selected': 'false',
+		},
+	},
+	progressbar: {
+		selectors: ['progress'],
+	},
+	radio: {
+		selectors: ['input[type="radio"]'],
+		childRoles: ['menuitemradio'],
+		nameFromContents: true,
+		defaults: {
+			'checked': 'false',
+		},
+	},
+	range: {
+		childRoles: ['progressbar', 'scrollbar', 'slider', 'spinbutton'],
+	},
+	region: {
+		selectors: ['section[aria-label]', 'section[aria-labelledby]', 'section[title]'],
+	},
+	roletype: {
+		childRoles: ['structure', 'widget', 'window'],
+	},
+	row: {
+		selectors: ['tr'],
+		nameFromContents: true,
+	},
+	rowgroup: {
+		selectors: ['tbody', 'thead', 'tfoot'],
+		nameFromContents: true,
+	},
+	rowheader: {
+		selectors: ['th[scope="row"]'],
+		nameFromContents: true,
+	},
+	scrollbar: {
+		defaults: {
+			'orientation': 'vertical',
+			'valuemin': 0,
+			'valuemax': 100,
+			// FIXME: halfway between actual valuemin and valuemax
+			'valuenow': 50,
+		},
+	},
+	searchbox: {
+		selectors: ['input[type="search"]:not([list])'],
+	},
+	section: {
+		childRoles: [
+			'alert',
+			'cell',
+			'definition',
+			'doc-abstract',
+			'doc-colophon',
+			'doc-credit',
+			'doc-dedication',
+			'doc-epigraph',
+			'doc-example',
+			'doc-footnote',
+			'doc-qna',
+			'figure',
+			'group',
+			'img',
+			'landmark',
+			'list',
+			'listitem',
+			'log',
+			'marquee',
+			'math',
+			'note',
+			'status',
+			'table',
+			'tabpanel',
+			'term',
+			'tooltip',
+		],
+	},
+	sectionhead: {
+		childRoles: [
+			'columnheader',
+			'doc-subtitle',
+			'heading',
+			'rowheader',
+			'tab',
+		],
+		nameFromContents: true,
+	},
+	select: {
+		childRoles: ['combobox', 'listbox', 'menu', 'radiogroup', 'tree'],
+	},
+	separator: {
+		// assume not focussable because <hr> is not
+		selectors: ['hr'],
+		childRoles: ['doc-pagebreak'],
+		defaults: {
+			'orientation': 'horizontal',
+		},
+	},
+	slider: {
+		selectors: ['input[type="range"]'],
+		defaults: {
+			'orientation': 'horizontal',
+			'valuemin': 0,
+			'valuemax': 100,
+			// FIXME: halfway between actual valuemin and valuemax
+			'valuenow': 50,
+		},
+	},
+	spinbutton: {
+		selectors: ['input[type="number"]'],
+		defaults: {
+			// FIXME: no valuemin/valuemax
+			'valuenow': 0,
+		},
+	},
+	status: {
+		selectors: ['output'],
+		childRoles: ['timer'],
+		defaults: {
+			'live': 'polite',
+			'atomic': true,
+		},
+	},
+	structure: {
+		childRoles: [
+			'application',
+			'document',
+			'none',
+			'presentation',
+			'rowgroup',
+			'section',
+			'sectionhead',
+			'separator',
+		],
+	},
+	switch: {
+		nameFromContents: true,
+		defaults: {
+			'checked': false,
+		},
+	},
+	tab: {
+		nameFromContents: true,
+		defaults: {
+			'selected': false,
+		},
+	},
+	table: {
+		selectors: ['table'],
+		childRoles: ['grid'],
+	},
+	tablist: {
+		defaults: {
+			'orientation': 'horizontal',
+		},
+	},
+	term: {
+		selectors: ['dfn', 'dt'],
+	},
+	textbox: {
+		selectors: [
+			'input:not([type]):not([list])',
+			'input[type="email"]:not([list])',
+			'input[type="tel"]:not([list])',
+			'input[type="text"]:not([list])',
+			'input[type="url"]:not([list])',
+			'textarea',
+		],
+		childRoles: ['searchbox'],
+	},
+	toolbar: {
+		defaults: {
+			'orientation': 'horizontal',
+		},
+	},
+	tooltip: {
+		nameFromContents: true,
+	},
+	tree: {
+		childRoles: ['treegrid'],
+		defaults: {
+			'orientation': 'vertical',
+		},
+	},
+	treeitem: {
+		nameFromContents: true,
+	},
+	widget: {
+		childRoles: [
+			'command',
+			'composite',
+			'gridcell',
+			'input',
+			'range',
+			'row',
+			'tab',
+		],
+	},
+	window: {
+		childRoles: ['dialog'],
+	},
 };
 
 exports.scoped = [
-	'article *', 'aside *', 'main *', 'nav *', 'section *',
+	'main *',
+	// https://www.w3.org/TR/html/dom.html#sectioning-content-2
+	'article *', 'aside *', 'nav *', 'section *',
+	// https://www.w3.org/TR/html/sections.html#sectioning-roots
+	'blockquote *', 'details *', 'dialog *', 'fieldset *', 'figure *', 'td *',
 ].join(',');
 
-// https://www.w3.org/TR/wai-aria/roles
-var subRoles = {
-	cell: ['gridcell', 'rowheader'],
-	command: ['button', 'link', 'menuitem'],
-	composite: ['grid', 'select', 'spinbutton', 'tablist'],
-	img: ['doc-cover'],
-	input: ['checkbox', 'option', 'radio', 'slider', 'spinbutton', 'textbox'],
-	landmark: [
-		'banner',
-		'complementary',
-		'contentinfo',
-		'doc-acknowledgments',
-		'doc-afterword',
-		'doc-appendix',
-		'doc-bibliography',
-		'doc-chapter',
-		'doc-conclusion',
-		'doc-credits',
-		'doc-endnotes',
-		'doc-epilogue',
-		'doc-errata',
-		'doc-foreword',
-		'doc-glossary',
-		'doc-introduction',
-		'doc-part',
-		'doc-preface',
-		'doc-prologue',
-		'form',
-		'main',
-		'navigation',
-		'region',
-		'search',
-	],
-	range: ['progressbar', 'scrollbar', 'slider', 'spinbutton'],
-	roletype: ['structure', 'widget', 'window'],
-	section: [
-		'alert',
-		'cell',
-		'definition',
-		'doc-abstract',
-		'doc-colophon',
-		'doc-credit',
-		'doc-dedication',
-		'doc-epigraph',
-		'doc-example',
-		'doc-footnote',
-		'doc-qna',
-		'figure',
-		'group',
-		'img',
-		'landmark',
-		'list',
-		'listitem',
-		'log',
-		'marquee',
-		'math',
-		'note',
-		'status',
-		'table',
-		'tabpanel',
-		'term',
-		'tooltip',
-	],
-	sectionhead: [
-		'columnheader',
-		'doc-subtitle',
-		'heading',
-		'rowheader',
-		'tab',
-	],
-	select: ['combobox', 'listbox', 'menu', 'radiogroup', 'tree'],
-	separator: ['doc-pagebreak'],
-	structure: [
-		'application',
-		'document',
-		'none',
-		'presentation',
-		'rowgroup',
-		'section',
-		'sectionhead',
-		'separator',
-	],
-	table: ['grid'],
-	textbox: ['searchbox'],
-	widget: [
-		'command',
-		'composite',
-		'gridcell',
-		'input',
-		'range',
-		'row',
-		'separator',
-		'tab',
-	],
-	window: ['dialog'],
-	alert: ['alertdialog'],
-	checkbox: ['menuitemcheckbox', 'switch'],
-	dialog: ['alertdialog'],
-	gridcell: ['columnheader', 'rowheader'],
-	menuitem: ['menuitemcheckbox'],
-	menuitemcheckbox: ['menuitemradio'],
-	option: ['treeitem'],
-	radio: ['menuitemradio'],
-	status: ['timer'],
-	grid: ['treegrid'],
-	menu: ['menubar'],
-	tree: ['treegrid'],
-	document: ['article', 'graphics-document'],
-	group: ['row', 'select', 'toolbar', 'graphics-object'],
-	link: ['doc-backlink', 'doc-biblioref', 'doc-glossref', 'doc-noteref'],
-	list: ['directory', 'feed'],
-	listitem: ['doc-biblioentry', 'doc-endnote', 'treeitem'],
-	navigation: ['doc-index', 'doc-pagelist', 'doc-toc'],
-	note: ['doc-notice', 'doc-tip'],
-};
-
 var getSubRoles = function(role) {
-	var children = subRoles[role] || [];
+	var children = (exports.roles[role] || {}).childRoles || [];
 	var descendents = children.map(getSubRoles);
 
 	var result = [role];
 
 	descendents.forEach(function(list) {
 		list.forEach(function(r) {
-			if (result.indexOf(r) === -1) {
+			if (!result.includes(r)) {
 				result.push(r);
 			}
 		});
@@ -284,38 +520,20 @@ var getSubRoles = function(role) {
 	return result;
 };
 
-exports.subRoles = {};
-for (var role in subRoles) {
-	exports.subRoles[role] = getSubRoles(role);
-}
-exports.subRoles['none'] = ['none', 'presentation'];
-exports.subRoles['presentation'] = ['presentation', 'none'];
+exports.attrsWithDefaults = [];
 
-exports.nameFromContents = [
-	'button',
-	'checkbox',
-	'columnheader',
-	'doc-backlink',
-	'doc-biblioref',
-	'doc-glossref',
-	'doc-noteref',
-	'gridcell',
-	'heading',
-	'link',
-	'menuitem',
-	'menuitemcheckbox',
-	'menuitemradio',
-	'option',
-	'radio',
-	'row',
-	'rowgroup',
-	'rowheader',
-	'sectionhead',
-	'tab',
-	'tooltip',
-	'treeitem',
-	'switch',
-];
+for (var role in exports.roles) {
+	exports.roles[role].subRoles = getSubRoles(role);
+	for (var key in exports.roles[role].defaults) {
+		if (!exports.attrsWithDefaults.includes(key)) {
+			exports.attrsWithDefaults.push(key);
+		}
+	}
+}
+exports.roles['none'] = exports.roles['none'] || {};
+exports.roles['none'].subRoles = ['none', 'presentation'];
+exports.roles['presentation'] = exports.roles['presentation'] || {};
+exports.roles['presentation'].subRoles = ['presentation', 'none'];
 
 exports.nameFromDescendant = {
 	'figure': 'figcaption',