This package has been deprecated

Author message:

This project has been deprecated and is not longer supported

rex-steps

1.2.1 • Public • Published

ReX React UI Components Library

ReX React UI Component: rex-steps

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-steps@1.2.1 --save

What you can do

A track conveys progress through a set of logical steps.
Usage of tracks offers the following benefits:

  • Gives the user an idea of how long a form or a process is
  • Shows progress through a list of steps

Live examples

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

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

JavaScript modules

React component (JavaScript + CSS Styles)

For plug and play components integration.

Example:

import 'rex-core'; // ReX Core dependency
import { Steps, StepItem } from 'rex-steps';

function MyComponent() {
  return (
    <Steps maxsteps="5">
      <StepItem title="Enter your information" status="visited" />
      <StepItem title="Register service for use" status="visited" />
      <StepItem title="Confirmation" status="current" />
      <StepItem title="ID/Password input" status="default" />
      <StepItem title="Completion" status="default" />
    </Steps>
  );
}

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

function MyComponent() {
  return (
    <ol class="steps five-steps">
      <li class="visited"><span>Enter your information</span></li>
      <li class="visited"><span>Register service for use</span></li>
      <li class="current"><span>Confirmation</span></li>
      <li><span>ID/Password input</span></li>
      <li><span>Completion</span></li>
    </ol>
  );
}

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-steps -->
<link href="https://r.r10s.jp/com/rex/rex-steps/1.2.1/rex-steps.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-steps -->
<link href="https://r.r10s.jp/com/rex/rex-steps/1.2.1/rex-steps.production.min.css" rel="stylesheet">

Example:

<div class="rex-css-style my-component">
  <ol class="steps five-steps">
    <li class="visited"><span>Enter your information</span></li>
    <li class="visited"><span>Register service for use</span></li>
    <li class="current"><span>Confirmation</span></li>
    <li><span>ID/Password input</span></li>
    <li><span>Completion</span></li>
  </ol>
</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/

Package Sidebar

Install

npm i rex-steps

Weekly Downloads

3

Version

1.2.1

License

MIT

Unpacked Size

334 kB

Total Files

9

Last publish

Collaborators

  • montomos
  • claudio.moya-rakuten.com