@rakuten-rex/paper

v1.0.2

Published

3 years ago

The background of an application resembles to a flat sheet of paper. Adding an shadow effect, backgroun color, or padding size to achieve your desired look.

Downloads

0High
0Medium
0Low

montomos

claudio.moya-rakuten.com

css sass mobile-first responsive front-end framework web react ui-components

ReX React UI Component: paper

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

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

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/

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 Paper from '@rakuten-rex/paper/Paper';

function MyCustomComponent() {
  return (
    <Paper shadow={4} pt={2} pb={2}>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
    </Paper>
  );
}

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/paper/Paper/css';

function MyCustomComponent() {
  return (
    <div class="rex-paper rex-pt-2 rex-pb-2 rex-paper-shadow0">
      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </div>
  );
}

Using Static CSS (Legacy Websites)

Example:

my-component.jsx

import '@rakuten-rex/paper/Paper/css/static';

function MyCustomComponent() {
  return (
    <div class="rex-paper rex-pt-2 rex-pb-2 rex-paper-shadow0">
      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </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/paper/Paper/sass/styles.mixin';

.my-component-with-rex-styles {
  @include rex-paper();
}

Vue.js

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

Example:

my-component.vue

<template>
    <div class="rex-paper rex-pt-2 rex-pb-2 rex-paper-shadow0">
      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </div>
</template>
<script>
export default {
  name: 'MyComponent',
}
</script>
<style scoped>
@import "~@rakuten-rex/paper/Paper/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]/Paper/Paper.production.min.css

Development mode URL (for local testing):

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

Using Static CSS (Legacy Websites)

https://unpkg.com/@rakuten-rex/[email protected]/Paper/Paper.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 paper -->
    <link href="https://unpkg.com/@rakuten-rex/[email protected]/Paper/Paper.production.min.css" rel="stylesheet">
  </head>
  <body>
    <div class="rex-paper rex-pt-2 rex-pb-2 rex-paper-shadow0">
      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </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+ | |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

ReX React UI Component: paper

How to install

Getting started

Storybook Live examples

ZeroHeight Documentation

How to integrate ReX in your project

A) JavaScript modules

React component (JavaScript + CSS Styles)

CSS Styles only

Using CSS Variables (Modern Websites and WebApps)

Using Static CSS (Legacy Websites)

Sass mixins

Vue.js

B) Static HTML

Using CSS Variables (Modern Websites and WebApps)

Using Static CSS (Legacy Websites)

Single component integration

Documentation, source code and distribution

Project Stack

Features

Browser Support