appendTo
Type:
Selector
Default:
null
Which element the menu should be appended to. When the value is
null
, the parents of the input field will be checked for a class of
ui-front
. If an element with the
ui-front
class is found, the menu will be appended to that element. Regardless of the value, if no element is found, the menu will be appended to the body.
Note:
The
appendTo
option should not be changed while the suggestions menu is open.
Specify additional classes to add to the widget's elements. Any of classes specified in the
Theming section
can be used as keys to override their value. To learn more about this option, check out the
learn article about the
classes
option
.
Initialize the autocomplete with the
classes
option specified, changing the theming for the
ui-autocomplete
class:
Default:
300
The delay in milliseconds between when a keystroke occurs and when a search is performed. A zero-delay makes sense for local data (more responsive), but can produce a lot of load for remote data, while being less responsive.
Code examples:
Initialize the autocomplete with the
delay
option specified:
Default:
1
The minimum number of characters a user must type before a search is performed. Zero is useful for local data with just a few items, but a higher value should be used when a single character search could match a few thousand items.
Code examples:
Initialize the autocomplete with the
minLength
option specified:
Default:
{ my: "left top", at: "left bottom", collision: "none" }
Identifies the position of the suggestions menu in relation to the associated input element. The
of
option defaults to the input element, but you can specify another element to position against. You can refer to the
jQuery UI Position
utility for more details about the various options.
Code examples:
Initialize the autocomplete with the
position
option specified:
Type:
Array
or
String
or
Function
(
Object
request,
Function
response(
Object
data ) )
Independent of the variant you use, the label is always treated as text. If you want the label to be treated as html you can use
Scott González' html extension
. The demos all focus on different variations of the
source
option - look for one that matches your use case, and check out the code.
Array
:
An array can be used for local data. There are two supported formats:
-
An array of strings:
[ "Choice1", "Choice2" ]
-
An array of objects with
label
and
value
properties:
[ { label: "Choice1", value: "value1" }, ... ]
The label property is displayed in the suggestion menu. The value will be inserted into the input element when a user selects an item. If just one property is specified, it will be used for both, e.g., if you provide only
value
properties, the value will also be used as the label.
String
: When a string is used, the Autocomplete plugin expects that string to point to a URL resource that will return JSON data. It can be on the same host or on a different one (must support CORS). The Autocomplete plugin does not filter the results, instead a query string is added with a
term
field, which the server-side script should use for filtering the results. For example, if the
source
option is set to
"https://example.com"
and the user types
foo
, a GET request would be made to
https://example.com?term=foo
. The data itself can be in the same format as the local data described above.
Function
:
The third variation, a callback, provides the most flexibility and can be used to connect any data source to Autocomplete, including JSONP. The callback gets two arguments:
-
A
request
object, with a single
term
property, which refers to the value currently in the text input. For example, if the user enters
"new yo"
in a city field, the Autocomplete term will equal
"new yo"
.
-
A
response
callback, which expects a single argument: the data to suggest to the user. This data should be filtered based on the provided term, and can be in any of the formats described above for simple local data. It's important when providing a custom source callback to handle errors during the request. You must always call the
response
callback even if you encounter an error. This ensures that the widget always has the correct state.
When filtering data locally, you can make use of the built-in
$.ui.autocomplete.escapeRegex
function. It'll take a single string argument and escape all regex characters, making the result safe to pass to
new RegExp()
.
Code examples:
Initialize the autocomplete with the
source
option specified:
close()
Returns:
jQuery
(
plugin only
)
Closes the Autocomplete menu. Useful in combination with the
search
method, to close the open menu.
Code examples:
Invoke the close method:
Removes the autocomplete functionality completely. This will return the element back to its pre-init state.
Code examples:
Invoke the destroy method:
Retrieves the autocomplete's instance object. If the element does not have an associated instance,
undefined
is returned.
Unlike other widget methods,
instance()
is safe to call on any element after the autocomplete plugin has loaded.
Code examples:
Invoke the instance method:
Gets the value currently associated with the specified
optionName
.
Note:
For options that have objects as their value, you can get the value of a specific key by using dot notation. For example,
"foo.bar"
would get the value of the
bar
property on the
foo
option.
optionName
Type:
String
The name of the option to get.
Code examples:
Invoke the method:
option()
Returns:
PlainObject
Gets an object containing key/value pairs representing the current autocomplete options hash.
Code examples:
Invoke the method:
option( options )
Returns:
jQuery
(
plugin only
)
Sets one or more options for the autocomplete.
options
Type:
Object
A map of option-value pairs to set.
Code examples:
Invoke the method:
search( [value ] )
Returns:
jQuery
(
plugin only
)
Triggers a
search
event and invokes the data source if the event is not canceled. Can be used by a selectbox-like button to open the suggestions when clicked. When invoked with no parameters, the current input's value is used. Can be called with an empty string and
minLength: 0
to display all items.
value
Type:
String
widget()
Returns:
jQuery
Returns a
jQuery
object containing the menu element. Although the menu items are constantly created and destroyed, the menu element itself is created during initialization and is constantly reused.
Code examples:
Invoke the widget method:
The autocomplete widget is built with the
widget factory
and can be
extended. When extending widgets, you have the ability to override or add to the
behavior of existing methods. The following methods are provided as extension points
with the same API stability as the
plugin methods
listed
above. For more information on widget extensions, see
Extending
Widgets with the Widget Factory
.
_renderItem( ul, item )
Returns:
jQuery
Method that controls the creation of each option in the widget's menu. The method must create a new
<li>
element, append it to the menu, and return it. See the
Menu
documentation for more details about the markup.
Type:
jQuery
The
<ul>
element that the newly created
<li>
element must be appended to.
Type:
Object
_resizeMenu()
Returns:
jQuery
(
plugin only
)
Method responsible for sizing the menu before it is displayed. The menu element is available at
this.menu.element
.
Code examples:
Always display the menu as 500 pixels wide.
change( event, ui )
Type:
autocompletechange
Triggered when the field is blurred, if the value has changed.
event
Type:
Event
close( event, ui )
Type:
autocompleteclose
Triggered when the menu is hidden. Not every
close
event will be accompanied by a
change
event.
event
Type:
Event
Triggered when focus is moved to an item (not selecting). The default action is to replace the text field's value with the value of the focused item, though only if the event was triggered by a keyboard interaction.
Canceling this event prevents the value from being updated, but does not prevent the menu item from being focused.
event
Type:
Event
open( event, ui )
Type:
autocompleteopen
Triggered when the suggestion menu is opened or updated.
event
Type:
Event
response( event, ui )
Type:
autocompleteresponse
Triggered after a search completes, before the menu is shown. Useful for local manipulation of suggestion data, where a custom
source
option callback is not required. This event is always triggered when a search completes, even if the menu will not be shown because there are no results or the Autocomplete is disabled.
event
Type:
Event
search( event, ui )
Type:
autocompletesearch
Triggered before a search is performed, after
minLength
and
delay
are met. If canceled, then no request will be started and no items suggested.
event
Type:
Event
Triggered when an item is selected from the menu. The default action is to replace the text field's value with the value of the selected item.
Canceling this event prevents the value from being updated, but does not prevent the menu from closing.
event
Type:
Event
<title>autocomplete demo</title>
<link rel="stylesheet" href="//code.jquery.com/ui/1.12.1/themes/smoothness/jquery-ui.css">
<script src="//code.jquery.com/jquery-1.12.4.js"></script>
<script src="//code.jquery.com/ui/1.12.1/jquery-ui.js"></script>
<label for="autocomplete">Select a programming language: </label>
<input id="autocomplete">
$( "#autocomplete" ).autocomplete({
source: [ "c++", "java", "php", "coldfusion", "javascript", "asp", "ruby" ]
<title>autocomplete demo</title>
<link rel="stylesheet" href="//code.jquery.com/ui/1.12.1/themes/smoothness/jquery-ui.css">
<script src="//code.jquery.com/jquery-1.12.4.js"></script>
<script src="//code.jquery.com/ui/1.12.1/jquery-ui.js"></script>
<label for="autocomplete">Select a programming language: </label>
<input id="autocomplete">
var tags = [ "c++", "java", "php", "coldfusion", "javascript", "asp", "ruby" ];
$( "#autocomplete" ).autocomplete({
source: function( request, response ) {
var matcher = new RegExp( "^" + $.ui.autocomplete.escapeRegex( request.term ), "i" );
response( $.grep( tags, function( item ){
return matcher.test( item );
Web hosting by Digital Ocean
|
CDN by Fastly
|
Powered by WordPress