-
filterBy
String: Filter list items by the given string. Applies a class of ui-hidden to all list items that do not contain the filter string.
Array: an array of strings to filter the list items by.
Note: during filtering a jQuery data value is set against each list item called filter-score that can be accessed during sorting which can be useful during filterMode: "loose" filtering to order list items by relevance.
-
filterMode
String: Possible values are 'loose' and 'strict'. In strict mode, a list item must match all filter strings in a filter array to remain displayed. In loose mode, the list item must only contain a single filter term to remain shown.
-
filterTransform
String: A regular expression that matches text to be removed from both the filter text and each list item before they are checked for a match. By default this removes anything that isn't a letter or a number and a few other symbols, but most symbols like colons or question marks will be removed.
-
groupBy
String: A jQuery selector whose text is used to generate and determine a group for each row.
-
hideList
Array: An array of jQuery selectors that match elements that should be hidden within rows. This is useful if the list has been grouped and it is unnecessary to display the group label on each row. It is also useful where you may give users the option to configure the list items to only show certain fields within a dataset.
-
persistentGroups
Array: A list of group headings that should be generated when grouping, regardless of whether any list items actually belong within any of the specified groups. Useful if you want to make it explicit that a certain group has no members.
-
sortBy
String: A jQuery selector whose matching element's text is used to sort the list alphabetically.
Function: A function that that is passed the each list element and returns a sort value.
Object: An object describing a sort. Options are sortValue (selector/Function) and reverse (true/false)
Array: An array of String selectors, functions and/or objects to use for composite sorting.
Note: when using a function or an object with a function, if the value is $.type === 'number' then a numeric sort function will be used.
-
upgroupableItemGroup
String: The label given to a group that is created if the groupBy selector does not provide a suitable group name for a list item.