From 5592b4e55b4bb8b81bc3f717c2adb081650885ac Mon Sep 17 00:00:00 2001 From: Hilton Shumway Date: Fri, 9 Mar 2018 10:20:26 -0700 Subject: [PATCH] Update props table to say size should be a number The prop-types say that the size prop should be a number, and the example code in the readme also uses a number, so the table should also say number, not string. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d9e3698..c021903 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ This a list of props that you can pass down to the component: | `char` | Which character you want to use as a star | ★ | string | | `color1` | Color of inactive star (this supports any CSS valid value) | `gray` | string | | `color2` | Color of selected or active star | `#ffd700` | string | -| `size` | Size of stars (in px) | `15px` | string | +| `size` | Size of stars (in px) | `15px` | number | | `edit` | Should you be able to select rating or just see rating (for reusability) | `true` | boolean | | `half` | Should component use half stars, if not the decimal part will be dropped otherwise normal algebra rools will apply to round to half stars | `true` | boolean | `onChange(new_rating)` | Will be invoked any time the rating is changed | `null` | function |