API Docs for: 3.8.0
Show:

Plugin.AutoComplete Class

Binds an AutoCompleteList instance to a Node instance.

Item Index

Methods

Methods

_activateNextItem

() protected chainable

Activates the next item after the currently active item. If there is no next item and the circular attribute is true, focus will wrap back to the input node.

_activatePrevItem

() protected chainable

Activates the item previous to the currently active item. If there is no previous item and the circular attribute is true, focus will wrap back to the input node.

_add

(
  • items
)
NodeList protected

Appends the specified result items to the list inside a new item node.

Parameters:

Returns:

NodeList: Added nodes.

_addAttrs

(
  • cfgs
  • values
  • lazy
)
private

Implementation behind the public addAttrs method.

This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).

Parameters:

  • cfgs Object

    An object with attribute name/configuration pairs.

  • values Object

    An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.

  • lazy Boolean

    Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

_addLazyAttr

(
  • name
)
private

Finishes initializing an attribute which has been lazily added.

Parameters:

  • name Object

    The name of the attribute

_afterActiveItemChange

(
  • e
)
protected

Handles activeItemChange events.

Parameters:

_afterAlignChange

(
  • e
)
protected

Handles alignChange events by updating the UI in response to align Attribute changes.

Parameters:

_afterAlignOnChange

(
  • e
)
protected

Handles alignOnChange events by updating the alignment-syncing event handlers.

Parameters:

_afterAlwaysShowListChange

(
  • e
)
protected

Handles alwaysShowListChange events.

Parameters:

_afterChildSelectedChange

(
  • event
)
protected

Default attribute change listener for the selected attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • event EventFacade

    The event facade for the attribute change.

_afterDocClick

(
  • e
)
protected

Inherited from AutoCompleteList: autocomplete/js/autocomplete-list.js:607

Available since 3.5.0

Handles click events on the document. If the click is outside both the input node and the bounding box, the list will be hidden.

Parameters:

_afterHoveredItemChange

(
  • e
)
protected

Handles hoveredItemChange events.

Parameters:

_afterListInputBlur

() protected

Handles inputNode blur events.

_afterListInputFocus

() protected

Handles inputNode focus events.

_afterMouseOut

(
  • e
)
protected

Handles mouseout events.

Parameters:

_afterMouseOver

(
  • e
)
protected

Handles mouseover events.

Parameters:

_afterResultsChange

(
  • e
)
protected

Handles resultsChange events.

Parameters:

_afterSourceTypeChange

(
  • e
)
protected

Updates the current source based on the new sourceType to ensure that the two attributes don't get out of sync when they're changed separately.

Parameters:

_afterValueChange

(
  • e
)
protected

Handles change events for the value attribute.

Parameters:

_afterVisibleChange

(
  • e
)
protected

Handles visibleChange events.

Parameters:

_afterXYChange

(
  • e
)
protected

Default attribute change listener for the xy attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • e EventFacade

    The event facade for the attribute change

_aggregateAttrs

(
  • allAttrs
)
Object private

A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.

The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).

Parameters:

  • allAttrs Array

    An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object: The aggregate set of ATTRS definitions for the instance

_applyParsedConfig

() Object protected

Returns:

Object: The merged configuration literal

_applyParser

(
  • config
)
protected

Utility method used to apply the HTML_PARSER configuration for the instance, to retrieve config data values.

Parameters:

  • config Object

    User configuration object (will be populated with values from Node)

_ariaSay

(
  • stringId
  • [subs]
)
protected

Updates the ARIA live region with the specified message.

Parameters:

  • stringId String

    String id (from the strings attribute) of the message to speak.

  • [subs] Object optional

    Substitutions for placeholders in the string.

_attachPosAlignUIHandles

() protected

Attaches the alignment-syncing event handlers.

_attrCfgHash

() private

Utility method to define the attribute hash used to filter/whitelist property mixes for this class.

_baseDestroy

() private

Internal destroy implementation for BaseCore

_baseInit

() private

Internal initialization implementation for BaseCore

_beforeCreateObjectSource

(
  • source
)
protected

Runs before AutoCompleteBase's _createObjectSource() method and augments it to support additional object-based source types.

Parameters:

_bindAttrUI

(
  • attrs
)
private

Binds after listeners for the list of attributes provided

Parameters:

_bindDOM

() protected

Sets up DOM listeners, on elements rendered by the widget.

_bindInput

() protected

Binds inputNode events and behavior.

_bindKeys

() protected

Binds keyboard events.

_bindList

() protected

Binds list events.

_bindUI

() protected

Sets up DOM and CustomEvent listeners for the widget.

_bindUIACBase

() protected

Attaches event listeners and behaviors.

_bindUIChild

() protected

Binds event listeners responsible for updating the UI state in response to WidgetChild related state changes.

This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

_bindUIPosAlign

() protected

Bind event listeners responsible for updating the UI state in response to the widget's position-align related state changes.

This method is invoked after bindUI has been invoked for the Widget class using the AOP infrastructure.

_bindUIPosition

() protected

Binds event listeners responsible for updating the UI state in response to Widget position related state changes.

This method in invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

_clear

() protected

Clears the contents of the tray.

_createAriaNode

() Node protected

Creates and returns an ARIA live region node.

Returns:

Node: ARIA node.

_createArraySource

(
  • source
)
Object protected

Creates a DataSource-like object that simply returns the specified array as a response. See the source attribute for more details.

Parameters:

Returns:

Object: DataSource-like object.

_createFunctionSource

(
  • source
)
Object protected

Creates a DataSource-like object that passes the query to a custom-defined function, which is expected to call the provided callback with an array of results. See the source attribute for more details.

Parameters:

  • source Function

    Function that accepts a query and a callback as parameters, and calls the callback with an array of results.

Returns:

Object: DataSource-like object.

_createIOSource

(
  • source
)
Object protected

Creates a DataSource-like object that uses Y.io as a source. See the source attribute for more details.

Parameters:

Returns:

Object: DataSource-like object.

_createItemNode

(
  • result
)
Node protected

Creates and returns an item node with the specified content.

Parameters:

  • result Object

    Result object.

Returns:

Node: Item node.

_createJSONPSource

(
  • source
)
Object protected

Creates a DataSource-like object that uses the specified JSONPRequest instance as a source. See the source attribute for more details.

Parameters:

Returns:

Object: DataSource-like object.

_createListNode

() Node protected

Creates and returns a list node. If the listNode attribute is already set to an existing node, that node will be used.

Returns:

Node: List node.

_createObjectSource

(
  • source
)
Object protected

Creates a DataSource-like object that looks up queries as properties on the specified object, and returns the found value (if any) as a response. See the source attribute for more details.

Parameters:

Returns:

Object: DataSource-like object.

_createSelectSource

(
  • source
)
Object protected

Creates a DataSource-like object that uses the specified <select> node as a source.

Parameters:

  • source Node

    YUI Node instance wrapping a <select> node.

Returns:

Object: DataSource-like object.

_createStringSource

(
  • source
)
Object protected

Creates a DataSource-like object that calls the specified URL or executes the specified YQL query for results. If the string starts with "select ", "use ", or "set " (case-insensitive), it's assumed to be a YQL query; otherwise, it's assumed to be a URL (which may be absolute or relative). URLs containing a "{callback}" placeholder are assumed to be JSONP URLs; all others will use XHR. See the source attribute for more details.

Parameters:

  • source String

    URL or YQL query.

Returns:

Object: DataSource-like object.

_createUIEvent

(
  • type
)
private

Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.

Parameters:

  • type String

    String representing the name of the event

_createYQLSource

(
  • source
)
Object protected

Creates a DataSource-like object that uses the specified YQL query string to create a YQL-based source. See the source attribute for details. If no resultListLocator is defined, this method will set a best-guess locator that might work for many typical YQL queries.

Parameters:

Returns:

Object: DataSource-like object.

_defAttrChangeFn

(
  • e
)
private

Default function for attribute change events.

Parameters:

  • e EventFacade

    The event object for attribute change events.

_defaultCB

() protected

Returns the default value for the contentBox attribute.

For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)

_defaultYQLLocator

(
  • response
)
Array protected

Default resultListLocator used when a string-based YQL source is set and the implementer hasn't already specified one.

Parameters:

  • response Object

    YQL response object.

Returns:

_defClearFn

() protected

Default clear event handler. Sets the results attribute to an empty array and query to null.

_defDestroyFn

(
  • e
)
protected

Default destroy event handler

Parameters:

_defInitFn

(
  • e
)
protected

Default init event handler

Parameters:

  • e EventFacade

    Event object, with a cfg property which refers to the configuration object passed to the constructor.

_defQueryFn

(
  • e
)
protected

Default query event handler. Sets the query attribute and sends a request to the source if one is configured.

Parameters:

_defRenderFn

(
  • e
  • parentNode
)
protected

Default render handler

Parameters:

  • e EventFacade

    The Event object

  • parentNode Node

    The parent node to render to, if passed in to the render method

_defResultsFn

(
  • e
)
protected

Default results event handler. Sets the results attribute to the latest results.

Parameters:

_defSelectFn

(
  • e
)
protected

Default select event handler.

Parameters:

_destroyBox

() protected

Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.

_destroyHierarchy

() private

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

_destroyUIEvents

() private

Destructor logic for UI event infrastructure, invoked during Widget destruction.

_detachPosAlignUIHandles

() protected

Detaches the alignment-syncing event handlers.

_doAlign

(
  • widgetPoint
  • x
  • y
)
private

Helper method, used to align the given point on the widget, with the XY page coordinates provided.

Parameters:

  • widgetPoint String

    Supported point constant (e.g. WidgetPositionAlign.TL)

  • x Number

    X page coordinate to align to.

  • y Number

    Y page coordinate to align to.

_filterAdHocAttrs

(
  • allAttrs
  • userVals
)
Object private

Parameters:

  • allAttrs Object

    The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.

  • userVals Object

    The config object passed in by the user, from which adhoc attrs are to be filtered.

Returns:

Object: The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

_filterAttrCfs

(
  • clazz
  • allCfgs
)
Object private

A helper method used when processing ATTRS across the class hierarchy during initialization. Returns a disposable object with the attributes defined for the provided class, extracted from the set of all attributes passed in.

Parameters:

  • clazz Function

    The class for which the desired attributes are required.

  • allCfgs Object

    The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.

Returns:

Object: The set of attributes belonging to the class passed in, in the form of an object with attribute name/configuration pairs.

_filterUIEvent

(
  • evt
)
Boolean private

This method is used to determine if we should fire the UI Event or not. The default implementation makes sure that for nested delegates (nested unrelated widgets), we don't fire the UI event listener more than once at each level.

For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.

Parameters:

Returns:

Boolean: true if it's OK to fire the custom UI event, false if not.

_fireAttrChange

(
  • attrName
  • subAttrName
  • currVal
  • newVal
  • opts
)
private

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

  • attrName String

    The name of the attribute

  • subAttrName String

    The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.

  • currVal Any

    The current value of the attribute

  • newVal Any

    The new value of the attribute

  • opts Object

    Any additional event data to mix into the attribute change event's event facade.

_functionValidator

(
  • value
)
protected

Returns true if value is either a function or null.

Parameters:

  • value Function | Null

    Value to validate.

_getAttr

(
  • name
)
Any protected chainable

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.

See get for argument details.

Parameters:

  • name String

    The name of the attribute.

Returns:

Any: The value of the attribute.

_getAttrCfg

(
  • name
)
Object protected

Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.

Parameters:

  • name String

    Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object: The configuration properties for the given attribute, or all attributes.

_getAttrCfgs

() Object protected

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object: The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.

_getAttrInitVal

(
  • attr
  • cfg
  • initValues
)
Any private

Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.

Parameters:

  • attr String

    The name of the attribute

  • cfg Object

    The attribute configuration object

  • initValues Object

    The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any: The initial value of the attribute.

_getAttrs

(
  • attrs
)
Object protected

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

  • attrs Array | boolean

    Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object: An object with attribute name/value pairs.

_getClasses

() Function[] protected

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function[]: An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.

_getFirstItemNode

() Node | Null protected

Gets the first item node in the list, or null if the list is empty.

Returns:

Node | Null:

_getHtmlParser

() Object private

Gets the HTMLPARSER definition for this instance, by merging HTMLPARSER definitions across the class hierarchy.

Returns:

Object: HTML_PARSER definition for this instance

_getLastItemNode

() Node | Null protected

Gets the last item node in the list, or null if the list is empty.

Returns:

Node | Null:

_getNodeToParse

() Node private

Determines whether we have a node reference which we should try and parse.

The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.

Returns:

Node: The node reference to apply HTML_PARSER to.

_getObjectValue

(
  • obj
  • path
)
Any protected

Faster and safer alternative to Y.Object.getValue(). Doesn't bother casting the path to an array (since we already know it's an array) and doesn't throw an error if a value in the middle of the object hierarchy is neither undefined nor an object.

Parameters:

Returns:

Any: Located value, or undefined if the value was not found at the specified path.

_getRegion

(
  • [node]
)
Object private

Returns the region of the passed-in Node, or the viewport region if calling with passing in a Node.

Parameters:

  • [node] Node optional

    The node to get the region of.

Returns:

Object: The node's region.

_getSrcNode

() Node protected

Returns:

Node: The Node to apply HTML_PARSER to

_getStateVal

(
  • name
)
Any private

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

  • name String

    The name of the attribute

Returns:

Any: The stored value of the attribute

_getStrings

(
  • locale
)
protected

Returns the strings key/value hash for a paricular locale, without locale lookup applied.

Parameters:

_getType

() private

If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.

_getUIEventNode

() protected

Inherited from Widget but overwritten in widget-child/js/Widget-Child.js:167

Returns the node on which to bind delegate listeners.

Override of Widget's implementation of _getUIEventNode() to ensure that all event listeners are bound to the Widget's topmost DOM element. This ensures that the firing of each type of Widget UI event (click, mousedown, etc.) is facilitated by a single, top-level, delegated DOM event listener.

_getX

() Number protected

Default getter for the X attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.

Returns:

Number: The X page co-ordinate value

_getXHRUrl

(
  • url
  • request
)
String protected

Returns a formatted XHR URL based on the specified base url, query, and the current requestTemplate if any.

Parameters:

  • url String

    Base URL.

  • request Object

    Request object containing query and request properties.

Returns:

String: Formatted URL.

_getY

() Number protected

Default getter for the Y attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.

Returns:

Number: The Y page co-ordinate value

_guid

() protected

_initAttrHost

(
  • attrs
  • values
  • lazy
)
private

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

  • attrs Object

    The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

  • values Object

    The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.

  • lazy Boolean

    Whether or not to add attributes lazily (passed through to addAttrs).

_initAttribute

() private

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:209

Initializes AttributeCore

_initAttrs

(
  • attrs
  • values
  • lazy
)
protected

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

  • attrs Object

    The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

  • values Object

    The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.

  • lazy Boolean

    Whether or not to add attributes lazily (passed through to addAttrs).

_initBase

(
  • config
)
private

Internal construction logic for BaseCore.

Parameters:

  • config Object

    The constructor configuration object

_initHierarchy

(
  • userVals
)
private

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

  • userVals Object

    Object with configuration property name/value pairs

_initHierarchyData

() private

A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.

_initKeys

() protected

Initializes keyboard command mappings.

_initUIEvent

(
  • type
)
String private

Sets up infrastructure required to fire a UI event.

Parameters:

  • type String

    String representing the name of the event

Returns:

_isLazyAttr

(
  • name
)
Boolean private

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

  • name String

    The name of the attribute

Returns:

Boolean: true if it's a lazily added attribute, false otherwise.

_isUIEvent

(
  • type
)
String private

Determines if the specified event is a UI event.

Parameters:

  • type String

    String representing the name of the event

Returns:

String: Event Returns the name of the UI Event, otherwise undefined.

_jsonpFormatter

(
  • url
  • proxy
  • query
)
String protected

URL formatter passed to JSONPRequest instances.

Parameters:

Returns:

String: Formatted URL

_keyDown

() protected

Called when the down arrow key is pressed.

_keyEnter

() protected

Called when the enter key is pressed.

_keyEsc

() protected

Called when the escape key is pressed.

_keyTab

() protected

Called when the tab key is pressed.

_keyUp

() protected

Called when the up arrow key is pressed.

_mapInstance

(
  • The
)
protected

Utility method used to add an entry to the boundingBox id to instance map.

This method can be used to populate the instance with lazily created boundingBox Node references.

Parameters:

_monitor

(
  • what
  • eventType
  • o
)
private

This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> clickattach, clickdetach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.

Parameters:

  • what String

    'attach', 'detach', 'fire', or 'publish'

  • eventType String | CustomEvent

    The prefixed name of the event being monitored, or the CustomEvent object.

  • o Object

    Information about the event interaction, such as fire() args, subscription category, publish config

_normAttrVals

(
  • valueHash
)
Object private

Utility method to split out simple attribute name/value pairs ("x") from complex attribute name/value pairs ("x.y.z"), so that complex attributes can be keyed by the top level attribute name.

Parameters:

  • valueHash Object

    An object with attribute name/value pairs

Returns:

Object: An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.

_onDocFocus

(
  • evt
)
protected

DOM focus event handler, used to sync the state of the Widget with the DOM

Parameters:

  • evt EventFacade

    The event facade for the DOM focus event

_onDocMouseDown

(
  • evt
)
protected

"mousedown" event handler for the owner document of the widget's bounding box.

Parameters:

  • evt EventFacade

    The event facade for the DOM focus event

_onInputBlur

(
  • e
)
protected

Handles blur events on the input node.

Parameters:

_onInputKey

(
  • e
)
protected

Handles inputNode key events.

Parameters:

_onInputValueChange

(
  • e
)
protected

Handles valueChange events on the input node and fires a query event when the input value meets the configured criteria.

Parameters:

_onItemClick

(
  • e
)
protected

Delegated event handler for item click events.

Parameters:

_onResponse

(
  • e
)
protected

Handles source responses and fires the results event.

Parameters:

_parseResponse

(
  • query
  • response
  • data
)
protected

Parses result responses, performs filtering and highlighting, and fires the results event.

Parameters:

  • query String

    Query that generated these results.

  • response Object

    Response containing results.

  • data Object

    Raw response data.

_parseType

() private

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

_parseValue

(
  • value
)
String | Null protected

Returns the query portion of the specified input value, or null if there is no suitable query within the input value.

If a query delimiter is defined, the query will be the last delimited part of of the string.

Parameters:

  • value String

    Input value from which to extract the query.

Returns:

String | Null: query

_preInitEventCfg

(
  • config
)
private

Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.

Parameters:

  • config Object

    The user configuration object

_protectAttrs

(
  • attrs
)
Object deprecated protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:815

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

  • attrs Object

    A hash of attribute to configuration object pairs.

Returns:

Object: A protected version of the attrs argument.

_removeLoadingClassNames

() protected

Removes class names representative of the widget's loading state from the boundingBox.

_renderBox

(
  • parentNode
)
private

Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.

Parameters:

  • parentNode Node

    The parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.

_renderBoxClassNames

() protected

Applies standard class names to the boundingBox and contentBox

_renderUI

() protected

Initializes the UI state for the Widget's bounding/content boxes.

_renderUIPosition

() protected

Creates/Initializes the DOM to support xy page positioning.

This method in invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.

_set

(
  • name
  • val
)
Object protected chainable

Allows setting of readOnly/writeOnce attributes. See set for argument details.

Parameters:

  • name String

    The name of the attribute.

  • val Any

    The value to set the attribute to.

Returns:

Object: A reference to the host object.

_setAlignCenter

(
  • val
)
Boolean | Node protected

Default setter for center Attribute changes. Sets up the appropriate value, and passes it through the to the align attribute.

Parameters:

Returns:

Boolean | Node: the value passed in.

_setAttr

(
  • name
  • value
  • opts
  • force
)
Object protected chainable

Provides the common implementation for the public set and protected _set methods.

See set for argument details.

Parameters:

  • name String

    The name of the attribute.

  • value Any

    The value to set the attribute to.

  • opts Object

    (Optional) Optional event data to be mixed into the event facade passed to subscribers of the attribute's change event. This is currently a hack. There's no real need for the AttributeCore implementation to support this parameter, but breaking it out into AttributeObservable, results in additional function hops for the critical path.

  • force Boolean

    If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object: A reference to the host object.

_setAttrs

(
  • attrs
)
Object protected chainable

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

  • attrs Object

    An object with attributes name/value pairs.

Returns:

Object: A reference to the host object.

_setAttrUI

(
  • e
)
private

Parameters:

_setAttrVal

(
  • attrName
  • subAttrName
  • prevVal
  • newVal
)
Booolean private

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

  • attrName String

    The attribute name.

  • subAttrName String

    The sub-attribute name, if setting a sub-attribute property ("x.y.z").

  • prevVal Any

    The currently stored value of the attribute.

  • newVal Any

    The value which is going to be stored.

Returns:

Booolean: true if the new attribute value was stored, false if not.

_setBB

(
  • Node/String
)
private

Setter for the boundingBox attribute

Parameters:

Returns:

Node

_setBox

(
  • id
  • node
  • template
  • true
)
Node private

Helper method to set the bounding/content box, or create it from the provided template if not found.

Parameters:

  • id String

    The node's id attribute

  • node Node | String

    The node reference

  • template String

    HTML string template for the node

  • true Boolean

    if this is the boundingBox, false if it's the contentBox

Returns:

Node: The node

_setCB

(
  • node
)
private

Setter for the contentBox attribute

Parameters:

Returns:

Node

_setEnableCache

(
  • value
)
protected

Inherited from AutoCompleteBase: autocomplete/js/autocomplete-base.js:559

Available since 3.5.0

Setter for the enableCache attribute.

Parameters:

_setLocator

(
  • locator
)
Function | Null protected

Setter for locator attributes.

Parameters:

Returns:

Function | Null:

_setRequestTemplate

(
  • template
)
Function | Null protected

Setter for the requestTemplate attribute.

Parameters:

Returns:

Function | Null:

_setResultFilters

(
  • filters
)
Function[] protected

Setter for the resultFilters attribute.

Parameters:

  • filters Array | Function | String | Null

    null, a filter function, an array of filter functions, or a string or array of strings representing the names of methods on Y.AutoCompleteFilters.

Returns:

Function[]: Array of filter functions (empty if filters is null).

_setResultHighlighter

(
  • highlighter
)
Function | Null protected

Setter for the resultHighlighter attribute.

Parameters:

  • highlighter Function | String | Null

    null, a highlighter function, or a string representing the name of a method on Y.AutoCompleteHighlighters.

Returns:

Function | Null:

_setSource

(
  • source
)
DataSource | Object protected

Setter for the source attribute. Returns a DataSource or a DataSource-like object depending on the type of source and/or the value of the sourceType attribute.

Parameters:

  • source Any

    AutoComplete source. See the source attribute for details.

Returns:

DataSource | Object:

_setStateVal

(
  • name
  • value
)
private

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

  • name String

    The name of the attribute

  • value Any

    The value of the attribute

_setStrings

(
  • strings
  • locale
)
protected

Sets strings for a particular locale, merging with any existing strings which may already be defined for the locale.

Parameters:

  • strings Object

    The hash of string key/values to set

  • locale Object

    The locale for the string values being set

_setX

(
  • val
)
protected

Default setter for the X attribute. The setter passes the X value through to the XY attribute, which is the sole store for the XY state.

Parameters:

  • val Number

    The X page co-ordinate value

_setY

(
  • val
)
protected

Default setter for the Y attribute. The setter passes the Y value through to the XY attribute, which is the sole store for the XY state.

Parameters:

  • val Number

    The Y page co-ordinate value

_sourceSuccess

(
  • data
  • request
)
protected

Shared success callback for non-DataSource sources.

Parameters:

  • data Any

    Response data.

  • request Object

    Request object.

_strSetter

(
  • strings
)
String protected

The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings

Parameters:

Returns:

String: The full set of strings to set

_syncAttrUI

(
  • attrs
)
private

Invokes the _uiSet=ATTR NAME> method for the list of attributes provided

Parameters:

_syncBrowserAutocomplete

() protected

Synchronizes the UI state of the allowBrowserAutocomplete attribute.

_syncPosition

() protected

Synchronizes the result list's position and alignment.

_syncResults

(
  • [results]
)
protected

Synchronizes the results displayed in the list with those in the results argument, or with the results attribute if an argument is not provided.

Parameters:

  • [results] Array optional

    Results.

_syncShim

() protected

Synchronizes the size of the iframe shim used for IE6 and lower. In other browsers, this method is a noop.

_syncUI

() protected

Updates the widget UI to reflect the attribute state.

_syncUIACBase

() protected

Synchronizes the UI state of the inputNode.

_syncUIChild

() protected

Synchronizes the UI to match the WidgetChild state.

This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

_syncUIPosAlign

() protected

Synchronizes the current align Attribute value to the DOM.

This method is invoked after syncUI has been invoked for the Widget class using the AOP infrastructure.

_syncUIPosition

() protected

Synchronizes the UI to match the Widgets xy page position state.

This method in invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.

_syncVisibility

(
  • [visible]
)
protected

Synchronizes the visibility of the tray with the visible argument, or with the visible attribute if an argument is not provided.

Parameters:

  • [visible] Boolean optional

    Visibility.

_uiSetAlign

(
  • [node]
  • points
)
protected

Updates the UI to reflect the align value passed in.

Note: See the align Attribute documentation, for the Object structure expected.

Parameters:

  • [node] Node | String | Null optional

    The node to align to, or null to indicate the viewport.

  • points Array

    The alignment points.

_uiSetChildSelected

(
  • selected
)
protected

Updates the UI to reflect the selected attribute value.

Parameters:

  • selected Number

    The selected value to be reflected in the UI.

_uiSetDim

(
  • dim
  • val
)
private

Parameters:

_uiSetDisabled

(
  • val
)
protected

Sets the disabled state for the UI

Parameters:

_uiSetFocused

(
  • val
  • src
)
protected

Sets the focused state for the UI

Parameters:

  • val Boolean
  • src String

    String representing the source that triggered an update to the UI.

_uiSetHeight

(
  • val
)
protected

Sets the height on the widget's bounding box element

Parameters:

_uiSetTabIndex

(
  • Number
)
protected

Set the tabIndex on the widget's rendered UI

Parameters:

_uiSetVisible

(
  • val
)
protected

Sets the visible state for the UI

Parameters:

_uiSetVisiblePosAlign

(
  • visible
)
protected

Attaches or detaches alignment-syncing event handlers based on the widget's visible Attribute state.

Parameters:

  • visible Boolean

    The current value of the widget's visible Attribute.

_uiSetWidth

(
  • val
)
protected

Sets the width on the widget's bounding box element

Parameters:

_uiSetXY

(
  • val
)
protected

Updates the UI to reflect the XY page co-ordinates passed in.

Parameters:

  • val String

    The XY page co-ordinates value to be reflected in the UI

_uiSizeCB

(
  • expand
)
protected

Parameters:

_unbindDOM

() protected

_unbindKeys

() protected

Unbinds keyboard events.

_unbindUI

() protected

_updateValue

(
  • newVal
)
protected

Updates the query portion of the value attribute.

If a query delimiter is defined, the last delimited portion of the input value will be replaced with the specified value.

Parameters:

_validateXY

(
  • val
)
Boolean protected

Default validator for the XY attribute

Parameters:

  • val Array

    The XY page co-ordinate value which is being set.

Returns:

Boolean: true if valid, false if not.

_validTabIndex

(
  • tabIndex
)
protected

Parameters:

addAttr

(
  • name
  • config
  • lazy
)
Object chainable

Adds an attribute with the provided configuration to the host object.

The config argument object supports the following properties:

value <Any>
The initial value to set on the attribute
valueFn <Function | String>

A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.

valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.

readOnly <boolean>
Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
writeOnce <boolean> or <string>
Whether or not the attribute is "write once". Attributes having writeOnce set to true, can only have their values set once, be it through the default configuration, constructor configuration arguments, or by invoking set.

The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)

setter <Function | String>

The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.

setter can also be set to a string, representing the name of the instance method to be used as the setter function.

getter <Function | String>

The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.

getter can also be set to a string, representing the name of the instance method to be used as the getter function.

validator <Function | String>

The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.

validator can also be set to a string, representing the name of the instance method to be used as the validator function.

lazyAdd <boolean>
Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.

The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.

Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

Parameters:

  • name String

    The name of the attribute.

  • config Object

    An object with attribute configuration property/value pairs, specifying the configuration for the attribute.

    NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.

  • lazy Boolean

    (optional) Whether or not to add this attribute lazily (on the first call to get/set).

Returns:

Object: A reference to the host object.

addAttrs

(
  • cfgs
  • values
  • lazy
)
Object chainable

Configures a group of attributes, and sets initial values.

NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

Parameters:

  • cfgs Object

    An object with attribute name/configuration pairs.

  • values Object

    An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.

  • lazy Boolean

    Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

Returns:

Object: A reference to the host object.

addTarget

(
  • o
)

Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.

Events can only bubble if emitFacade is true.

Included in the event-custom-complex submodule.

Parameters:

after

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

align

(
  • [node]
  • [points]
)
chainable

Aligns this widget to the provided Node (or viewport) using the provided points. This method can be invoked with no arguments which will cause the widget's current align Attribute value to be synced to the DOM.

Parameters:

  • [node] Node | String | Null optional

    A reference (or selector String) for the Node which with the widget is to be aligned. If null is passed in, the widget will be aligned with the viewport.

  • [points] Array2 optional

    A two item array specifying the points on the widget and Node/viewport which will to be aligned. The first entry is the point on the widget, and the second entry is the point on the Node/viewport. Valid point references are defined as static constants on the WidgetPositionAlign extension.

Example:

Aligning to the top-left corner of the <body>:

myWidget.align('body',
    [Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.TR]);

ancestor

(
  • depth
)
Widget

Returns the Widget instance at the specified depth.

Parameters:

  • depth Number

    Number representing the depth of the ancestor.

Returns:

Widget: Widget instance.

attrAdded

(
  • name
)
Boolean

Checks if the given attribute has been added to the host

Parameters:

  • name String

    The name of the attribute to check.

Returns:

Boolean: true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.

before

()

Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.

For DOM and custom events: type, callback, context, 0-n arguments

For methods: callback, object (method host), methodName, context, 0-n arguments

Returns:

detach handle

bindUI

() protected

Configures/Sets up listeners to bind Widget State to UI/DOM

This method is not called by framework and is not chained automatically for the class hierarchy.

blur

() chainable

Causes the Widget to lose focus by setting the "focused" attribute to "false"

bubble

(
  • evt
)
Boolean

Propagate an event. Requires the event-custom-complex module.

Parameters:

Returns:

Boolean: the aggregated return value from Event.Custom.fire

centered

(
  • [node]
)
chainable

Centers the widget in the viewport, or if a Node is passed in, it will be centered to that Node.

Parameters:

  • [node] Node | String optional

    A Node reference or selector String defining the Node which the widget should be centered. If a Node is not passed in, then the widget will be centered to the viewport.

clearCache

() chainable

Inherited from AutoCompleteBase: autocomplete/js/autocomplete-base.js:177

Available since 3.5.0

Clears the result cache.

destroy

(
  • destroyAllNodes
)
Widget chainable

Inherited from BaseObservable but overwritten in widget/js/Widget.js:452

Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy

Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.

Parameters:

  • destroyAllNodes Boolean

    If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.

Returns:

Widget: A reference to this object

destructor

() protected

Destructor lifecycle implementation for the Widget class. Purges events attached to the bounding box and content box, removes them from the DOM and removes the Widget from the list of registered widgets.

detach

(
  • type
  • fn
  • context
)
EventTarget

Detach one or more listeners the from the specified event

Parameters:

  • type String | Object

    Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.

  • fn Function

    The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.

  • context Object

    The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)

Returns:

EventTarget: the host

detachAll

(
  • type
)

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String

    The type, or name of the event

disable

() chainable

Set the Widget's "disabled" attribute to "true".

enable

() chainable

Set the Widget's "disabled" attribute to "false".

fire

(
  • type
  • arguments
)
EventTarget

Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.

If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.

The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.

Parameters:

  • type String | Object

    The type of the event, or an object that contains a 'type' property.

  • arguments Object*

    an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.

Returns:

EventTarget: the event host

focus

() chainable

Causes the Widget to receive the focus by setting the "focused" attribute to "true".

get

(
  • name
)
Any

Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.

Parameters:

  • name String

    The name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g. get("x.y.z"))

Returns:

Any: The value of the attribute

getAttrs

(
  • attrs
)
Object

Gets multiple attribute values.

Parameters:

  • attrs Array | boolean

    Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object: An object with attribute name/value pairs.

getClassName

(
  • args
)

Inherited from Widget but overwritten in widget/js/Widget.js:309

Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined by the Y.config.classNamePrefix attribute used by ClassNameManager and Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for the prefix and widget class name).

The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.

Parameters:

  • args String* multiple

    0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name

getDefaultLocale

() String

Returns the default locale for the widget (the locale value defined by the widget class, or provided by the user during construction).

Returns:

String: The default locale for the widget

getEvent

(
  • type
  • prefixed
)
CustomEvent

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

  • type String

    the type, or name of the event

  • prefixed String

    if true, the type is prefixed already

Returns:

CustomEvent: the custom event or null

getSkinName

() String

Returns the name of the skin that's currently applied to the widget. This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement. Searches up the Widget's ancestor axis for a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.

Returns:

String: the name of the skin, or null (yui3-skin-sam => sam)

getString

(
  • key
)
String deprecated

Inherited from Widget but overwritten in widget/js/Widget.js:1223

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get a specific string value

Parameters:

Returns:

String: The string

getStrings

(
  • key
)
String deprecated

Inherited from Widget but overwritten in widget/js/Widget.js:1235

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get the complete set of strings for the widget

Parameters:

Returns:

String: The strings

getTargets

()

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

hide

() chainable

Inherited from Widget but overwritten in autocomplete/js/autocomplete-list.js:173

Hides the list, unless the alwaysShowList attribute is true.

init

(
  • cfg
)
BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:219

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

  • cfg Object

    Object with configuration property name/value pairs

Returns:

BaseCore: A reference to this object

initializer

(
  • config
)
protected

Initializer lifecycle implementation for the Widget class. Registers the widget instance, and runs through the Widget's HTML_PARSER definition.

Parameters:

  • config Object

    Configuration object literal for the widget

isRoot

() Boolean

Determines if the Widget is the root Widget in the object hierarchy.

Returns:

Boolean: Boolean indicating if Widget is the root Widget in the object hierarchy.

modifyAttr

(
  • name
  • config
)

Updates the configuration of an attribute which has already been added.

The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute: readOnly, writeOnce, broadcast and getter.

Parameters:

  • name String

    The name of the attribute whose configuration is to be updated.

  • config Object

    An object with configuration property/value pairs, specifying the configuration properties to modify.

move

(
  • x
  • y
  • x,
)

Moves the Widget to the specified page xy co-ordinate position.

Parameters:

  • x Number

    The new x position

  • y Number

    The new y position

    Or

  • x, Array

    y values passed as an array ([x, y]), to support simple pass through of Node.getXY results

next

(
  • circular
)
Widget

Returns the Widget's next sibling.

Parameters:

  • circular Boolean

    Boolean indicating if the parent's first child should be returned if the child has no next sibling.

Returns:

Widget: Widget instance.

on

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.

Callback functions for events published with emitFacade = true will receive an EventFacade as the first argument (typically named "e"). These callbacks can then call e.preventDefault() to disable the behavior published to that event's defaultFn. See the EventFacade API for all available properties and methods. Subscribers to non-emitFacade events will receive the arguments passed to fire() after the event name.

To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.

Returning false from a callback is supported as an alternative to calling e.preventDefault(); e.stopPropagation();. However, it is recommended to use the event methods whenever possible.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

once

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Listen to a custom event hosted by this object one time. This is the equivalent to on except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

onceAfter

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Listen to a custom event hosted by this object one time. This is the equivalent to after except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

parseType

(
  • type
  • [pre=this._yuievt.config.prefix]
)
Array

Inherited from EventTarget: event-custom/js/event-target.js:171

Available since 3.3.0

Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.

Parameters:

  • type String

    the type

  • [pre=this._yuievt.config.prefix] String optional

    the prefix

Returns:

Array: an array containing: * the detach category, if supplied, * the prefixed event type, * whether or not this is an after listener, * the supplied event type

previous

(
  • circular
)
Widget

Returns the Widget's previous sibling.

Parameters:

  • circular Boolean

    Boolean indicating if the parent's last child should be returned if the child has no previous sibling.

Returns:

Widget: Widget instance.

publish

(
  • type
  • opts
)
CustomEvent

Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.

Parameters:

  • type String

    the type, or name of the event

  • opts Object

    optional config params. Valid properties are:

    • 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
    • 'bubbles': whether or not this event bubbles (true) Events can only bubble if emitFacade is true.
    • 'context': the default execution context for the listeners (this)
    • 'defaultFn': the default function to execute when this event fires if preventDefault was not called
    • 'emitFacade': whether or not this event emits a facade (false)
    • 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
    • 'fireOnce': if an event is configured to fire once, new subscribers after the fire will be notified immediately.
    • 'async': fireOnce event listeners will fire synchronously if the event has already fired unless async is true.
    • 'preventable': whether or not preventDefault() has an effect (true)
    • 'preventedFn': a function that is executed when preventDefault is called
    • 'queuable': whether or not this event can be queued during bubbling (false)
    • 'silent': if silent is true, debug messages are not provided for this event.
    • 'stoppedFn': a function that is executed when stopPropagation is called
    • 'monitored': specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
    • 'type': the event type (valid option if not provided as the first parameter to publish)

Returns:

CustomEvent: the custom event

removeAttr

(
  • name
)

Removes an attribute from the host object

Parameters:

  • name String

    The name of the attribute to be removed.

removeTarget

(
  • o
)

Removes a bubble target

Parameters:

render

(
  • parentNode
)
final chainable

Establishes the initial DOM for the widget. Invoking this method will lead to the creating of all DOM elements for the widget (or the manipulation of existing DOM elements for the progressive enhancement use case).

This method should only be invoked once for an initialized widget.

It delegates to the widget specific renderer method to do the actual work.

Parameters:

  • parentNode Object | String

    Optional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string.

    If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case.

renderer

() protected

Creates DOM (or manipulates DOM for progressive enhancement) This method is invoked by render() and is not chained automatically for the class hierarchy (unlike initializer, destructor) so it should be chained manually for subclasses if required.

renderUI

() protected

Adds nodes to the DOM

This method is not called by framework and is not chained automatically for the class hierarchy.

reset

(
  • name
)
Object chainable

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

Parameters:

  • name String

    Optional. The name of the attribute to reset. If omitted, all attributes are reset.

Returns:

Object: A reference to the host object.

selectItem

(
  • [itemNode]
  • [originEvent]
)
chainable

Selects the specified itemNode, or the current activeItem if itemNode is not specified.

Parameters:

  • [itemNode] Node optional

    Item node to select.

  • [originEvent] EventFacade optional

    Event that triggered the selection, if any.

sendRequest

(
  • [query]
  • [requestTemplate]
)
chainable

Sends a request to the configured source. If no source is configured, this method won't do anything.

Usually there's no reason to call this method manually; it will be called automatically when user input causes a query event to be fired. The only time you'll need to call this method manually is if you want to force a request to be sent when no user input has occurred.

Parameters:

  • [query] String optional

    Query to send. If specified, the query attribute will be set to this query. If not specified, the current value of the query attribute will be used.

  • [requestTemplate] Function optional

    Request template function. If not specified, the current value of the requestTemplate attribute will be used.

set

(
  • name
  • value
)
Object chainable

Sets the value of an attribute.

Parameters:

  • name String

    The name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g. set("x.y.z", 5)).

  • value Any

    The value to set the attribute to.

Returns:

Object: A reference to the host object.

setAttrs

(
  • attrs
)
Object chainable

Sets multiple attribute values.

Parameters:

  • attrs Object

    An object with attributes name/value pairs.

Returns:

Object: A reference to the host object.

show

() chainable

Shows the Widget by setting the "visible" attribute to "true".

subscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:334

Deprecated: use on

subscribe to an event

syncUI

() protected

Refreshes the rendered UI, based on Widget State

This method is not called by framework and is not chained automatically for the class hierarchy.

syncXY

()

Synchronizes the Panel's "xy", "x", and "y" properties with the Widget's position in the DOM.

toString

() String

Inherited from BaseCore but overwritten in widget/js/Widget.js:1105

Generic toString implementation for all widgets.

Returns:

String: The default string value for the widget [ displays the NAME of the instance, and the unique id ]

unsubscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:454

Deprecated: use detach

detach a listener

unsubscribeAll

(
  • type
)
deprecated

Inherited from EventTarget: event-custom/js/event-target.js:475

Deprecated: use detachAll

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String

    The type, or name of the event

Properties

_allowAdHocAttrs

Boolean protected

This property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash.

AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass.NONATTRS_CFG

Default: undefined (false)

_posAlignUIHandles

Array protected

Holds the alignment-syncing event handles.

Default: null

_UI_ATTRS

Object private

The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations

_YQL_SOURCE_REGEX

RegExp protected

Regular expression used to determine whether a String source is a YQL query.

BOUNDING_TEMPLATE

String

Property defining the markup template for bounding box.

CONTENT_TEMPLATE

String

Property defining the markup template for content box. If your Widget doesn't need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, and contentBox and boundingBox will both point to the same Node.

DEF_PARENT_NODE

String | Node

Default node to render the bounding box to. If not set, will default to the current document body.

DEF_UNIT

String

Default unit to use for dimension values

name

String deprecated

Inherited from BaseCore: base/js/BaseCore.js:197

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

UI_EVENTS

Object

Map of DOM events that should be fired as Custom Events by the
Widget instance.

Attributes

activateFirstItem

Boolean

If true, the first item in the list will be activated by default when the list is initially displayed and when results change.

Default: false

Fires event activateFirstItemChange

Fires when the value for the configuration attribute activateFirstItem is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

activeItem

Node

Item that's currently active, if any. When the user presses enter, this is the item that will be selected.

Fires event activeItemChange

Fires when the value for the configuration attribute activeItem is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

align

Object

The alignment configuration for this widget.

The align attribute is used to align a reference point on the widget, with the reference point on another Node, or the viewport. The object which align expects has the following properties:

  • node: The Node to which the widget is to be aligned. If set to null, or not provided, the widget is aligned to the viewport.

  • points: A two element Array, defining the two points on the widget and Node/viewport which are to be aligned. The first element is the point on the widget, and the second element is the point on the Node/viewport. Supported alignment points are defined as static properties on WidgetPositionAlign.

Default: null

Fires event alignChange

Fires when the value for the configuration attribute align is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

Example:

Aligns the top-right corner of the widget with the top-left corner of the viewport:

myWidget.set('align', {
    points: [Y.WidgetPositionAlign.TR, Y.WidgetPositionAlign.TL]
});

alignOn

Array

An Array of Objects corresponding to the Nodes and events that will cause the alignment of this widget to be synced to the DOM.

The alignOn Attribute is expected to be an Array of Objects with the following properties:

  • eventName: The String event name to listen for.

  • node: The optional Node that will fire the event, it can be a Node reference or a selector String. This will default to the widget's boundingBox.

Default: []

Fires event alignOnChange

Fires when the value for the configuration attribute alignOn is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

Example:

Sync this widget's alignment on window resize:

myWidget.set('alignOn', [
    {
        node     : Y.one('win'),
        eventName: 'resize'
    }
]);

allowBrowserAutocomplete

Boolean

Whether or not to enable the browser's built-in autocomplete functionality for input fields.

Default: false

Fires event allowBrowserAutocompleteChange

Fires when the value for the configuration attribute allowBrowserAutocomplete is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

allowTrailingDelimiter

Boolean

When a queryDelimiter is set, trailing delimiters will automatically be stripped from the input value by default when the input node loses focus. Set this to true to allow trailing delimiters.

Default: false

Fires event allowTrailingDelimiterChange

Fires when the value for the configuration attribute allowTrailingDelimiter is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

alwaysShowList

Boolean

If true, the list will remain visible even when there are no results to display.

Default: false

Fires event alwaysShowListChange

Fires when the value for the configuration attribute alwaysShowList is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

boundingBox

String | Node

The outermost DOM node for the Widget, used for sizing and positioning of a Widget as well as a containing element for any decorator elements used for skinning.

Fires event boundingBoxChange

Fires when the value for the configuration attribute boundingBox is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

centered

Boolean | Node

A convenience Attribute, which can be used as a shortcut for the align Attribute.

If set to true, the widget is centered in the viewport. If set to a Node reference or valid selector String, the widget will be centered within the Node. If set to false, no center positioning is applied.

Default: false

Fires event centeredChange

Fires when the value for the configuration attribute centered is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

circular

Boolean

If true, keyboard navigation will wrap around to the opposite end of the list when navigating past the first or last item.

Default: true

Fires event circularChange

Fires when the value for the configuration attribute circular is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

contentBox

String | Node

A DOM node that is a direct descendant of a Widget's bounding box that houses its content.

Fires event contentBoxChange

Fires when the value for the configuration attribute contentBox is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

destroyed

Boolean readonly

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

Fires event destroyedChange

Fires when the value for the configuration attribute destroyed is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

disabled

Boolean

Boolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.

Default: false

Fires event disabledChange

Fires when the value for the configuration attribute disabled is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

enableCache

Boolean

Inherited from AutoCompleteBase: autocomplete/js/autocomplete-base.js:997

Available since 3.5.0

Whether or not to enable in-memory caching in result sources that support it.

Default: true

Fires event enableCacheChange

Fires when the value for the configuration attribute enableCache is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

focused

Boolean readonly

Boolean indicating if the Widget, or one of its descendants, has focus.

Default: false

Fires event focusedChange

Fires when the value for the configuration attribute focused is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

height

String | Number

String with units, or number, representing the height of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.

Default: EMPTY_STR

Fires event heightChange

Fires when the value for the configuration attribute height is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

hoveredItem

Node | Null readonly

Item currently being hovered over by the mouse, if any.

Fires event hoveredItemChange

Fires when the value for the configuration attribute hoveredItem is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

id

String

Default: Generated using guid()

Fires event idChange

Fires when the value for the configuration attribute id is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

initialized

Boolean readonly

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

Fires event initializedChange

Fires when the value for the configuration attribute initialized is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

inputNode

Node | HTMLElement | String

Node to monitor for changes, which will generate query events when appropriate. May be either an <input> or a <textarea>.

Fires event inputNodeChange

Fires when the value for the configuration attribute inputNode is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

listNode

Node | Null

Node that will contain result items.

Fires event listNodeChange

Fires when the value for the configuration attribute listNode is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

locale

String deprecated

Inherited from Widget: widget/js/WidgetLocale.js:14

Deprecated: Use Y.config.lang and Y.Intl externalization support

The default locale for the widget. NOTE: Using get/set on the "strings" attribute will return/set strings for this locale.

Default: "en"

Fires event localeChange

Fires when the value for the configuration attribute locale is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

maxResults

Number

Maximum number of results to return. A value of 0 or less will allow an unlimited number of results.

Default: 0

Fires event maxResultsChange

Fires when the value for the configuration attribute maxResults is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

minQueryLength

Number

Minimum number of characters that must be entered before a query event will be fired. A value of 0 allows empty queries; a negative value will effectively disable all query events.

Default: 1

Fires event minQueryLengthChange

Fires when the value for the configuration attribute minQueryLength is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

query

String | Null readonly

Current query, or null if there is no current query.

The query might not be the same as the current value of the input node, both for timing reasons (due to queryDelay) and because when one or more queryDelimiter separators are in use, only the last portion of the delimited input string will be used as the query value.

Default: null

Fires event queryChange

Fires when the value for the configuration attribute query is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

queryDelay

Number

Number of milliseconds to delay after input before triggering a query event. If new input occurs before this delay is over, the previous input event will be ignored and a new delay will begin.

This can be useful both to throttle queries to a remote data source and to avoid distracting the user by showing them less relevant results before they've paused their typing.

Default: 100

Fires event queryDelayChange

Fires when the value for the configuration attribute queryDelay is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

queryDelimiter

String | Null

Query delimiter string. When a delimiter is configured, the input value will be split on the delimiter, and only the last portion will be used in autocomplete queries and updated when the query attribute is modified.

Default: null

Fires event queryDelimiterChange

Fires when the value for the configuration attribute queryDelimiter is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

render

Boolean | Node

Whether or not to render the widget automatically after init, and optionally, to which parent node.

Fires event renderChange

Fires when the value for the configuration attribute render is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

rendered

Boolean readonly

Flag indicating whether or not this Widget has been through the render lifecycle phase.

Default: false

Fires event renderedChange

Fires when the value for the configuration attribute rendered is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

requestTemplate

Function | String | Null

Source request template. This can be a function that accepts a query as a parameter and returns a request string, or it can be a string containing the placeholder "{query}", which will be replaced with the actual URI-encoded query. In either case, the resulting string will be appended to the request URL when the source attribute is set to a remote DataSource, JSONP URL, or XHR URL (it will not be appended to YQL URLs).

While requestTemplate may be set to either a function or a string, it will always be returned as a function that accepts a query argument and returns a string.

Default: null

Fires event requestTemplateChange

Fires when the value for the configuration attribute requestTemplate is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

resultFilters

Array

Array of local result filter functions. If provided, each filter will be called with two arguments when results are received: the query and an array of result objects. See the documentation for the results event for a list of the properties available on each result object.

Each filter is expected to return a filtered or modified version of the results array, which will then be passed on to subsequent filters, then the resultHighlighter function (if set), then the resultFormatter function (if set), and finally to subscribers to the results event.

If no source is set, result filters will not be called.

Prepackaged result filters provided by the autocomplete-filters and autocomplete-filters-accentfold modules can be used by specifying the filter name as a string, such as 'phraseMatch' (assuming the necessary filters module is loaded).

Default: []

Fires event resultFiltersChange

Fires when the value for the configuration attribute resultFilters is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

resultFormatter

Function | Null

Function which will be used to format results. If provided, this function will be called with two arguments after results have been received and filtered: the query and an array of result objects. The formatter is expected to return an array of HTML strings or Node instances containing the desired HTML for each result.

See the documentation for the results event for a list of the properties available on each result object.

If no source is set, the formatter will not be called.

Fires event resultFormatterChange

Fires when the value for the configuration attribute resultFormatter is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

resultHighlighter

Function | Null

Function which will be used to highlight results. If provided, this function will be called with two arguments after results have been received and filtered: the query and an array of filtered result objects. The highlighter is expected to return an array of highlighted result text in the form of HTML strings.

See the documentation for the results event for a list of the properties available on each result object.

If no source is set, the highlighter will not be called.

Fires event resultHighlighterChange

Fires when the value for the configuration attribute resultHighlighter is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

resultListLocator

Function | String | Null

Locator that should be used to extract an array of results from a non-array response.

By default, no locator is applied, and all responses are assumed to be arrays by default. If all responses are already arrays, you don't need to define a locator.

The locator may be either a function (which will receive the raw response as an argument and must return an array) or a string representing an object path, such as "foo.bar.baz" (which would return the value of result.foo.bar.baz if the response is an object).

While resultListLocator may be set to either a function or a string, it will always be returned as a function that accepts a response argument and returns an array.

Fires event resultListLocatorChange

Fires when the value for the configuration attribute resultListLocator is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

results

Array readonly

Current results, or an empty array if there are no results.

Default: []

Fires event resultsChange

Fires when the value for the configuration attribute results is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

resultTextLocator

Function | String | Null

Locator that should be used to extract a plain text string from a non-string result item. The resulting text value will typically be the value that ends up being inserted into an input field or textarea when the user of an autocomplete implementation selects a result.

By default, no locator is applied, and all results are assumed to be plain text strings. If all results are already plain text strings, you don't need to define a locator.

The locator may be either a function (which will receive the raw result as an argument and must return a string) or a string representing an object path, such as "foo.bar.baz" (which would return the value of result.foo.bar.baz if the result is an object).

While resultTextLocator may be set to either a function or a string, it will always be returned as a function that accepts a result argument and returns a string.

Fires event resultTextLocatorChange

Fires when the value for the configuration attribute resultTextLocator is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

scrollIntoView

Boolean

If true, the viewport will be scrolled to ensure that the active list item is visible when necessary.

Default: false

Fires event scrollIntoViewChange

Fires when the value for the configuration attribute scrollIntoView is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

source

Array | DataSource | Function | Node | Object | String | Null

Source for autocomplete results. The following source types are supported:

Array

The full array will be provided to any configured filters for each query. This is an easy way to create a fully client-side autocomplete implementation.

Example: ['first result', 'second result', 'etc']

DataSource
A DataSource instance or other object that provides a DataSource-like sendRequest method. See the DataSource documentation for details.
Function

A function source will be called with the current query and a callback function as parameters, and should either return an array of results (for synchronous operation) or return nothing and pass an array of results to the provided callback (for asynchronous operation).

Example (synchronous):

    function (query) {
        return ['foo', 'bar'];
    }
    

Example (async):

    function (query, callback) {
        callback(['foo', 'bar']);
    }
    
Object

An object will be treated as a query hashmap. If a property on the object matches the current query, the value of that property will be used as the response.

The response is assumed to be an array of results by default. If the response is not an array, provide a resultListLocator to process the response and return an array.

Example: {foo: ['foo result 1', 'foo result 2'], bar: ['bar result']}

If the optional autocomplete-sources module is loaded, then the following additional source types will be supported as well:

<select> Node
You may provide a YUI Node instance wrapping a <select> element, and the options in the list will be used as results. You will also need to specify a resultTextLocator of 'text' or 'value', depending on what you want to use as the text of the result. Each result will be an object with the following properties:
html (String)

HTML content of the <option> element.

index (Number)

Index of the <option> element in the list.

node (Y.Node)

Node instance referring to the original <option> element.

selected (Boolean)

Whether or not this item is currently selected in the <select> list.

text (String)

Text content of the <option> element.

value (String)

Value of the <option> element.

String (JSONP URL)

If a URL with a {callback} placeholder is provided, it will be used to make a JSONP request. The {query} placeholder will be replaced with the current query, and the {callback} placeholder will be replaced with an internally-generated JSONP callback name. Both placeholders must appear in the URL, or the request will fail. An optional {maxResults} placeholder may also be provided, and will be replaced with the value of the maxResults attribute (or 1000 if the maxResults attribute is 0 or less).

The response is assumed to be an array of results by default. If the response is not an array, provide a resultListLocator to process the response and return an array.

The jsonp module must be loaded in order for JSONP URL sources to work. If the jsonp module is not already loaded, it will be loaded on demand if possible.

Example: 'http://example.com/search?q={query}&callback={callback}'

String (XHR URL)

If a URL without a {callback} placeholder is provided, it will be used to make a same-origin XHR request. The {query} placeholder will be replaced with the current query. An optional {maxResults} placeholder may also be provided, and will be replaced with the value of the maxResults attribute (or 1000 if the maxResults attribute is 0 or less).

The response is assumed to be a JSON array of results by default. If the response is a JSON object and not an array, provide a resultListLocator to process the response and return an array. If the response is in some form other than JSON, you will need to use a custom DataSource instance as the source.

The io-base and json-parse modules must be loaded in order for XHR URL sources to work. If these modules are not already loaded, they will be loaded on demand if possible.

Example: 'http://example.com/search?q={query}'

String (YQL query)

If a YQL query is provided, it will be used to make a YQL request. The {query} placeholder will be replaced with the current autocomplete query. This placeholder must appear in the YQL query, or the request will fail. An optional {maxResults} placeholder may also be provided, and will be replaced with the value of the maxResults attribute (or 1000 if the maxResults attribute is 0 or less).

The yql module must be loaded in order for YQL sources to work. If the yql module is not already loaded, it will be loaded on demand if possible.

Example: 'select * from search.suggest where query="{query}"'

As an alternative to providing a source, you could simply listen for query events and handle them any way you see fit. Providing a source is optional, but will usually be simpler.

Fires event sourceChange

Fires when the value for the configuration attribute source is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

sourceType

String

May be used to force a specific source type, overriding the automatic source type detection. It should almost never be necessary to do this, but as they taught us in the Boy Scouts, one should always be prepared, so it's here if you need it. Be warned that if you set this attribute and something breaks, it's your own fault.

Supported sourceType values are: 'array', 'datasource', 'function', and 'object'.

If the autocomplete-sources module is loaded, the following additional source types are supported: 'io', 'jsonp', 'select', 'string', 'yql'

Fires event sourceTypeChange

Fires when the value for the configuration attribute sourceType is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

srcNode

String | Node

The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition

Fires event srcNodeChange

Fires when the value for the configuration attribute srcNode is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

strings

Object

Inherited from Widget but overwritten in autocomplete/js/autocomplete-list.js:847

Translatable strings used by the AutoCompleteList widget.

Fires event stringsChange

Fires when the value for the configuration attribute strings is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

tabIndex

Number

Number (between -32767 to 32767) indicating the widget's position in the default tab flow. The value is used to set the "tabIndex" attribute on the widget's bounding box. Negative values allow the widget to receive DOM focus programmatically (by calling the focus method), while being removed from the default tab flow. A value of null removes the "tabIndex" attribute from the widget's bounding box.

Default: null

Fires event tabIndexChange

Fires when the value for the configuration attribute tabIndex is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

tabSelect

Boolean

If true, pressing the tab key while the list is visible will select the active item, if any.

Default: true

Fires event tabSelectChange

Fires when the value for the configuration attribute tabSelect is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

tokenInput

Plugin.TokenInput readonly

If the inputNode specified at instantiation time has a node-tokeninput plugin attached to it, this attribute will be a reference to the Y.Plugin.TokenInput instance.

Fires event tokenInputChange

Fires when the value for the configuration attribute tokenInput is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

value

String

Current value of the input node.

Default: ''

Fires event valueChange

Fires when the value for the configuration attribute value is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

visible

Boolean

Boolean indicating whether or not the Widget is visible.

Default: TRUE

Fires event visibleChange

Fires when the value for the configuration attribute visible is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

width

String | Number

String with units, or number, representing the width of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.

Default: EMPTY_STR

Fires event widthChange

Fires when the value for the configuration attribute width is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

x

Number

Page X co-ordinate for the widget. This attribute acts as a facade for the xy attribute. Changes in position can be monitored by listening for xyChange events.

Default: 0

Fires event xChange

Fires when the value for the configuration attribute x is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

xy

Array

Page XY co-ordinate pair for the widget.

Default: [0,0]

Fires event xyChange

Fires when the value for the configuration attribute xy is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

y

Number

Page Y co-ordinate for the widget. This attribute acts as a facade for the xy attribute. Changes in position can be monitored by listening for xyChange events.

Default: 0

Fires event yChange

Fires when the value for the configuration attribute y is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

yqlEnv

String

YQL environment file URL to load when the source is set to a YQL query. Set this to null to use the default Open Data Tables environment file (http://datatables.org/alltables.env).

Default: null

Fires event yqlEnvChange

Fires when the value for the configuration attribute yqlEnv is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

yqlProtocol

String

URL protocol to use when the source is set to a YQL query.

Default: 'http'

Fires event yqlProtocolChange

Fires when the value for the configuration attribute yqlProtocol is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

Events

clear

Fires after the query has been completely cleared or no longer meets the minimum query length requirement.

Event Payload:

  • prevVal String

    Value of the query before it was cleared.

  • src String

    Source of the event.

destroy

Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.

Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).

Event Payload:

init

Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.

Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).

Event Payload:

  • e EventFacade

    Event object, with a cfg property which refers to the configuration object passed to the constructor.

query

Fires when the contents of the input field have changed and the input value meets the criteria necessary to generate an autocomplete query.

Event Payload:

  • inputValue String

    Full contents of the text input field or textarea that generated the query.

  • query String

    AutoComplete query. This is the string that will be used to request completion results. It may or may not be the same as inputValue.

  • src String

    Source of the event.

results

Fires after query results are received from the source. If no source has been set, this event will not fire.

Event Payload:

  • data Array | Object

    Raw, unfiltered result data (if available).

  • query String

    Query that generated these results.

  • results Object[]

    Array of filtered, formatted, and highlighted results. Each item in the array is an object with the following properties:

    • display Node | HTMLElement | String

      Formatted result HTML suitable for display to the user. If no custom formatter is set, this will be an HTML-escaped version of the string in the text property.

    • [highlighted] String optional

      Highlighted (but not formatted) result text. This property will only be set if a highlighter is in use.

    • raw Any

      Raw, unformatted result in whatever form it was provided by the source.

    • text String

      Plain text version of the result, suitable for being inserted into the value of a text input field or textarea when the result is selected by a user. This value is not HTML-escaped and should not be inserted into the page using innerHTML or Node#setContent().

select

Fires when an autocomplete suggestion is selected from the list, typically via a keyboard action or mouse click.

Event Payload:

  • itemNode Node

    List item node that was selected.

  • result Object

    AutoComplete result object.

widget:contentUpdate

Notification event, which widget implementations can fire, when they change the content of the widget. This event has no default behavior and cannot be prevented, so the "on" or "after" moments are effectively equivalent (with on listeners being invoked before after listeners).

Event Payload:

widget:render

Lifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method).

Subscribers to the "on" moment of this event, will be notified before the widget is rendered.

Subscribers to the "after" moment of this event, will be notified after rendering is complete.

Event Payload: