[Rating] Warn if precision prop is less than 0.1 #20491
Merged
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
oliviertassinari
added
the
component: rating
oliviertassinari
changed the title
Details of bundle changes.Comparing: 89f6208...9e7275b Details of page changes
|
oliviertassinari
requested changes
Apr 10, 2020
There was a problem hiding this comment.
What do you think of this approach instead?
diff --git a/packages/material-ui-lab/src/Rating/Rating.js b/packages/material-ui-lab/src/Rating/Rating.js
index b0c65494d..72064fc26 100644
--- a/packages/material-ui-lab/src/Rating/Rating.js
+++ b/packages/material-ui-lab/src/Rating/Rating.js
@@ -187,14 +187,6 @@ const Rating = React.forwardRef(function Rating(props, ref) {
].join('\n'),
);
}
-
- if (precision < 0.1) {
- console.warn(
- `precision prop shouldn't be less than 0.1,
- because it can cause unexpected behaviour of rendering in <Rating> component.
- More info: https://material-ui.com/api/rating/`,
- );
- }
}, [valueProp, isControlled, precision]);
}
@@ -575,7 +567,17 @@ Rating.propTypes = {
/**
* The minimum increment value change allowed.
*/
- precision: PropTypes.number,
+ precision: chainPropTypes(PropTypes.number, (props) => {
+ if (props.precision < 0.1) {
+ return new Error(
+ [
+ 'Material-UI: the prop `precision` should be above 0.1.',
+ 'A value below this limit has an imperceptible impact.',
+ ].join('\n'),
+ );
+ }
+ return null;
+ }),
/**
* Removes all hover effects and pointer events.
*/
diff --git a/packages/material-ui-lab/src/Rating/Rating.test.js b/packages/material-ui-lab/src/Rating/Rating.test.js
index 2b8505c38..5b743fc0f 100644
--- a/packages/material-ui-lab/src/Rating/Rating.test.js
+++ b/packages/material-ui-lab/src/Rating/Rating.test.js
@@ -115,22 +115,4 @@ describe('<Rating />', () => {
checked = container.querySelector('input[name="rating-test"]:checked');
expect(checked.value).to.equal('2');
});
-
- it('should raise console warning if precision prop is less than 0.1', () => {
- beforeEach(() => {
- consoleErrorMock.spy();
- });
-
- afterEach(() => {
- consoleErrorMock.reset();
- });
-
- render(<Rating {...defaultProps} precision={0.01} />);
-
- expect(consoleErrorMock.messages()[0]).to.include(
- `precision prop shouldn't be less than 0.1,
- because it can cause unexpected behaviour of rendering in <Rating> component.
- More info: https://material-ui.com/api/rating/`,
- );
- });
});We can have the component trace by using the prop-types, and we can avoid the test overhead given the simplicity of the logic.
f2e42c265
Didn't think about it. |
|
Should i update this pull request with your changes? |
|
Yes please :) |
AlexAndriyanenko
force-pushed
the
issues/16939
branch
from
cb08c79
to
9e7275b
Compare
oliviertassinari
approved these changes
Apr 10, 2020
|
By the way, thank you for helping :) |
|
Well done, thanks. |
This was referenced Apr 13, 2020
This was referenced Apr 20, 2020
This was referenced May 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #16939