InputfieldAsmSelect class

Multiple selection, progressive enhancement to select multiple

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldAsmSelect class also inherits all the methods and properties of: InputfieldSelectMultiple, InputfieldSelect, Inputfield, WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
addItemTarget string Where to place new selected items in list: top or bottom (default='bottom') 
addable bool Can items be added to selection? (default=true) 
animate bool Animate the the adding/removing of items in the list? (default=false) 
debugMode bool Debug mode keeps original select visible (default=false) 
deletable bool Can items be removed from selection? (default=true) 
deletedOpacity float string Opacity of deleted item, set to 1.0 to disable opacity adjustment (applicable only if hideDeleted=true) 
deletedPrepend string Deleted item values are prepended with this character in the form submission (applicable only if hideDeleted=true) (default='-') 
editLabel string Text used in the "edit" link (if editLink is populated) 
editLink string Optional URL options can link to with tag {value} replaced by option value, i.e. /path/to/page/edit?id={$value} 
editLinkButtonSelector string Button selector for finding buttons that should become modal window buttons 
editLinkModal string bool Whether the edit link (if used) should be modal or "longclick" for longclick modal only (default=true) 
editLinkOnlySelected bool When true, edit link only appears for items that were already selected (default=true) 
fieldset bool Use fieldset support? (for PW Fieldset types) (default=false) 
getConfigInputfields()
InputfieldWrapperField config
hideDeleted bool Hide items when deleted. If false, items remain but are marked for deletion (default=true) 
hideWhenEmpty bool Hide the <select> when there are no items available to select? (default=false) 
highlight bool Use the highlight feature? (default=false) 
highlightAddedLabel string Text that precedes highlight of added item (default='Added: ') 
highlightRemovedLabel string Text that precedes highlight of removed item (default='Removed: ') 
removeLabel string Text used in the "remove" link 
render()
stringRender
renderReady()
boolCalled before render() 
set(string $key, mixed $value)
Inputfield InputfieldAsmSelect InputfieldSelectSet Inputfield property or AsmSelect option 
setAsmSelectOption(string $key, $value)
selfSet custom option for AsmSelect 
setAsmSelectOptions(array $options)
selfSet multiple custom options for AsmSelect 
sortLabel string Sortable handle/icon 
sortable bool Should the list be sortable? (default=true) 
usePageEdit int bool Use page editor links for selected Page items, when user has edit permission? (default=false) 

Additional methods and properties

In addition to the methods and properties above, InputfieldAsmSelect also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.244

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer