This repository has been archived by the owner on Dec 30, 2022. It is now read-only.
fix(localizecount): allow localized string for count in MenuSelect #657
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview ready! Built with commit e1890a6 |
Haroenv
approved these changes
Nov 27, 2017
| @@ -27,6 +27,12 @@ import MenuSelectComponent from '../components/MenuSelect.js'; | |||
| * > | |||
| * <MenuSelect | |||
| * attributeName="category" | |||
| * transformItems={items => | |||
| * items.map(item => { | |||
| * item.count = (item.count + 1000).toLocaleString(); | |||
There was a problem hiding this comment.
I'm not sure if this documentation is needed, it might be confusing why you're adding 1000
There was a problem hiding this comment.
Agree with @Haroenv, the examples in the documentation try to be the most minimal possible. For more elaborate example we have Storybook. No need to demonstrate the usage of transform Items on the documentation page.
There was a problem hiding this comment.
Thanks for the input. I'll remove it and push the commit.
samouss
reviewed
Nov 27, 2017
stories/MenuSelect.stories.js
Outdated
| defaultRefinement={text('defaultSelectedItem', 'Bathroom')} | ||
| transformItems={items => | ||
| items.map(item => { | ||
| item.count = (item.count + 1000).toLocaleString(); |
There was a problem hiding this comment.
Avoid to modify an object inside a map, try to always return a new object. Prefer something like:
items.map(({ count, ...item }) => ({
...item,
count: count.toLocaleString()
}));There was a problem hiding this comment.
Will update the PR. Thanks.
samouss
approved these changes
Nov 27, 2017
Haroenv
approved these changes
Nov 27, 2017
samouss
added a commit
that referenced
this pull request
Nov 27, 2017
<a name="4.3.0-beta.0"></a> # [4.3.0-beta.0](v4.2.0...v4.3.0-beta.0) (2017-11-27) ### Bug Fixes * **babelrc:** add a key for each env development, production, es ([#547](#547)) ([fa9528d](fa9528d)) * **localizecount:** allow localized string for count in MenuSelect ([#657](#657)) ([67ebd34](67ebd34)) * **react-router-example:** Properly update search query when using browser navigation ([#604](#604)) ([9ee6600](9ee6600)) ### Features * **refreshcache:** add prop refresh to InstantSearch instance ([#619](#619)) ([19f6de0](19f6de0))
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
MenuSelect prop-types only allow for type
numberforitem.count. This makes it impossible totransformItemsin the widget so that the count is localized, because.toLocaleString()returns a string which causes prop validation to fail.Result
packages/react-instantsearch/src/components/MenuSelect.js
Changed MenuSelect
items>item.countprop-type to accept string as well as number usingPropTypes.oneOfType([...]).Require-chaining w/
oneOfTypekeeps the prop mandatory regardless of type. See prop-types docs.stories/MenuSelect.stories.js
Added
with localized countMenuSelect story to Storybook to demonstrate concept.packages/react-instantsearch/src/widgets/MenuSelect.js
Added localize count
transformItemsdemonstration to MenuSelect @example docs.