npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@degjs/storybook-decorator-react-to-html

v1.0.0

Published

A Storybook decorator for rendering a React component to static HTML

Downloads

468

Readme

storybook-decorator-react-to-html

A Storybook for HTML decorator that converts a React component into a static HTML string. If you're wondering why you would ever want to do something like this, read the React As An HTML Templating Engine section below.

Install

npm install @degjs/storybook-decorator-react-to-html

Usage

As a global decorator in .storybook/preview.js (recommended):

import { addDecorator } from '@storybook/html';
import reactToHtml from '@degjs/storybook-decorator-react-to-html';

addDecorator(reactToHtml);

As a decorator within a story:

import reactToHtml from '@degjs/storybook-decorator-react-to-html';
import Button from './button';

export default {
  title: 'Button',
  component: Button,
  decorators: [ reactToHtml ]
}

You can then create a component in React:

import React from 'react';

function Button({children, isDisabled=false}) {
    return <button type="button" className="button" disabled={isDisabled}>{children}</button>;
}

export default Button;

And feed that React component directly into Storybook for HTML stories:

import React from 'react';
import Button from './button';

export const defaultButton = () => <Button>Click Me</Button>;
export const disabledButton = () => <Button isDisabled={true}>Click Me</Button>;

React As An HTML Templating Engine

React is a robust user interface library, but it can also function in a more limited capacity as a capable HTML templating engine. By outputting components created with React and JSX as static HTML, they can be fed directly into Storybook for HTML stories. The ReactDOMServer package includes a method that does just this: renderToStaticMarkup. The React to HTML decorator accepts a React component and utilizes the renderToStaticMarkup method to return an HTML string.

Writing HTML components in React provides many advantages, including the JSX syntax, props, composition, code reuse, and the full power of JavaScript itself. However, since these components are converted to static HTML, React runtime features such as state management and user interaction callbacks are not applicable.