React UI Components Documentation

ReactJS Rating Component

The Rating component for ReactJS represents a widget that allows you to choose a rating. You can configure the Rating items size, image and the number of displayed items.

Prerequisites

Refer to ReactJS Getting Started before you start with this help topic.

Configuration

The Rating component for ReactJS requires the following imports.

 
import React from 'react';
import ReactDOM from 'react-dom';
import JqxRating from 'jqwidgets-react/react_jqxrating.js';

Then we create our component class. Properties and methods are put as ReactJS props.

 
class App extends React.Component {
render () {
return (
<JqxRating
width={350} height={35}
/>
)
}
}

Finally we render our class in the desired HTML element:

 
ReactDOM.render(<App />, document.getElementById('app'));

Events Methods & Properties

In order to bind to any event, change any property or call any method, we need a reference to the component.
For that we use the ReactJS "ref" Callback Attribute:

 
<JqxRating ref='myRating' width={350} height={35}...../>

Now, when we have a reference, we need to call the desired event/property/method.
This is done in the componentDidMount() ReactJS Component Lifecycle method.

 
class App extends React.Component {
componentDidMount()
{
//your logic
}
render ()
{
return
(
....
)
}
};

Events

The change event is triggered when the rating is changed.

The following example demonstrates how to add an event listener:

 
componentDidMount ()
{
this.refs.myRating.on('change', (event) =>
{
//your logic
});
}

Methods & Properties

This is how you call methods & props:

 
//Get Methods
let value = this.myRating.getValue();
//Set Methods
this.myRating.setValue(5);
//Get Properties
let height = this.myRating.height();
//Set Properties
this.myRating.height(45);

Every component have a method setOptions which accepts a object as an argument. This object contains component settings.

 
this.refs.myRating.setOptions({
precision: 0.5, width: 150, height: 35
})

Every component also have a method getOptions which returns a object containing the component settings.

 
let options = this.refs.myRating.getOptions();

Rating Examples

Overview

The following example demonstrates how to create a Rating component.

Disabled Rating

The following example demonstrates how to disable the Rating component.

Rating API

API Reference of the jQWidgets Rating component for React: Rating API