Skip to content
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.

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

[RFR] Add suggestionLimit prop to <AutocompleteArrayInput> #3326

Merged
merged 2 commits into from
Jun 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ If you need to override the props of the suggestions container (a `Popper` eleme
| `optionText` | Optional | <code>string &#124; Function</code> | `name` | Fieldname of record to display in the suggestion item or function which accepts the current record as argument (`(record)=> {string}`) |
| `setFilter` | Optional | `Function` | null | A callback to inform the `searchText` has changed and new `choices` can be retrieved based on this `searchText`. Signature `searchText => void`. This function is automatically setup when using `ReferenceInput`. |
| `suggestionComponent` | Optional | Function | `({ suggestion, query, isHighlighted, props }) => <div {...props} />` | Allows to override how the item is rendered. |
| `suggestionLimit` | Optional | Number | null | Limits the numbers of suggestions that are shown in the dropdown list |
| `shouldRenderSuggestions` | Optional | Function | `() => true` | A function that returns a `boolean` to determine whether or not suggestions are rendered. Use this when working with large collections of data to improve performance and user experience. This function is passed into the underlying react-autosuggest component. Ex.`(value) => value.trim() > 2` |
## `<BooleanInput>` and `<NullableBooleanInput>`
Expand Down
25 changes: 17 additions & 8 deletions packages/ra-ui-materialui/src/input/AutocompleteArrayInput.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export class AutocompleteArrayInput extends React.Component {
componentWillMount() {
this.setState({
inputValue: this.getInputValue(this.props.input.value),
suggestions: this.props.choices,
suggestions: this.limitSuggestions(this.props.choices),
});
}

Expand All @@ -141,19 +141,19 @@ export class AutocompleteArrayInput extends React.Component {
this.setState({
inputValue: this.getInputValue(input.value),
dirty: false,
suggestions: this.props.choices,
suggestions: this.limitSuggestions(this.props.choices),
});
// Ensure to reset the filter
this.updateFilter('');
} else if (!isEqual(choices, this.props.choices)) {
this.setState(({ searchText }) => ({
suggestions: choices.filter(suggestion =>
suggestions: this.limitSuggestions(choices.filter(suggestion =>
inputValueMatcher(
searchText,
suggestion,
this.getSuggestionText
)
),
)),
}));
}
}
Expand Down Expand Up @@ -192,13 +192,13 @@ export class AutocompleteArrayInput extends React.Component {
const { choices, inputValueMatcher } = this.props;

this.setState(({ searchText }) => ({
suggestions: choices.filter(suggestion =>
suggestions: this.limitSuggestions(choices.filter(suggestion =>
inputValueMatcher(
searchText,
suggestion,
this.getSuggestionText
)
),
)),
}));
};

Expand Down Expand Up @@ -423,11 +423,11 @@ export class AutocompleteArrayInput extends React.Component {
} else {
this.setState({
searchText: value,
suggestions: choices.filter(choice =>
suggestions: this.limitSuggestions(choices.filter(choice =>
this.getSuggestionText(choice)
.toLowerCase()
.includes(value.toLowerCase())
),
)),
});
}
}
Expand All @@ -446,6 +446,14 @@ export class AutocompleteArrayInput extends React.Component {
return true;
};

limitSuggestions = suggestions => {
const { suggestionLimit = 0 } = this.props;
if (Number.isInteger(suggestionLimit) && suggestionLimit > 0) {
return suggestions.slice(0, suggestionLimit);
}
return suggestions;
};

render() {
const {
alwaysRenderSuggestions,
Expand Down Expand Up @@ -523,6 +531,7 @@ AutocompleteArrayInput.propTypes = {
shouldRenderSuggestions: PropTypes.func,
source: PropTypes.string,
suggestionComponent: PropTypes.func,
suggestionLimit: PropTypes.number,
translate: PropTypes.func.isRequired,
translateChoice: PropTypes.bool.isRequired,
};
Expand Down
14 changes: 14 additions & 0 deletions packages/ra-ui-materialui/src/input/AutocompleteArrayInput.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -585,4 +585,18 @@ describe('<AutocompleteArrayInput />', () => {
wrapper.find('ForwardRef(Popper)').props().disablePortal
).toEqual(true);
});

it('should limit suggestions when suggestionLimit is passed', () => {
const wrapper = shallow(
<AutocompleteArrayInput
{...defaultProps}
choices={[
{ id: 'M', name: 'Male' },
{ id: 'F', name: 'Female' },
]}
suggestionLimit={1}
/>
);
expect(wrapper.state('suggestions')).toHaveLength(1);
});
});