rgm-global-header

ReX React UI Components Library

ReX React UI Component: rgm-global-header

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

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

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 rgm-global-header@0.0.3 --save

What you can do

This project is a started kit, it contains the settings to start the creations of a React component and publish it to NPM.

Use it as a basement and reference for your own project and customize it as you will.

If you need a full environment to create a React Web App, try the react-create-app to get a full environment for your App or use any other started kit.

Live examples

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

https://rakuten-frontend.github.io/rgm-global-header/

JavaScript modules

React component (JavaScript + CSS Styles)

For plug and play components integration.

Example:

import 'rex-core'; // ReX Core dependency
import RexComponent from 'rgm-global-header';

function MyComponent() {
  return <RexComponent>Hello World</RexComponent>;
}

CSS Styles only

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

Example:

import 'rex-core/css'; // ReX Core dependency
import 'rgm-global-header/css';

function MyComponent() {
  return <div className="rex-css-style my-component">Hello World</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">
<!-- rgm-global-header -->
<link href="https://r.r10s.jp/com/rex/rgm-global-header/0.0.3/rgm-global-header.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">
<!-- rgm-global-header -->
<link href="https://r.r10s.jp/com/rex/rgm-global-header/0.0.3/rgm-global-header.production.min.css" rel="stylesheet">

Example:

<div class="rex-css-style my-component">
  <h1>Welcome to React</h1>
</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/