# rex-rating

> ReX React UI Component

Latest version **1.2.0** (published 2019-04-24) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install rex-rating
pnpm add rex-rating
yarn add rex-rating
bun add rex-rating
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2019-04-24 |
| First published | 2019-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Unpacked size | 365.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rex Project Authors |
| Maintainers | claudio.moya-rakuten.com |
| Keywords | css, sass, mobile-first, responsive, front-end, framework, web, react, ui-components |

## Links

- npm: https://www.npmjs.com/package/rex-rating
- Repository: https://github.com/rakuten-rex/rex-rating
- Homepage: https://rakuten-rex.github.io/rex-rating/
- Issues: https://github.com/rakuten-rex/rex-rating/issues
- npm.io page: https://npm.io/package/rex-rating

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2019-04-24

## README

# ReX React UI Components Library
## ReX React UI Component: rex-rating

This project is part of ReX Design Language and it can be used to create React UI Components.   
For more information visit:   

Github  
https://github.com/rakuten-rex

NPM  
https://www.npmjs.com/org/rakuten-rex

## How it was built 

1. Build tool: webpack 4
1. Codebase: Fork of Bootstrap project + ReX custom styles
1. Css engine: Sass
1. JavaScript component: React

# How to install

```
npm install rex-rating@1.2.0 --save
```

## What you can do

A rating displays the satisfaction rate of a product or service. It’s always user generated and helps other users decide weather to themselves avail of the same product or service.   

This component allow to set the amount of stars and max rating value.  

### Live examples

For a complete guide of properties for React and HTML classes please visit the Storybook site:  

https://rakuten-rex.github.io/rex-rating/

### JavaScript modules

#### React component (JavaScript + CSS Styles)

For plug and play components integration.   

Example: 

```js
import 'rex-core'; // ReX Core dependency
import Rating from 'rex-rating';

function MyComponent() {
  return <Rating rating="2" maxRating="5" />;
}
```

#### CSS Styles only

For your own JavaScript integration (React, Vue, Angular, etc.) or Static HTML.

Example: 

```js
import 'rex-core/css'; // ReX Core dependency
import 'rex-rating/css';

function MyComponent() {
  return (
    <div class="rex-rater">
      <span aria-hidden="true" class="rex-icon favorite-f"></span>
      <span aria-hidden="true" class="rex-icon favorite-f"></span>
      <span aria-hidden="true" class="rex-icon favorite-l"></span>
      <span aria-hidden="true" class="rex-icon favorite-l"></span>
      <span aria-hidden="true" class="rex-icon favorite-l"></span>
    </div>
  );
}
```

### Static HTML

Add it from our CDN into your HTML template or HTML static page.

For development mode:

```markdown
<!-- ReX Core -->
<link href="https://r.r10s.jp/com/rex/rex-core/1.4.0/rex-core.development.css" rel="stylesheet">
<!-- rex-rating -->
<link href="https://r.r10s.jp/com/rex/rex-rating/1.2.0/rex-rating.development.css" rel="stylesheet">
```

For production mode:

```markdown
<!-- ReX Core -->
<link href="https://r.r10s.jp/com/rex/rex-core/1.4.0/rex-core.production.min.css" rel="stylesheet">
<!-- rex-rating -->
<link href="https://r.r10s.jp/com/rex/rex-rating/1.2.0/rex-rating.production.min.css" rel="stylesheet">
```

Example: 

```markdown
<div class="rex-css-style my-component">
  <div class="rex-rater">
    <span aria-hidden="true" class="rex-icon favorite-f"></span>
    <span aria-hidden="true" class="rex-icon favorite-f"></span>
    <span aria-hidden="true" class="rex-icon favorite-l"></span>
    <span aria-hidden="true" class="rex-icon favorite-l"></span>
    <span aria-hidden="true" class="rex-icon favorite-l"></span>
  </div>
</div>
```

## Javascript and React related documents

Take a look to this nice documentation pages to be more familiar with React and modern Javascript:

### Official site
https://reactjs.org/docs/getting-started.html   

### Google Web Fundamentals (the whole site is a must to read)
https://developers.google.com/web/fundamentals/

### Webpack as magic bundler
https://webpack.js.org/

### Composing Software series (how to understand Funcional Programming)
https://medium.com/javascript-scene/composing-software-an-introduction-27b72500d6ea   

### Common React patterns
https://reactpatterns.com   

### Understanding Storybook with nice images
https://blog.hichroma.com/the-delightful-storybook-workflow-b322b76fd07   

### Some guidelines for clean code
https://americanexpress.io/clean-code-dirty-code/

---
_Source: https://npm.io/package/rex-rating · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._