File: ve.ui.MWAriaDescribe.js

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (55 lines) | stat: -rw-r--r-- 1,363 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/**
 * Mixin for adding descriptive ARIA support to elements.
 *
 * @class
 * @abstract
 *
 * @constructor
 * @param {Object} [config] Configuration options
 * @param {jQuery} [config.$ariaDescribedBy]
 * @param {string} [config.ariaLabel]
 * @param {jQuery} [config.$describedElement]
 */
ve.ui.MWAriaDescribe = function VeUiMWAriaDescribe( config ) {
	this.$describedElement = config.$describedElement || this.$element;

	if ( config.$ariaDescribedBy ) {
		this.setAriaDescribedBy( config.$ariaDescribedBy );
	}

	if ( config.ariaLabel ) {
		this.setAriaLabel( config.ariaLabel );
	}
};

/* Setup */

OO.initClass( ve.ui.MWAriaDescribe );

/**
 * @param {jQuery} [$description]
 * @chainable
 * @return {OO.ui.Element} The element, for chaining
 */
ve.ui.MWAriaDescribe.prototype.setAriaDescribedBy = function ( $description ) {
	if ( !$description ) {
		this.$describedElement.removeAttr( 'aria-describedby' );
		return this;
	}

	if ( !$description.attr( 'id' ) ) {
		$description.attr( 'id', OO.ui.generateElementId() );
	}
	this.$describedElement.attr( 'aria-describedby', $description.attr( 'id' ) );
	return this;
};

/**
 * @param {string} label
 * @chainable
 * @return {OO.ui.Element} The element, for chaining
 */
ve.ui.MWAriaDescribe.prototype.setAriaLabel = function ( label ) {
	this.$describedElement.attr( 'aria-label', label );
	return this;
};