HISTORY.md

React-Select

v1.0.0-rc / 2016-09-04

• fixed; reset value to [] when multi=true, thanks Michael Williamson
• added; pass index to renderLabel method, thanks nhducit
• fixed; uncontrolled to controlled component warning in React 15.3
• fixed; props cleanup, thanks Forbes Lindesay
• fixed; issue where a value of the number 0 would be assumed to be no value, thanks Hanwen Cheng
• fixed; internal refs converted to callbacks instead of strings, thanks Johnny Nguyen
• added; optional instanceId prop for server-side rendering, thanks Jevin Anderson
• added; onCloseResetsInput prop, thanks Frankie
• added; Creatable component, replaces pre-1.0 allowCreate prop, thanks Brian Vaughn

v1.0.0-beta14 / 2016-07-17

• fixed; react-input-autosize has been udpated to 1.1.0, which includes fixes for the new warnings that React 15.2 logs
• fixed; "Unknown prop inputClassName on
  tag" warning, thanks Max Stoiber
• fixed; Removed unnecessary onUnfocus, thanks Johnny Nguyen
• added; Support for react components in searchPromptText, thanks Matt
• fixed; focus bug on iOS, thanks Tony deCatanzaro
• fixed; Async bugs with Promises, thanks Vladimir and Ian Firkin
• fixed; searchingText bug, thanks Tony deCatanzaro
• improved; More antive-like input behaviour, thanks Johnny Nguyen
• fixed; Added missing unit (px) to minWidth attribute, thanks Ian Witherow
• added; Support for assistive technologies, thanks Dave Brotherstone
• fixed; React error if onChange callback causes a root component to unmount, thanks Nathan Norton
• fixed; Open menu is now closed if disabled becomes true, thanks Jason Moon
• fixed; Prevent getFocusableOptionIndex from returning a disabled option, thanks Brian Powers
• added; Home, End, Page Up/Down support, thanks Jason Kadrmas
• fixed; Don't render backspaceToRemoveMessage if backspaceRemoves is set to false, thanks Ryan Zec
• fixed; Issue with an outline appearing on the auto sized input, thanks Ryan Zec
• fixed; Events don't propagate when esc is pressed, thanks Yoshihide Jimbo
• fixed; Update required prop based on nextProps on update, thanks Matt Shwery
• fixed; On focus check whether input ref is a real input or an input component, thanks Peter Brant and Greg Poole

Also a big thanks to Brian Vaughn for his help triaging issues for this release!

v1.0.0-beta13 / 2016-05-30

• added; inputRenderer prop, allows you to override the input component, thanks Sean Burke
• added; openOnFocus prop, causes the menu to always open when the select control is focused, thanks HuysentruytRuben
• added; react-virtualised-select HOC example, thanks Brian Vaughn
• added; tabSelectsValue prop can be set to false to prevent selection of focused option when tab is pressed, thanks Byron Anderson
• added; ability to override resetValue when clearing the control, thanks Alexander Luberg
• added; input can be updated with onInputChange, thanks Brett DeWoody
• added; Styles for .is-selected class, thanks Danny Herran
• fixed; noResultsText prop type is now stringOrNode for Async component, thanks Michael Groeneman
• fixed; onInputChange is wrapped by Async component, thanks Eric O'Connell
• fixed; scrollMenuIntoView behaviour in IE10, thanks Ivan Jager
• fixed; isEqualNode replaced with strict equality check, thanks Alexandre Balhier
• fixed; issue with value object not being passed to handleRequired, thanks Andrew Hite
• fixed; the menu-outer container is no longer rendered when it does not contain anything, thanks Kuan
• improved; better support for IE8 in styles, thanks Rockallite Wulf

v1.0.0-beta12 / 2016-04-02

• added; menuRenderer method and example for effeciently rendering thousands of options, thanks Brian Vaughn
• added; optionClassName prop, thanks Max Tyler

v1.0.0-beta11 / 2016-03-09

• updated dependencies to allow use with React 15.x
• changed; multiple selected values are now submitted using multiple inputs, thanks Trinh Hoang Nhu
• added; joinValues prop to revert the above change and submit multiple values in a single field with the delimiter

v1.0.0-beta10 / 2016-02-23

• fixed build issues with v1.0.0-beta9

v1.0.0-beta9 / 2016-02-12

• added; onBlurResetsInput prop, thanks Sly Bridges
• changed; Enter selects and retains focus, Tab selects and shifts focus, thanks RDX
• fixed; Hide noResultsText when value is falsy, thanks Fernando Alex Helwanger
• added; required prop, adds HTML5 required attribute, thanks Domenico Matteo
• fixed; Touch drag behaviour, thanks Pavel Tarnopolsky
• added; onOpen and onClose event props, thanks Jacob Page
• fixed; Pressing Enter on open Select should stop propagation, thanks Jeremy Liberman
• fixed; Missing handleMouseDownOnMenu, thanks Jeremy Liberman
• added; Ensures the selected option is immediately visible when the menu is open, thanks Martin Jujou
• added; autoBlur prop, blurs the input when a value is selected, thanks Pavel Tarnopolsky
• fixed; Several isFocused checks weren't working properly

v1.0.0-beta8 / 2015-12-20

• fixed; input focus bug when toggling disabled prop, thanks Davide Curletti
• fixed; focus() is now exposed on the Async component, thanks AugustinLF

v1.0.0-beta7 / 2015-12-15

• You can now use React elements for placeholders and the text props, thanks kromit and Alyssa Biasi
• Fixed a problem where the border doesn't show when the element is inside a table, thanks Rodrigo Boratto
• New prop scrollMenuIntoView scrolls the viewport to display the menu, thanks Alexander Zaharakis
• New LESS / SCSS variable select-option-bg lets you control the menu option background color, thanks Evan Goldenberg
• Fixed an error in the blur handler on IE when the menu is not visible, thanks Gaston Sanchez
• Added support for a clearableValue option property in multi mode, thanks Sly Bridges

v1.0.0-beta6 / 2015-11-29

• Test suite complete and passing, with a couple of minor fixes thanks to @bruderstein

v1.0.0-beta5 / 2015-11-08

• Fixes issues relating to serializing simple values into the hidden field

v1.0.0-beta4 / 2015-11-08

• New default styles that match Elemental UI and look right at home in the new KeystoneJS Admin UI

We're potentially going to ship some theme stylesheets in the future, shout out on GitHub if this interests you.

v1.0.0-beta3 / 2015-11-08

• The selected value populated in the hidden field has been fixed (was "[object Object]" before)
• Added new autofocus prop
• Fixed duplicate key error for options and values with duplicate value properties
• SCSS variables now have !default so you can override them

v1.0.0-beta2 / 2015-11-06

Changed since beta 1:

• Async options cache works again
• New style props for custom styling the component without modifying css classes: style wrapperStyle menuStyle menuContainerStyle
• The menu opens and closes correctly when searchable={false}, there is still some work to do on this use-case

v1.0.0-beta1 / 2015-11-06

This is a complete rewrite. Major changes include:

• Everything is simpler (I'm nearly done and the source code is only 60% of the size of the last version)
• No more timeouts or weird handlers, the restructuring has let me make everything more straight-forward
• The options array is no longer preprocessed into state, just retrieved from props
• The values array is now initialised in the Options array during render, and not stored in state, which along with the change to options makes the component more reliable and fixes issues with props not updating correctly
• The component no longer stores its own value in state (ever) - it needs to be passed as a prop and handled with onChange.
• Complex values are now enabled by default (so you're passed the option object, not its value); you can enable the legacy mode with a prop
• The Value and Option components have been cleaned up as well for consistency
• The hidden <input> field is now optional and the component is better suited to use in a rich React.js app than it was
• You can disable options filtering to do the filtering externally with onInputChange
• Accents on characters can now be ignored
• The asyncOptions prop has been replaced by a new wrapper component: Select.Async

Note that "Tag mode" (creating options on the fly) isn't reimplemented yet.

A full guide to the breaking changes and new features will be written up soon. In the meantime please see the new examples.

v0.9.1 / 2015-11-01

• added; new Contributors example w/ async options loading and custom value / label keys
• fixed; several issues with custom valueKey and labelKey props
• fixed; autoload now loads options with no search input

v0.9.0 / 2015-10-29

• added; SCSS stylesheets!
• improved; Options rendering should be more performant
• breaking change; Custom Option components now need to pass their option prop to event handlers; see this commit for an example of the required change.

v0.8.4 / 2015-10-27

• fixed; LESS math operations now work with --strict-math=on, thanks Vincent Fretin

v0.8.3 / 2015-10-27

• fixed; IE issue where clicking the scrollbar would close the menu, thanks Pete Nykänen

v0.8.2 / 2015-10-22

• added; Promise support for loadAsyncOptions, thanks Domenico Matteo

v0.8.1 / 2015-10-20

• fixed; loadAsyncOptions raises TypeError in setup, see #439 for details, thanks Pancham Mehrunkar

v0.8.0 / 2015-10-19

This release contains significant DOM structure and CSS improvements by @jossmac, including:

• no more position: absolute for inner controls
• display: table is used for layout, which works in IE8 and above, and all other modern browsers
• less "magic numbers" used for layout, should fix various browser-specific alignment issues
• clear "x" control now animates in
• clearer .Select--multi className replaces .Select.is-multi
• new height & theme variables
• "dropdown" indicator chevron is no longer displayed for multi-select controls

There are no functional changes, but if you've forked the LESS / CSS to create your own theme you'll want to pay close attention to PR #527 when upgrading to this version.

v0.7.0 / 2015-10-10

React Select is updated for React 0.14. If you're still using React 0.13, please continue to use react-select@0.6.x. There are no functional differences between v0.7.0 and v0.6.12.

Additionally, our tests now require Node.js 4.x. If you are developing react-select, please make sure you are running the latest version of node.

Thanks to @bruderstein, @dmatteo and @hull for their help getting these updates shipped!

v0.6.12 / 2015-10-02

• added; labelKey and valueKey props, so you can now use different keys in option objects for the label and value
• fixed; additional isMounted() checks in timeouts
• fixed; componentDidUpdate timeout is reset correctly, see #208 and #434, thanks Petr Gladkikh
• fixed; mousedown event on scrollbar in menu no longer hides it, thanks Yishai Burt

v0.6.11 / 2015-09-28

• added; isLoading prop, allows indication of async options loading in situations where more control is required, thanks Jon Gautsch

v0.6.10 / 2015-09-24

• fixed; a build issue with the previous release that prevented the stylesheet being generated / included
• fixed; a LESS syntax issue, thanks Bob Cardenas

v0.6.9 / 2015-09-19

• added; style key for package.json, thanks Stephen Wan
• added; onInputChange handler that returns the current input value, thanks Tom Leslie
• fixed; simplifying handleKey function & preventDefault behaviour, thanks davidpene
• fixed; Display spinner while auto-loading initial data, thanks Ben Jenkinson
• fixed; better support for touch events, thanks Montlouis-Calixte Stéphane
• fixed; prevent value splitting on non-multi-value select, thanks Alan R. Soares

v0.6.8 / 2015-09-16

• fixed; broader range of allowed prereleases for React 0.14, including rc1
• fixed; preventing backspace from navigating back in the browser history, thanks davidpene

v0.6.7 / 2015-08-28

• fixed; missing styles for .Select-search-prompt and .Select-searching issues, thanks Jaak Erisalu and davidpene

v0.6.6 / 2015-08-26

• fixed; issue in Chrome where clicking the scrollbar would close the menu, thanks Vladimir Matsola

v0.6.5 / 2015-08-24

• fixed; completely ignores clicks on disabled items, unless the target of the click is a link, thanks Ben Stahl

v0.6.4 / 2015-08-24

This release includes a huge improvement to the examples / website thanks to @jossmac. Also:

• added; support for React 0.14 beta3
• fixed; disabled options after searching, thanks @bruderstein
• added; support for "Searching..." text (w/ prop) while loading async results, thanks @bruderstein and @johnomalley
• added; className, style and title keys are now supported in option properties, thanks @bruderstein

v0.6.3 / 2015-08-18

Otherwise known as "the real 0.6.2" this includes the updated build for the last version; sorry about that!

v0.6.2 / 2015-08-13

• changed; if the searchable prop is false, the menu is opened or closed on click, more like a standard Select input. thanks MaaikeB

v0.6.1 / 2015-08-09

• added; Support for options with numeric values, thanks Dave Brotherstone
• changed; Disabled options now appear in the search results
, thanks Dave Brotherstone
• fixed; asyncOptions are reloaded on componentWillReceiveProps when the value has changed, thanks Francis Cote
• added; cacheAsyncResults prop (default true) now controls whether the internal cache is used for asyncOptions

v0.6.0 / 2015-08-05

• improved; option, value and single value have been split out into their own components, and can be customised with props. see #328 for more details.
• improved; Near-complete test coverage thanks to the awesome work of Dave Brotherstone
• improved; Support all alpha/beta/rc's of React 0.14.0, thanks Sébastien Lorber
• fixed; Close multi-select menu when tabbing away, thanks Ben Alpert
• fixed; Bug where Select shows the value instead of the label (reapplying fix)
• fixed; valueRenderer now works when multi={false}, thanks Chris Portela
• added; New property backspaceRemoves (default true), allows the default behaviour of removing values with backspace when multi={true}, thanks Leo Lehikoinen

v0.5.6 / 2015-07-27

• fixed; Allow entering of commas when allowCreate is on but multi is off, thanks Angelo DiNardi
• fixed; Times (clear) character is now rendered from string unicode character for consistent output, thanks Nibbles
• fixed; allowCreate bug, thanks goodzsq
• fixed; changes to props.placeholder weren't being reflected correctly, thanks alesn
• fixed; error when escape is pressedn where clearValue was not passed the event, thanks Mikhail Kotelnikov
• added; More tests, thanks Dave Brotherstone

v0.5.5 / 2015-07-12

• fixed; replaced usage of component.getDOMNode() with React.findDOMNode(component) for compatibility with React 0.14

v0.5.4 / 2015-07-06

• fixed; regression in 0.5.3 that broke componentWillMount, sorry everyone!
• added; addLabelText prop for customising the "add {label}?" text when in tags mode, thanks Fenn

v0.5.3 / 2015-07-05

• fixed; autoload issues, thanks Maxime Tyler
• fixed; style incompatibilities with Foundation framework, thanks Timothy Kempf

v0.5.2 / 2015-06-28

• fixed; bug where Select shows the value instead of the label, thanks Stephen Demjanenko
• added; 'is-selected' classname is added to the selected option, thanks Alexey Volodkin
• fixed; async options are now loaded with the initial value, thanks Pokai Chang
• fixed; react-input-autosize now correctly escapes ampersands (&), not actually a fix in react-select but worth noting here because it would have been causing a problem in react-select as well.

v0.5.1 / 2015-06-21

• added; custom option and value rendering capability, thanks Brian Reavis
• fixed; collapsing issue when single-select or empty multi-select fields are disabled
• fixed; issue where an empty value would be left after clearing all values in a multi-select field

v0.5.0 / 2015-06-20

• fixed; esc key incorrectly created empty options, thanks rgrzelak
• adeed; New feature to allow option creation ("tags mode"), enable with allowCreate prop, thanks Florent Vilmart and Brian Reavis
• fixed; IE8 compatibility fallback for addEventListener/removeEventListener, which don't exist in IE8, thanks Stefan Billiet
• fixed; Undefined values when using asyncOptions, thanks bannaN
• fixed; Prevent add the last focused value when the drop down menu is closed / Pushing enter without dropdown open adds a value, thanks Giuseppe
• fixed; Callback context is undefined, thanks Giuseppe
• fixed; Issue with event being swallowed on Enter keydown, thanks Kevin Burke
• added; Support for case-insensitive filtering when matchPos="start", thanks wesrage
• added; Support for customizable background color, thanks John Morales
• fixed; Updated ESLint and cleared up warnings, thanks Alexander Shemetovsky
• fixed; Close dropdown when clicking on select, thanks Nik Butenko
• added; Tests, and mocha test framework, thanks Craig Dallimore
• fixed; You can now start the example server and watch for changes with npm start

v0.4.9 / 2015-05-11

• fixed; focus was being grabbed by the select when autoload and asyncOptions were set
• added; focus method on the component
• added; support for disabled options, thanks Pasha Palangpour
• improved; more closures, less binds, for better performance, thanks Daniel Cousens

v0.4.8 / 2015-05-02

• fixed; restored dist/default.css
• fixed; standalone example works again
• fixed; clarified dependency documentation and added dependencies for Bower
• fixed; Scoping issues in _bindCloseMenuIfClickedOutside, thanks bannaN
• fixed; Doesnt try to set focus afterupdate if component is disabled, thanks bannaN

v0.4.7 / 2015-04-21

• improved; lodash is no longer a dependency, thanks Daniel Lo Nigro

v0.4.6 / 2015-04-06

• updated; dependencies, build process and input-autosize component

v0.4.5 / 2015-03-28

• fixed; issue with long options overlapping arrow and clear icons, thanks Rohit Kalkur

v0.4.4 / 2015-03-26

• fixed; error handling click events when the menu is closed, thanks Ilya Petrov
• fixed; issue where options will not be filtered in certain conditions, thanks G. Kay Lee

v0.4.3 / 2015-03-25

• added tests and updated dependencies

v0.4.2 / 2015-03-23

• added; ESLint and contributing guide
• fixed; incorrect classnames variable assignment in window scope
• fixed; all ESLint errors and warnings (except invalid JSX undefined/unused vars due to ESLint bug)
• fixed; first option is now focused correctly, thanks Eivind Siqveland Larsen

v0.4.1 / 2015-03-20

• fixed; IE11 issue: clicking on scrollbar within menu no longer closes menu, thanks Rohit Kalkur

v0.4.0 / 2015-03-12

• updated; compatible with React 0.13

v0.3.5 / 2015-03-09

• improved; less/no repaint on scroll for performance wins, thanks jsmunich
• added; onBlur and onFocus event handlers, thanks Jonas Budelmann
• added; support for inputProps prop, passed to the <input> component, thanks Yann Plantevin
• changed; now using react-component-gulp-tasks for build
• fixed; issue w/ remote callbacks overriding cached options, thanks Corey McMahon
• fixed; if not this.props.multi, menu doesn't need handleMouseDown, thanks wenbing

v0.3.4 / 2015-02-23

• fixed; issues with the underscore/lodash dependency change, thanks Aaron Powell

v0.3.3 / 2015-02-22

• added; disabled prop, thanks Danny Shaw
• added; searchable prop - set to false to disable the search box, thanks Julen Ruiz Aizpuru
• added; onOptionLabelClick prop - see #66 for docs, thanks Dmitry Smirnov
• fixed; text-overflow: ellipsis; typo, thanks Andru Vallance

v0.3.2 / 2015-01-30

• fixed; issue adding undefined values to multiselect, thanks Tejas Dinkar

v0.3.1 / 2015-01-20

• fixed; missing var statement

v0.3.0 / 2015-01-20

• added; node compatible build now available in /lib

v0.2.14 / 2015-01-07

• added; searchPromptText property that is displayed when asyncOptions is set and there are (a) no options loaded, and (b) no input entered to search on, thanks Anton Fedchenko
• added; clearable property (defaults to true) to control whether the "clear" control is available, thanks Anton Fedchenko

v0.2.13 / 2015-01-05

• fixed; height issues in Safari, thanks Joss Mackison
• added; Option to specify "Clear value" label as prop for i18n

v0.2.12 / 2015-01-04

• fixed; UI now responds to touch events, and works on mobile devices! thanks Fraser Xu

v0.2.11 / 2015-01-04

• fixed; Options in the dropdown now scroll into view when they are focused, thanks Adam
• improved; Example dist is now excluded from the npm package

v0.2.10 / 2015-01-01

• fixed; More specific mixin name to avoid conflicts (css)
• fixed; Example CSS now correctly rebuilds on changes in development
• fixed; Values are now expanded correctly when options change (see #28)
• added; Option to specify "No results found" label as prop for i18n, thanks Julen Ruiz Aizpuru

v0.2.9 / 2014-12-09

• added; filterOption and filterOptions props for more control over filtering

v0.2.8 / 2014-12-08

• added; matchPos option to control whether to match the start or any position in the string when filtering options (default: any)
• added; matchProp option to control whether to match the value, label or any property of each option when filtering (default: any)

v0.2.7 / 2014-12-01

• fixed; screen-readers will now read "clear value" instead of "times" for the clear button
• fixed; non-left-click mousedown events aren't blocked by the control

v0.2.6 / 2014-11-30

• improved; better comparison of changes to [options] in willReceiveProps
• fixed; now focuses the first option correctly when in multiselect mode
• fixed; fixed focused option behaviour on value change
• fixed; when filtering, there is always a focused option (#19)
• changed; using ^ in package.json to compare dependencies

v0.2.5 / 2014-11-20

• fixed; compatibility with case-sensitive file systems

v0.2.4 / 2014-11-20

• fixed; package.json pointed at the right file

v0.2.3 / 2014-11-17

• fixed; Updating state correctly when props change
• improved; Build tasks and docs
• added; Working standalone build
• added; Minified dist version
• added; Publised to Bower

v0.2.2 / 2014-11-15

• fixed; backspace event being incorrectly cancelled

v0.2.1 / 2014-11-15

• fixed; issue where backspace incorrectly clears the value (#14)

v0.2.0 / 2014-11-15

• changed; Major rewrite to improve focus handling and internal state management
• added; Support for multi prop, enable multiselect mode

v0.1.1 / 2014-11-03

• added; Support for onChange event
• added; propTypes are defined by the Select component now
• added; className property, sets the className on the outer div element
• fixed; Removed deprecated React.DOM.x calls

v0.1.0 / 2014-11-01

• updated; React to 0.12.0

v0.0.6 / 2014-10-14

• fixed; Error keeping value when using Async Options