Skip to content

[ADD] Clarified the onInputChange prop signature in the docs #1773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
agirton merged 2 commits into from
Jun 6, 2017
Merged

[ADD] Clarified the onInputChange prop signature in the docs #1773

agirton merged 2 commits into from
Jun 6, 2017

Conversation

@cbergmiller
Copy link
Contributor

@cbergmiller cbergmiller commented Jun 3, 2017

Updated docs on onInputChange as requested in #1760.

@coveralls
Copy link

coveralls commented Jun 3, 2017

Coverage Status

Coverage remained the same at 92.883% when pulling 479908b on cbergmiller:fix/#1760_update_docs_onInputChange into 1d15068 on JedWatson:master.

@agirton
Copy link
Collaborator

agirton commented Jun 3, 2017

Looks good! Thanks! Just a few nits then we can merge this in.

agirton
agirton requested changes Jun 3, 2017
View reviewed changes
README.md Outdated
| onCloseResetsInput | bool | true | whether to clear input when closing the menu through the arrow |
| onFocus | func | undefined | onFocus handler: `function(event) {}` |
| onInputChange | func | undefined | onInputChange handler: `function(inputValue) {}` |
| onInputChange | func | undefined | onInputChange handler/interceptor: `(inputValue: string) => string` |
Copy link
Collaborator

@agirton agirton Jun 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency I feel we shouldn't use arrow functions.

README.md Outdated

You can manipulate the input using the onInputChange and returning a new value.
You can manipulate the input by providing a `onInputChange` callback that returns a new value.
Please note: When you want to use `onInputChange` only to listen to the input updates, you still have to return the unchanged value!
Copy link
Collaborator

@agirton agirton Jun 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: think we should bold "Please note" to make it stand out a bit more?

@coveralls
Copy link

coveralls commented Jun 3, 2017

Coverage Status

Coverage increased (+0.09%) to 92.97% when pulling 9a5ef4a on cbergmiller:fix/#1760_update_docs_onInputChange into 1d15068 on JedWatson:master.

agirton
agirton approved these changes Jun 6, 2017
View reviewed changes
Copy link
Collaborator

@agirton agirton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@agirton agirton merged commit 07dc061 into JedWatson:master Jun 6, 2017
@cbergmiller cbergmiller deleted the fix/#1760_update_docs_onInputChange branch June 6, 2017 10:04
echenley pushed a commit to helpdotcom/react-select that referenced this pull request Jun 13, 2017
Squashed commit of the following:
86eb32c 
commit 07dc061
Author: cbergmiller <christian@bergmiller.de>
Date:   Tue Jun 6 07:04:20 2017 +0200

    [ADD] Clarified the onInputChange prop signature in the docs (JedWatson#1773)

    * [ADD] Clarified the onInputChange prop signature in the docs

    * [ADD] requested changes

commit 40db517
Author: cbergmiller <christian@bergmiller.de>
Date:   Sat Jun 3 15:53:45 2017 +0200

    [FIX] JedWatson#1651 moved option prop sync to componentWillReceiveProps (JedWatson#1765)

    * [FIX] JedWatson#1651 moved option prop sync to componentWillReceiveProps

    * [ADD] test for option prop sync by componentWillReceiveProps

commit 1d15068
Author: Jed Watson <jed.watson@me.com>
Date:   Thu May 25 00:25:19 2017 +1000

    v1.0.0-rc.5

commit e06ea57
Author: Jed Watson <jed.watson@me.com>
Date:   Thu May 25 00:25:09 2017 +1000

    Updating build

commit 7013005
Merge: 9943711 8239201
Author: Jed Watson <jed.watson@me.com>
Date:   Thu May 25 00:19:49 2017 +1000

    Merge pull request JedWatson#1738 from agirton/chore/HISTORY-update

    Update change log for rc5 release.

commit 8239201
Author: Adam Girton <adam.girton@me.com>
Date:   Sat May 20 10:37:18 2017 -0700

    Update changelog

commit 9943711
Author: Benjamin Piouffle <Betree@users.noreply.github.com>
Date:   Fri May 19 07:21:40 2017 +1100

    Fix selected option focus when valueKey is not "value" (JedWatson#1733)

    * Fix selected option focus when valueKey is not "value"

    * Revert "Fix selected option focus when valueKey is not "value""

    This reverts commit 45f5665.

    * Fix on src/ instead of lib/

commit 196c7bb
Author: Max Hubenthal <Max_Hubenthal@carmax.com>
Date:   Wed May 17 12:47:29 2017 -0400

    Fix aria owns value (JedWatson#1556)

commit fd19b91
Author: Simon Gaestel <simon.gaestel+git@gmail.com>
Date:   Wed May 17 18:22:34 2017 +0200

    Fix JedWatson#1394 (JedWatson#1395)

    * Fix JedWatson#1394

    * Updates following review

    * Updates following review by @JedWatson

commit 549d20a
Author: Jed Watson <jed.watson@me.com>
Date:   Mon May 15 00:00:05 2017 +1000

    v1.0.0-rc.4

commit 5269a85
Merge: af8f58d 75d6372
Author: Jed Watson <jed.watson@me.com>
Date:   Sun May 14 23:31:30 2017 +1000

    Merge pull request JedWatson#1652 from dan-diaz/isClearable

    Include a className of 'is-clearable' if clearable is true

commit af8f58d
Merge: 8ff4596 9150107
Author: Jed Watson <jed.watson@me.com>
Date:   Sun May 14 23:27:19 2017 +1000

    Merge pull request JedWatson#1659 from lagun4ik/master

    Added variables for shadow styles

commit 8ff4596
Merge: a0e5855 03b3da2
Author: Jed Watson <jed.watson@me.com>
Date:   Sun May 14 23:25:48 2017 +1000

    Merge pull request JedWatson#1658 from agirton/migrate-to-external-pkgs

    Migrate to prop-types and create-react-class packages

commit 03b3da2
Author: Adam Girton <adam.girton@me.com>
Date:   Sun Apr 30 20:41:54 2017 -0700

    Bumping create-react-class and prop-types

commit 387f241
Author: Adam Girton <adam.girton@me.com>
Date:   Sun Apr 30 20:35:55 2017 -0700

    Update react-input-autosize dep

commit 9150107
Author: lagun4ik <ivan@lagunovsky.com>
Date:   Mon Apr 10 21:55:48 2017 +0300

    added variables for shadow styles

commit d7d2a79
Author: Adam Girton <adam.girton@me.com>
Date:   Mon Apr 10 09:55:46 2017 -0700

    Move over examples to use new pkgs

commit feabc4d
Author: Adam Girton <adam.girton@me.com>
Date:   Mon Apr 10 09:55:17 2017 -0700

    Migrate rest of src overto createClass pkg

commit ace3e08
Author: Adam Girton <adam.girton@me.com>
Date:   Mon Apr 10 09:44:54 2017 -0700

    Migrate src over to creatClass package

commit 16ff8e9
Author: Adam Girton <adam.girton@me.com>
Date:   Mon Apr 10 09:38:37 2017 -0700

    Use new prop-types package

commit 75d6372
Author: DDiaz <daniel.diaz@isobar.com>
Date:   Thu Apr 6 10:39:10 2017 -0400

    spaces to tabs

commit c81b9c9
Author: DDiaz <daniel.diaz@isobar.com>
Date:   Thu Apr 6 10:37:15 2017 -0400

    Include a className of 'is-clearable' if clearable is true
ryanabooth pushed a commit to entelo/react-select that referenced this pull request Jun 29, 2017
Merge commit '26169305a721ec3099a912cea2f6ed38e6dc9c4c' into ryan/upd…
bcc482c 
…ate_and_add_creatable_options

* commit '26169305a721ec3099a912cea2f6ed38e6dc9c4c': (36 commits)
  Fix Usage Docs Example (JedWatson#1799)
  Hide create option after closing menu (JedWatson#1306)
  Update README.md to include 'valueComponent' prop (JedWatson#1803)
  Adding merged changes to changelog
  Fix backspace handling for non-multi select controls. Fixes JedWatson#638 (JedWatson#773)
  Update Select.js
  [ADD] Clarified the onInputChange prop signature in the docs (JedWatson#1773)
  [FIX] JedWatson#1651 moved option prop sync to componentWillReceiveProps (JedWatson#1765)
  v1.0.0-rc.5
  Updating build
  Update changelog
  Fix selected option focus when valueKey is not "value" (JedWatson#1733)
  Fix aria owns value (JedWatson#1556)
  Fix JedWatson#1394 (JedWatson#1395)
  v1.0.0-rc.4
  Bumping create-react-class and prop-types
  Update react-input-autosize dep
  added variables for shadow styles
  Move over examples to use new pkgs
  Migrate rest of src overto createClass pkg
  ...

# Conflicts:
#	dist/react-select.js
#	dist/react-select.min.js
#	examples/dist/bundle.js
#	examples/dist/standalone.js
#	lib/Async.js
#	lib/Value.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agirton agirton agirton approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@cbergmiller @coveralls @agirton