@rakuten-rex/storybook-inspect-html NPM

ReX React UI Component: storybook-inspect-html

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/storybook-inspect-html@1.3.2 --save

yarn add @rakuten-rex/storybook-inspect-html@1.3.2

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/storybook-inspect-html/

Storybook features

Stories by component types
HTML raw output
JSX output
Stories source code
Knobs with multiple options

Storybook integration

Register

Add this line at the end of the content of .storybook/addons.js.

import '@rakuten-rex/storybook-inspect-html/register';

Story

Import the addon in the story file you want to use.
Add it as the first decorator due to the addon requires a clean input to render the HTML, the output is clean as well.

Example:

Using MyComponent.stories.jsx:

import { withInspectHtml } from '@rakuten-rex/storybook-inspect-html';

const stories = storiesOf('MyComponent', module);
stories.addDecorator(withInspectHtml); // <-- First decorator
stories.addDecorator(withKnobs);
stories.addDecorator(withA11y);
...

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