React Bootstrap Star Rating
React wrapper of bootstrap-star-rating.
Install
npm install --save react-bootstrap-star-rating
Usage
First of all you must load the following assets in your <head />
.
(The last one is here.)
And in your app,
;;; { return <StarRating defaultValue=5 min=0 max=10 step=05 /> ; } ;
.
Image
Props
defaultValue
:PropTypes.number
Options below are Plugin Options.
stars
:PropTypes.number
glyphicon
:PropTypes.bool
symbol
:PropTypes.string
ratingClass
:PropTypes.string
min
:PropTypes.number
max
:PropTypes.number
step
:PropTypes.number
disabled
:PropTypes.bool
readonly
:PropTypes.bool
rtl
:PropTypes.bool
showClear
:PropTypes.bool
showCaption
:PropTypes.bool
size
:PropTypes.string
defaultCaption
:PropTypes.string
starCaptions
:PropTypes.oneOfType([PropTypes.object, PropTypes.func])
starCaptionClasses
:PropTypes.oneOfType([PropTypes.object, PropTypes.func])
clearButton
:PropTypes.string
clearButtonTitle
:PropTypes.string
clearButtonBaseClass
:PropTypes.string
clearButtonActiveClass
:PropTypes.string
clearValue
:PropTypes.string
clearCaption
:PropTypes.string
clearCaptionClass
:PropTypes.string
captionElement
:PropTypes.string
clearElement
:PropTypes.string
hoverEnabled
:PropTypes.bool
hoverChangeCaption
:PropTypes.bool
hoverChangeStars
:PropTypes.bool
hoverOnClear
:PropTypes.bool
Options below are Plugin Events.
onRatingChange
:PropTypes.func
onRatingClear
:PropTypes.func
onRatingReset
:PropTypes.func
onRatingHover
:PropTypes.func
onRatingHoverleave
:PropTypes.func
Additional API
These are Plugin Methods.
update
refresh
reset
clear
destroy
create
{ ; } { return <StarRating ref= { thisstarRating = ref; } /> ; }