HISTORY.md revision 3b176d01148442acf4e41c28739a6d8acbf6d32b
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan GroveAutoComplete Change History
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove===========================
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove3.4.1
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove-----
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove * The "combobox" ARIA role is no longer automatically added to an
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove AutoCompleteList input node. After consulting with the Y! Accessibility
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove team, we felt that the combobox role doesn't accurately represent the
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove out-of-the-box interactions that AutoCompleteList provides. Implementers can
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove still apply this role (or any other ARIA role) to the input node manually if
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove desired.
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove * Removed the ARIA live region that announced when suggestions were available.
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove The `aria-autocomplete` attribute and other attributes in use on the
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove AutoCompleteList widget already convey this information, so the live region
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove was essentially redundant.
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove
3b176d01148442acf4e41c28739a6d8acbf6d32bRyan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove3.4.0
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove-----
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Added the ability to use a `<select>` node as a result source.
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Function sources may now be either asynchronous or synchronous. Returning
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove an array of results from a function source will cause it to be treated as
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove synchronous (same as in 3.3.0). For async operation, don't return anything,
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove and pass an array of results to the provided callback function when the
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove results become available. [Ticket #2529974]
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Added a `sourceType` attribute to `AutoCompleteBase`, which may be used to
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove force a specific source type, overriding the automatic source type
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove detection. [Ticket #2529974]
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
9d22c51f3040a96aae2a15ba6511d2581be5b507Ryan Grove * The `scrollIntoView` config option is now much smarter. It will only scroll
9d22c51f3040a96aae2a15ba6511d2581be5b507Ryan Grove if the selected result isn't fully visible. If the result is already
9d22c51f3040a96aae2a15ba6511d2581be5b507Ryan Grove entirely within the visible area of the viewport, no scrolling will occur.
9d22c51f3040a96aae2a15ba6511d2581be5b507Ryan Grove
a8f7df1dd010d9710700d23416df1df8a3fb9604Ryan Grove * A pre-existing `listNode` may now be specified at initialization time.
a8f7df1dd010d9710700d23416df1df8a3fb9604Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Added `subWordMatch` filters and highlighters. [Contributed by Tobias
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove Schultze]
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
c8f9282d0b684a40b32109c3de35b7fa6c534699Ryan Grove * The `this` object now refers to the current AutoComplete instance instead of
4397b5a5bcaf8a291905306dbcc7f2b0fd2e60eeRyan Grove the window in list locators, text locators, filters, formatters,
4397b5a5bcaf8a291905306dbcc7f2b0fd2e60eeRyan Grove highlighters, and requestTemplate functions.
c8f9282d0b684a40b32109c3de35b7fa6c534699Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Added an `originEvent` property to the event facade of `select` events. It
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove contains an event facade of the DOM event that triggered the selection if
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove the selection was triggered by a DOM event.
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
61f745880910a23ddd00c0c637ec5c2d086b2020Ryan Grove * Small performance improvement for filters operating on empty query strings.
61f745880910a23ddd00c0c637ec5c2d086b2020Ryan Grove [Ticket #2529949]
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Result list alignment is now updated both when results change and when
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove the window is resized instead of only when the list becomes visible. This
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove makes right-aligned lists with dynamic widths less awkward.
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Fixed a bug that prevented CSS-based z-index values from taking effect on
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove the AutoComplete list and required the z-index to be set via JS. The
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove `.yui3-aclist` class now provides a default z-index of 1, and this can be
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove overridden with custom CSS. Specifying a `zIndex` attribute value via JS
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove no longer has any effect.
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Fixed a bug that caused the IE6 iframe shim under the AutoComplete list to
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove be sized incorrectly the first time the list was displayed.
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Fixed a bug in which the `requestTemplate` would sometimes be used as the
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove query instead of being appended to the source URL. This affected XHR and
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove JSONP sources that used both a `{query}` placeholder in the source string
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove and a custom `requestTemplate` value. [Ticket #2529895]
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
4397b5a5bcaf8a291905306dbcc7f2b0fd2e60eeRyan Grove * Fixed a bug that caused the `requestTemplate` function to be called twice
4397b5a5bcaf8a291905306dbcc7f2b0fd2e60eeRyan Grove for an XHR request instead of just once.
4397b5a5bcaf8a291905306dbcc7f2b0fd2e60eeRyan Grove
a78f013cfc225b57730e82e15135c71d55857355Ryan Grove * Fixed a bug in which JSONP, XHR, and YQL requests were cached solely based
a78f013cfc225b57730e82e15135c71d55857355Ryan Grove on the query rather than on the complete request. This could result in
a78f013cfc225b57730e82e15135c71d55857355Ryan Grove cache collisions when two requests with the same query but different
a78f013cfc225b57730e82e15135c71d55857355Ryan Grove parameters (provided by a requestTemplate) were made. [Ticket #2530410]
a78f013cfc225b57730e82e15135c71d55857355Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Fixed a bug that caused the `&` character to be treated as an up arrow
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove key in Firefox. [Ticket #2530455]
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Removed the "beta" label. Hooray!
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove3.3.0
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove-----
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove
ea53cbf2a35b654a03cf6bc52b0b1fa849d5fc86Ryan Grove * Initial release.