InputfieldPageAutocomplete class
This Inputfield connects the jQuery UI Autocomplete widget with the ProcessWire ProcessPageSearch AJAX API.
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Inputfield
class also inherits all the methods and properties of: Inputfield, WireData and Wire.
Common
Name | Return | Summary | |
---|---|---|---|
Inputfield Inputfield Inputfield | None | Provide configuration options for modifying the behavior when paired with InputfieldPage | |
Inputfield Inputfield Inputfield | $this | Convert the CSV string provided in the $input to an array of ints needed for this fieldtype | |
Inputfield Inputfield Inputfield | None | Render the autocompletion widget |
Properties
Name | Return | Summary | Default |
---|---|---|---|
Inputfield | bool | Allow any value to stay in the input, even if not selectable? | false |
Inputfield | string | Autocomplete won't be triggered if input contains any of the characters in this string. | blank |
Inputfield | string | Optional selector to use for finding pages | blank |
Inputfield | string | Format string to display in the results, overrides labelFieldName when used . | blank |
Inputfield | string | Field to display in the results. | title |
Inputfield | int | Force use of this language ID for results | 0 |
Inputfield | int | Maximum number of items that may be selected (0=unlimited) . | 0 |
Inputfield | string | Selector operator to use in performing the search | %= |
Inputfield | int | Limit results to this parent ID, or if combined with findPagesSelector, the search is performed as $pages->get($parent_id)->find() rather than $pages->find(). | 0 |
Inputfield | string | Field(s) to search for text. Separate multiple by a space. | title |
Inputfield | int | Limit results to pages using this template ID. | 0 |
Inputfield | array | Limit results to pages using these template IDs (alternate to the single template_id). | [] |
Inputfield | bool | When true, each word will be isolated to a separate searchFields=searchValue, which enables it to duplicate ~= operator behavior while using a %= operator . | false |
Inputfield | bool | Whether or not to use a separate selected list. If false specified, selected item will be populated directly to the input. | true |
Additional methods and properties
In addition to the methods and properties above, Inputfield
API reference based on ProcessWire core version 3.0.251