@storybook/preact 7.0.0-alpha.46 → 7.0.0-alpha.48

package/dist/config.d.ts

@@ -6,6 +6,9 @@ declare const render: ArgsStoryFn<PreactFramework>;
 declare function renderToDOM({ storyFn, title, name, showMain, showError, forceRemount }: Store_RenderContext<PreactFramework>, domElement: Element): void;
 
 declare const parameters: {
+    docs: {
+        inlineStories: boolean;
+    };
     framework: "preact";
 };
 

package/dist/config.js

@@ -1,4 +1,4 @@
-"use strict";var u=Object.create;var p=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var w=Object.getOwnPropertyNames;var F=Object.getPrototypeOf,g=Object.prototype.hasOwnProperty;var x=(e,r)=>{for(var t in r)p(e,t,{get:r[t],enumerable:!0})},m=(e,r,t,n)=>{if(r&&typeof r=="object"||typeof r=="function")for(let a of w(r))!g.call(e,a)&&a!==t&&p(e,a,{get:()=>r[a],enumerable:!(n=h(r,a))||n.enumerable});return e};var S=(e,r,t)=>(t=e!=null?u(F(e)):{},m(r||!e||!e.__esModule?p(t,"default",{value:e,enumerable:!0}):t,e)),E=e=>m(p({},"__esModule",{value:!0}),e);var R={};x(R,{parameters:()=>C,render:()=>d,renderToDOM:()=>f});module.exports=E(R);var o=S(require("preact")),l=require("ts-dedent"),{h:P}=o,d=(e,r)=>{let{id:t,component:n}=r;if(!n)throw new Error(`Unable to render story ${t} as the component annotation is missing from the default export`);return P(n,{...e})},i;function y(e,r){o.Fragment?o.render(e,r):i=o.render(e,r,i)}var k=({showError:e,name:r,title:t,storyFn:n,domElement:a})=>{let s=o.h(n,null);return s||(e({title:`Expecting a Preact element from the story: "${r}" of "${t}".`,description:l.dedent`
+"use strict";var h=Object.create;var m=Object.defineProperty;var w=Object.getOwnPropertyDescriptor;var F=Object.getOwnPropertyNames;var x=Object.getPrototypeOf,S=Object.prototype.hasOwnProperty;var g=(e,r)=>{for(var t in r)m(e,t,{get:r[t],enumerable:!0})},c=(e,r,t,o)=>{if(r&&typeof r=="object"||typeof r=="function")for(let a of F(r))!S.call(e,a)&&a!==t&&m(e,a,{get:()=>r[a],enumerable:!(o=w(r,a))||o.enumerable});return e};var P=(e,r,t)=>(t=e!=null?h(x(e)):{},c(r||!e||!e.__esModule?m(t,"default",{value:e,enumerable:!0}):t,e)),E=e=>c(m({},"__esModule",{value:!0}),e);var M={};g(M,{parameters:()=>R,render:()=>f,renderToDOM:()=>u});module.exports=E(M);var i={docs:{inlineStories:!0}};var n=P(require("preact")),y=require("ts-dedent"),{h:k}=n,f=(e,r)=>{let{id:t,component:o}=r;if(!o)throw new Error(`Unable to render story ${t} as the component annotation is missing from the default export`);return k(o,{...e})},d;function l(e,r){n.Fragment?n.render(e,r):d=n.render(e,r,d)}var C=({showError:e,name:r,title:t,storyFn:o,domElement:a})=>{let s=n.h(o,null);return s||(e({title:`Expecting a Preact element from the story: "${r}" of "${t}".`,description:y.dedent`
         Did you forget to return the Preact element from the story?
         Use "() => (<MyComp/>)" or "() => { return <MyComp/>; }" when defining the story.
-      `}),null)};function f({storyFn:e,title:r,name:t,showMain:n,showError:a,forceRemount:s},c){s&&y(null,c),n(),y(o.h(k,{name:t,title:r,showError:a,storyFn:e,domElement:c}),c)}var C={framework:"preact"};0&&(module.exports={parameters,render,renderToDOM});
+      `}),null)};function u({storyFn:e,title:r,name:t,showMain:o,showError:a,forceRemount:s},p){s&&l(null,p),o(),l(n.h(C,{name:t,title:r,showError:a,storyFn:e,domElement:p}),p)}var R={framework:"preact",...i};0&&(module.exports={parameters,render,renderToDOM});

package/dist/config.mjs

@@ -1 +1 @@
-import{a as r,b as e}from"./chunk-VVPUC5MQ.mjs";var t={framework:"preact"};export{t as parameters,r as render,e as renderToDOM};
+import{a as e,b as o}from"./chunk-VVPUC5MQ.mjs";var r={docs:{inlineStories:!0}};var m={framework:"preact",...r};export{m as parameters,e as render,o as renderToDOM};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/preact",
-  "version": "7.0.0-alpha.46",
+  "version": "7.0.0-alpha.48",
   "description": "Storybook Preact renderer",
   "keywords": [
     "storybook"
@@ -41,6 +41,7 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist/**/*",
+    "template/**/*",
     "README.md",
     "*.js",
     "*.d.ts"
@@ -50,10 +51,10 @@
     "prep": "../../../scripts/prepare/bundle.ts"
   },
   "dependencies": {
-    "@storybook/addons": "7.0.0-alpha.46",
-    "@storybook/core-client": "7.0.0-alpha.46",
-    "@storybook/store": "7.0.0-alpha.46",
-    "@storybook/types": "7.0.0-alpha.46",
+    "@storybook/addons": "7.0.0-alpha.48",
+    "@storybook/core-client": "7.0.0-alpha.48",
+    "@storybook/store": "7.0.0-alpha.48",
+    "@storybook/types": "7.0.0-alpha.48",
     "global": "^4.4.0",
     "react": "16.14.0",
     "react-dom": "16.14.0",
@@ -79,5 +80,5 @@
     ],
     "platform": "browser"
   },
-  "gitHead": "c64b5be851ed2affac56e1daaac3f453fbe6f230"
+  "gitHead": "b58a29b785462f8a8b711b6bb2d7223fd6dc17fd"
 }

package/template/cli/.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "rules": {
+    "import/extensions": "off",
+    "react/react-in-jsx-scope": "off",
+    "import/no-extraneous-dependencies": "off"
+  }
+}

package/template/cli/Button.jsx

@@ -0,0 +1,49 @@
+import PropTypes from 'prop-types';
+import './button.css';
+
+/**
+ * Primary UI component for user interaction
+ */
+export const Button = ({ primary, backgroundColor, size, label, ...props }) => {
+  const mode = primary ? 'storybook-button--primary' : 'storybook-button--secondary';
+  return (
+    <button
+      type="button"
+      className={['storybook-button', `storybook-button--${size}`, mode].join(' ')}
+      style={backgroundColor && { backgroundColor }}
+      {...props}
+    >
+      {label}
+    </button>
+  );
+};
+
+Button.propTypes = {
+  /**
+   * Is this the principal call to action on the page?
+   */
+  primary: PropTypes.bool,
+  /**
+   * What background color to use
+   */
+  backgroundColor: PropTypes.string,
+  /**
+   * How large should the button be?
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Button contents
+   */
+  label: PropTypes.string.isRequired,
+  /**
+   * Optional click handler
+   */
+  onClick: PropTypes.func,
+};
+
+Button.defaultProps = {
+  backgroundColor: null,
+  primary: false,
+  size: 'medium',
+  onClick: undefined,
+};

package/template/cli/Button.stories.jsx

@@ -0,0 +1,42 @@
+import { Button } from './Button';
+
+// More on default export: https://storybook.js.org/docs/preact/writing-stories/introduction#default-export
+export default {
+  title: 'Example/Button',
+  component: Button,
+  // This component will have an automatically generated docsPage entry: https://storybook.js.org/docs/preact/writing-docs/docs-page
+  tags: ['docsPage'],
+  // More on argTypes: https://storybook.js.org/docs/preact/api/argtypes
+  argTypes: {
+    backgroundColor: { control: 'color' },
+    onClick: { action: 'onClick' },
+  },
+};
+
+// More on component templates: https://storybook.js.org/docs/preact/writing-stories/introduction#using-args
+export const Primary = {
+  args: {
+    primary: true,
+    label: 'Button',
+  },
+};
+
+export const Secondary = {
+  args: {
+    label: 'Button',
+  },
+};
+
+export const Large = {
+  args: {
+    size: 'large',
+    label: 'Button',
+  },
+};
+
+export const Small = {
+  args: {
+    size: 'small',
+    label: 'Button',
+  },
+};

package/template/cli/Header.jsx

@@ -0,0 +1,58 @@
+import PropTypes from 'prop-types';
+
+import { Button } from './Button';
+import './header.css';
+
+export const Header = ({ user, onLogin, onLogout, onCreateAccount }) => (
+  <header>
+    <div className="wrapper">
+      <div>
+        <svg width="32" height="32" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg">
+          <g fill="none" fillRule="evenodd">
+            <path
+              d="M10 0h12a10 10 0 0110 10v12a10 10 0 01-10 10H10A10 10 0 010 22V10A10 10 0 0110 0z"
+              fill="#FFF"
+            />
+            <path
+              d="M5.3 10.6l10.4 6v11.1l-10.4-6v-11zm11.4-6.2l9.7 5.5-9.7 5.6V4.4z"
+              fill="#555AB9"
+            />
+            <path
+              d="M27.2 10.6v11.2l-10.5 6V16.5l10.5-6zM15.7 4.4v11L6 10l9.7-5.5z"
+              fill="#91BAF8"
+            />
+          </g>
+        </svg>
+        <h1>Acme</h1>
+      </div>
+      <div>
+        {user ? (
+          <>
+            <span className="welcome">
+              Welcome, <b>{user.name}</b>!
+            </span>
+            <Button size="small" onClick={onLogout} label="Log out" />
+          </>
+        ) : (
+          <>
+            <Button size="small" onClick={onLogin} label="Log in" />
+            <Button primary size="small" onClick={onCreateAccount} label="Sign up" />
+          </>
+        )}
+      </div>
+    </div>
+  </header>
+);
+
+Header.propTypes = {
+  user: PropTypes.shape({
+    name: PropTypes.string.isRequired,
+  }),
+  onLogin: PropTypes.func.isRequired,
+  onLogout: PropTypes.func.isRequired,
+  onCreateAccount: PropTypes.func.isRequired,
+};
+
+Header.defaultProps = {
+  user: null,
+};

package/template/cli/Header.stories.jsx

@@ -0,0 +1,27 @@
+import { Header } from './Header';
+
+export default {
+  title: 'Example/Header',
+  component: Header,
+  // This component will have an automatically generated docsPage entry: https://storybook.js.org/docs/preact/writing-docs/docs-page
+  tags: ['docsPage'],
+  parameters: {
+    // More on Story layout: https://storybook.js.org/docs/preact/configure/story-layout
+    layout: 'fullscreen',
+  },
+  argTypes: {
+    onLogin: { action: 'onLogin' },
+    onLogout: { action: 'onLogout' },
+    onCreateAccount: { action: 'onCreateAccount' },
+  },
+};
+
+export const LoggedIn = {
+  args: {
+    user: {
+      name: 'Jane Doe',
+    },
+  },
+};
+
+export const LoggedOut = {};

package/template/cli/Page.jsx

@@ -0,0 +1,68 @@
+import { useState } from 'preact/hooks';
+import { Header } from './Header';
+import './page.css';
+
+export const Page = () => {
+  const [user, setUser] = useState();
+
+  return (
+    <article>
+      <Header
+        user={user}
+        onLogin={() => setUser({ name: 'Jane Doe' })}
+        onLogout={() => setUser(undefined)}
+        onCreateAccount={() => setUser({ name: 'Jane Doe' })}
+      />
+
+      <section>
+        <h2>Pages in Storybook</h2>
+        <p>
+          We recommend building UIs with a{' '}
+          <a href="https://componentdriven.org" target="_blank" rel="noopener noreferrer">
+            <strong>component-driven</strong>
+          </a>{' '}
+          process starting with atomic components and ending with pages.
+        </p>
+        <p>
+          Render pages with mock data. This makes it easy to build and review page states without
+          needing to navigate to them in your app. Here are some handy patterns for managing page
+          data in Storybook:
+        </p>
+        <ul>
+          <li>
+            Use a higher-level connected component. Storybook helps you compose such data from the
+            "args" of child component stories
+          </li>
+          <li>
+            Assemble data in the page component from your services. You can mock these services out
+            using Storybook.
+          </li>
+        </ul>
+        <p>
+          Get a guided tutorial on component-driven development at{' '}
+          <a href="https://storybook.js.org/tutorials/" target="_blank" rel="noopener noreferrer">
+            Storybook tutorials
+          </a>
+          . Read more in the{' '}
+          <a href="https://storybook.js.org/docs" target="_blank" rel="noopener noreferrer">
+            docs
+          </a>
+          .
+        </p>
+        <div className="tip-wrapper">
+          <span className="tip">Tip</span> Adjust the width of the canvas with the{' '}
+          <svg width="10" height="10" viewBox="0 0 12 12" xmlns="http://www.w3.org/2000/svg">
+            <g fill="none" fillRule="evenodd">
+              <path
+                d="M1.5 5.2h4.8c.3 0 .5.2.5.4v5.1c-.1.2-.3.3-.4.3H1.4a.5.5 0 01-.5-.4V5.7c0-.3.2-.5.5-.5zm0-2.1h6.9c.3 0 .5.2.5.4v7a.5.5 0 01-1 0V4H1.5a.5.5 0 010-1zm0-2.1h9c.3 0 .5.2.5.4v9.1a.5.5 0 01-1 0V2H1.5a.5.5 0 010-1zm4.3 5.2H2V10h3.8V6.2z"
+                id="a"
+                fill="#999"
+              />
+            </g>
+          </svg>
+          Viewports addon in the toolbar
+        </div>
+      </section>
+    </article>
+  );
+};

package/template/cli/Page.stories.jsx

@@ -0,0 +1,25 @@
+import { within, userEvent } from '@storybook/testing-library';
+
+import { Page } from './Page';
+
+export default {
+  title: 'Example/Page',
+  component: Page,
+  parameters: {
+    // More on Story layout: https://storybook.js.org/docs/preact/configure/story-layout
+    layout: 'fullscreen',
+  },
+};
+
+export const LoggedOut = {};
+
+// More on interaction testing: https://storybook.js.org/docs/preact/writing-tests/interaction-testing
+export const LoggedIn = {
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+    const loginButton = await canvas.getByRole('button', {
+      name: /Log in/i,
+    });
+    await userEvent.click(loginButton);
+  },
+};

package/template/components/Button.jsx

@@ -0,0 +1,14 @@
+/* eslint-disable react/react-in-jsx-scope */
+// eslint-disable-next-line import/no-extraneous-dependencies
+import PropTypes from 'prop-types';
+
+export const Button = ({ onClick, label }) => (
+  <button type="button" onClick={onClick}>
+    {label}
+  </button>
+);
+
+Button.propTypes = {
+  onClick: PropTypes.func.isRequired,
+  label: PropTypes.node.isRequired,
+};

package/template/components/Form.jsx

@@ -0,0 +1,38 @@
+/* eslint-disable react/react-in-jsx-scope */
+// eslint-disable-next-line import/no-extraneous-dependencies
+import PropTypes from 'prop-types';
+import { useState } from 'preact/hooks';
+
+export const Form = ({ onSuccess }) => {
+  const [value, setValue] = useState('');
+  const [complete, setComplete] = useState(false);
+
+  function onSubmit(event) {
+    event.preventDefault();
+    onSuccess(value);
+
+    setTimeout(() => setComplete(true), 500);
+    setTimeout(() => setComplete(false), 1500);
+  }
+
+  return (
+    <form id="interaction-test-form" onSubmit={onSubmit}>
+      <label>
+        Enter Value
+        <input
+          type="text"
+          data-testid="value"
+          value={value}
+          required
+          onChange={(event) => setValue(event.target.value)}
+        />
+      </label>
+      <button type="submit">Submit</button>
+      {complete && <p>Completed!!</p>}
+    </form>
+  );
+};
+
+Form.propTypes = {
+  onSuccess: PropTypes.func.isRequired,
+};

package/template/components/Html.jsx

@@ -0,0 +1,10 @@
+/* eslint-disable react/react-in-jsx-scope */
+// eslint-disable-next-line import/no-extraneous-dependencies
+import PropTypes from 'prop-types';
+
+// eslint-disable-next-line react/no-danger
+export const Html = ({ content }) => <div dangerouslySetInnerHTML={{ __html: content }} />;
+
+Html.propTypes = {
+  content: PropTypes.string.isRequired,
+};

package/template/components/Pre.jsx

@@ -0,0 +1,21 @@
+/* eslint-disable react/react-in-jsx-scope */
+// eslint-disable-next-line import/no-extraneous-dependencies
+import PropTypes from 'prop-types';
+
+export const Pre = ({ style, object, text }) => (
+  <pre style={style} data-testid="pre">
+    {object ? JSON.stringify(object, null, 2) : text}
+  </pre>
+);
+
+Pre.propTypes = {
+  style: PropTypes.shape({}),
+  object: PropTypes.shape({}),
+  text: PropTypes.string,
+};
+
+Pre.defaultProps = {
+  style: {},
+  object: null,
+  text: '',
+};

package/template/components/index.js

@@ -0,0 +1,9 @@
+import globalThis from 'global';
+
+import { Button } from './Button.jsx';
+import { Pre } from './Pre.jsx';
+import { Form } from './Form.jsx';
+import { Html } from './Html.jsx';
+
+globalThis.Components = { Button, Pre, Form, Html };
+globalThis.storybookRenderer = 'preact';

package/template/stories/React.js

@@ -0,0 +1,50 @@
+import React from 'react';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import PropTypes from 'prop-types';
+
+export const ReactFunctionalComponent = ({ label }) => {
+  const [clicks, setValue] = React.useState(0);
+  return (
+    <div
+      tabIndex={0}
+      onClick={() => setValue(clicks + 1)}
+      style={{ cursor: 'pointer' }}
+      onKeyDown={() => undefined}
+      role="button"
+    >
+      <div style={{ color: 'red' }}>{label}</div>
+      <div>Clicked {clicks} times.</div>
+    </div>
+  );
+};
+
+ReactFunctionalComponent.propTypes = {
+  label: PropTypes.string.isRequired,
+};
+
+export class ReactClassComponent extends React.Component {
+  state = {
+    clicks: 0,
+  };
+
+  render() {
+    const { label } = this.props;
+    const { clicks } = this.state;
+    return (
+      <div
+        tabIndex={0}
+        onClick={() => this.setState({ clicks: clicks + 1 })}
+        onKeyDown={() => undefined}
+        style={{ cursor: 'pointer' }}
+        role="button"
+      >
+        <div style={{ color: 'green' }}>{label}</div>
+        <div>Clicked {clicks} times.</div>
+      </div>
+    );
+  }
+}
+
+ReactClassComponent.propTypes = {
+  label: PropTypes.string.isRequired,
+};

package/template/stories/react-compat.stories.js

@@ -0,0 +1,15 @@
+/* eslint-disable react/react-in-jsx-scope */
+import { ReactFunctionalComponent, ReactClassComponent } from './React';
+
+export default {
+  component: ReactFunctionalComponent,
+};
+
+export const ReactComponentDemo = () => (
+  <div>
+    <h1>React component demo</h1>
+    <ReactFunctionalComponent label="This is a React functional component rendered by Preact" />
+    <hr />
+    <ReactClassComponent label="This is a React class component rendered by Preact" />
+  </div>
+);