File: search.return.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 (30 lines) | stat: -rw-r--r-- 1,194 bytes parent folder | download
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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-option group="option">
	<name>search.return</name>
	<summary>Enable / disable DataTables' search on return</summary>
	<since>1.11</since>

	<type type="boolean" />
	<default value="false" />

	<description>
		This initialisation option allows the number of searches to be reduced. When this option is set to `true`, searches will only occur when the return key is pressed and focus is on the searchbox. This is particularly useful when working with large datasets or server-side processing. The default value for this option is `false` meaning that a search will occur on every keypress when the searchbox is focussed.
	</description>

	<example title="Enable search on return"><![CDATA[
$('#example').dataTable( {
  "search": {
    "return": true
  }
} );
]]></example>

	<related type="option">search</related>
	<related type="option">searchCols</related>
	<related type="option">search</related>
	<related type="option">search.search</related>
	<related type="option">search.caseInsensitive</related>
	<related type="option">search.regex</related>
	<related type="option">search.smart</related>
	<related type="api">search()</related>
</dt-option>