File: language.aria.paginate.xml

package info (click to toggle)
datatables.js 1.11.5%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 22,848 kB
  • sloc: javascript: 65,075; xml: 10,712; php: 4,741; sh: 544; makefile: 18
file content (42 lines) | stat: -rw-r--r-- 1,515 bytes parent folder | download | duplicates (6)
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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-option group="i18n">
	<name>language.aria.paginate</name>
	<summary>WAI-ARIA labels for pagination buttons</summary>
	<since>1.10.10</since>

	<type type="object" />

	<description>
		This object contains the properties that can be used for the ARIA label attributes that are applied to the pagination controls in DataTables. This can be useful when you use the `dt-init language.paginate` options to alter the default pagination button text to show icons rather than text, as the ARIA label attributes ensure that accessibility will still be retained.

		Please note that as the DataTables `dt-init language.paginate` options contain plain text, there is no need for ARIA label attributes, thus this object does not contain any default strings.
	</description>

	<example title="Define full paging language options as icons with ARIA label text"><![CDATA[
$('#example').DataTable( {
	pagingType: 'full',
	language: {
		paginate: {
			first:    '«',
			previous: '‹',
			next:     '›',
			last:     '»'
		},
		aria: {
			paginate: {
				first:    'First',
				previous: 'Previous',
				next:     'Next',
				last:     'Last'
			}
		}
	}
} );
]]></example>

	<related type="option">language</related>
	<related type="option">language.aria.paginate.next</related>
	<related type="option">language.aria.paginate.previous</related>
	<related type="option">language.aria.paginate.first</related>
	<related type="option">language.aria.paginate.last</related>
</dt-option>