ReX React UI Component: grid

This project is part of ReX Design System and it can be used to create UI Components compatible with:

React, HTML/CSS and Vue.js

ReX Grid it's a fork from Bootstrap 4 Grid, we added our own breakpoints and removed extra features.

How to install

npm install @rakuten-rex/[email protected] --save

yarn add @rakuten-rex/[email protected]

Getting started

Storybook Live examples

For a complete guide of properties for React and HTML classes please visit our Storybook page:

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

Storybook features

• [x] Stories by component types
• [x] HTML raw output
• [x] JSX output
• [x] Stories source code
• [x] Knobs with multiple options

ZeroHeight Documentation

For a complete Documentation including all ReX Design System Components, Live HTML/React examples and Demos please visit:

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

Base Guidelines

Breakpoints

XS - Mobile

Breakpoint < 414px
Max container width 290px

SM - Mobile

Breakpoint ≥ 414px
Max container width 384px

MD - Tablet

Breakpoint ≥ 768px
Max container width 696px

LG - Desktop

Breakpoint ≥ 1024px
Max container width 936px

XL - Desktop HD

Breakpoint ≥ 1280px Max container width 1224px

XXL - Desktop HD+

Breakpoint ≥ 1440px Max container width 1320px

React/HTML & ClassNames structure

React

<Container>
  <Row>
    <Col>
      Content Left
    </Col>
    <Col>
      Content Right
    </Col>
  </Row>
</Container>

HTML

<!-- A) Grid Container -->
<div class="rex-grid-container">
  <!-- B) Grid Row -->
  <div class="rex-grid-row">
    <!-- C) Grid Columns -->
    <div class="rex-grid-col">Content Left</div>
    <div class="rex-grid-col">Content Right</div>
  </div>
</div>

Columns sizes

Attach the following list of sizes xs, sm, md, lg, xl, xxland column number from 1 to 12 to create columns combinations.

Example:

<Container>
  <Row>
    <Col xs='2'>
    Content Left
    </Col>
    <Col xs='10'>
    Content Right
    </Col>
  </Row>
</Container>

<div class="rex-grid-container">
  <div class="rex-grid-row">
    <div class="rex-grid-col-2">Content Left</div>
    <div class="rex-grid-col-10">Content Right</div>
  </div>
</div>

How to integrate ReX in your project

A) JavaScript modules

React component (JavaScript + CSS Styles)

For plug and play components integration.

Example:

my-component.jsx

import { Row, Container, Col } from '@rakuten-rex/grid/Grid';

function MyCustomComponent() {
  return (
    <Container>
      <Row>
        <Col>
        Content Left
        </Col>
        <Col>
        Content Right
        </Col>
      </Row>
    </Container>
  );
}

Click here to see all working examples in Storybook.

CSS Styles only

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

Using CSS Variables (Modern Websites and WebApps)

Example:

my-component.jsx

import '@rakuten-rex/grid/Grid/css';

function MyCustomComponent() {
  return (
    <div class="rex-grid-container">
      <div class="rex-grid-row">
        <div class="rex-grid-col">Content Left</div>
        <div class="rex-grid-col">Content Right</div>
      </div>
    </div>
  );
}

Using Static CSS (Legacy Websites)

Example:

my-component.jsx

import '@rakuten-rex/grid/Grid/css/static';

function MyCustomComponent() {
  return (
    <div class="rex-grid-container">
      <div class="rex-grid-row">
        <div class="rex-grid-col">Content Left</div>
        <div class="rex-grid-col">Content Right</div>
      </div>
    </div>
  );
}

Click here to see all working examples in Storybook.

Sass mixins

For your own customization of styles (React, Vue, Angular, etc.) or Static HTML.

Example:

my-styles.scss

@import '~@rakuten-rex/grid/Grid/sass/styles.mixin';

// Main local variables
$rex-grid-prefix: 'my-custom-rex-grid';
$rex-grid-gutter-width: 24px !default;
$rex-grid-container-max-widths: (
  xs: 290px,
  sm: 384px,
  md: 696px,
  lg: 936px,
  xl: 1224px
) !default;
$rex-grid-breakpoints: (
  xs: 0,
  sm: 414px,
  md: 768px,
  lg: 1024px,
  xl: 1280px,
  xxl: 1440px
) !default;
$rex-grid-columns: 12 !default;
$rex-grid-row-columns: 6 !default;
$rex-grid-displays: none, inline, inline-block, block, table, table-row, table-cell, flex, inline-flex !default;

// ReX Grid Mixin customizable styles generator
@include rex-grid(
  $rex-grid-prefix, 
  $rex-grid-gutter-width, 
  $rex-grid-container-max-widths, 
  $rex-grid-breakpoints, 
  $rex-grid-columns,
  $rex-grid-row-columns,
  $rex-grid-displays
);

Vue.js

A basic implementation based on HTML structure and import CSS styles into your component.

Example:

my-component.vue

<template>
    <div class="rex-grid-container">
      <div class="rex-grid-row">
        <div class="rex-grid-col">Content Left</div>
        <div class="rex-grid-col">Content Right</div>
      </div>
    </div>
</template>
<script>
export default {
  name: 'MyComponent',
}
</script>
<style scoped>
@import "~@rakuten-rex/grid/Grid/css";
</style>

B) Static HTML

Copy-paste the stylesheet <link> into your <head> tag to load our CSS styles.

Using CSS Variables (Modern Websites and WebApps)

Production mode URL (recommended for Static HTML projects):

https://unpkg.com/@rakuten-rex/[email protected]/Grid/Grid.production.min.css

Development mode URL (for local testing):

https://unpkg.com/@rakuten-rex/[email protected]/Grid/Grid.development.css

Using Static CSS (Legacy Websites)

https://unpkg.com/@rakuten-rex/[email protected]/Grid/Grid.static.css

Single component integration

Add it from unpkg.com CDN (NPM) into your HTML template or HTML static page.

Example:

my-page.html

<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <title>My Page</title>
    <!-- ReX grid -->
    <link href="https://unpkg.com/@rakuten-rex/[email protected]/Grid/Grid.production.min.css" rel="stylesheet">
  </head>
  <body>
    <div class="rex-grid-container">
      <div class="rex-grid-row">
        <div class="rex-grid-col">Content Left</div>
        <div class="rex-grid-col">Content Right</div>
      </div>
    </div>
  </body>
</html>

Documentation, source code and distribution

|| Site | URL | |-------------| ------------- | ------------- | || Github (Source Code) | https://github.com/rakuten-rex | || NPM (Package distribution) | https://www.npmjs.com/org/rakuten-rex | || ZeroHeight (Documentation) | https://zeroheight.com/390c074f3 |

Project Stack

| Front-end | |-------------| | HTML5 CSS3 & Sass JavaScript ES6 React |

| Tools | |-------------| | webpack Storybook Babel ESLint Prettier |

Features

| Styles features | JavaScript features | |-------------|-------------| | Theme support via CSS variables | React components splitted by type | | Static CSS styles available for HTML/VueJS/AngularJS | Universal Module Definition support | | Sass mixins for custom builds | | Reset CSS styles already bundled by HTML tags | | Removed duplicated CSS props | | CSS classes prefix rex- |

Browser Support

| PC | Mobile |-------------|-------------| | Chrome 49+ | iOS 9+ (Safari 9.3+, Chrome 78+) | | Safari 9.1+ | Android 6+ (Chrome 78+, Android Browser 76+) | | Firefox 31+ | | | MS Edge 15+ | | | IE 11+ | |