1.2.0 • Published 5 years ago

rex-rating v1.2.0

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

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
  2. Codebase: Fork of Bootstrap project + ReX custom styles
  3. Css engine: Sass
  4. 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:

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:

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:

<!-- 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:

<!-- 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:

<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/