@storybook/react 7.0.0-alpha.45 → 7.0.0-alpha.47

package/template/cli/ts/Header.tsx

@@ -0,0 +1,56 @@
+import React from 'react';
+
+import { Button } from './Button';
+import './header.css';
+
+type User = {
+  name: string;
+};
+
+interface HeaderProps {
+  user?: User;
+  onLogin: () => void;
+  onLogout: () => void;
+  onCreateAccount: () => void;
+}
+
+export const Header = ({ user, onLogin, onLogout, onCreateAccount }: HeaderProps) => (
+  <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>
+);

package/template/cli/ts/Page.stories.ts

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

package/template/cli/ts/Page.tsx

@@ -0,0 +1,73 @@
+import React from 'react';
+
+import { Header } from './Header';
+import './page.css';
+
+type User = {
+  name: string;
+};
+
+export const Page: React.VFC = () => {
+  const [user, setUser] = React.useState<User>();
+
+  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/components/Button.jsx

@@ -0,0 +1,13 @@
+import React from 'react';
+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.string.isRequired,
+};

package/template/components/Form.jsx

@@ -0,0 +1,36 @@
+import React, { useState } from 'react';
+import PropTypes from 'prop-types';
+
+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,9 @@
+import React from 'react';
+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,20 @@
+import React from 'react';
+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 = 'react';

package/template/stories/decorators.stories.tsx

@@ -0,0 +1,28 @@
+import type { FC } from 'react';
+import React from 'react';
+import type { StoryObj, Meta } from '@storybook/react';
+
+const Component: FC = () => <p>Story</p>;
+
+export default {
+  component: Component,
+  decorators: [
+    (Story) => (
+      <>
+        <p>Component Decorator</p>
+        <Story />
+      </>
+    ),
+  ],
+} as Meta<typeof Component>;
+
+export const All: StoryObj<typeof Component> = {
+  decorators: [
+    (Story) => (
+      <>
+        <p>Local Decorator</p>
+        <Story />
+      </>
+    ),
+  ],
+};

package/template/stories/docgen-components/10017-ts-union/argTypes.snapshot

@@ -0,0 +1,36 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties 10017-ts-union 1`] = `
+Object {
+  "icon": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "specify icon=\\"search\\" or icon={IconComponent}",
+    "name": "icon",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "union",
+      },
+    },
+    "type": Object {
+      "name": "union",
+      "raw": "React.ReactNode | string",
+      "required": true,
+      "value": Array [
+        Object {
+          "name": "other",
+          "raw": "React.ReactNode",
+          "value": "ReactReactNode",
+        },
+        Object {
+          "name": "string",
+        },
+      ],
+    },
+  },
+}
+`;

package/template/stories/docgen-components/10017-ts-union/docgen.snapshot

@@ -0,0 +1,34 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties 10017-ts-union 1`] = `
+"import React from 'react';
+const Avatar = ({
+  icon
+}) => {
+  return /*#__PURE__*/React.createElement(\\"div\\", {
+    className: \\"hello\\"
+  }, \\"Hello Component \\", icon);
+};
+export const component = Avatar;
+Avatar.__docgenInfo = {
+  \\"description\\": \\"\\",
+  \\"methods\\": [],
+  \\"displayName\\": \\"Avatar\\",
+  \\"props\\": {
+    \\"icon\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"union\\",
+        \\"raw\\": \\"React.ReactNode | string\\",
+        \\"elements\\": [{
+          \\"name\\": \\"ReactReactNode\\",
+          \\"raw\\": \\"React.ReactNode\\"
+        }, {
+          \\"name\\": \\"string\\"
+        }]
+      },
+      \\"description\\": \\"specify icon=\\\\\\"search\\\\\\" or icon={IconComponent}\\"
+    }
+  }
+};"
+`;

package/template/stories/docgen-components/10017-ts-union/input.tsx

@@ -0,0 +1,12 @@
+import React from 'react';
+
+interface AvatarProps {
+  /** specify icon="search" or icon={IconComponent} */
+  icon: React.ReactNode | string;
+}
+
+const Avatar = ({ icon }: AvatarProps) => {
+  return <div className="hello">Hello Component {icon}</div>;
+};
+
+export const component = Avatar;

package/template/stories/docgen-components/10017-ts-union/properties.snapshot

@@ -0,0 +1,32 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties 10017-ts-union 1`] = `
+Object {
+  "rows": Array [
+    Object {
+      "defaultValue": null,
+      "description": "specify icon=\\"search\\" or icon={IconComponent}",
+      "name": "icon",
+      "required": true,
+      "sbType": Object {
+        "name": "union",
+        "raw": "React.ReactNode | string",
+        "value": Array [
+          Object {
+            "name": "other",
+            "raw": "React.ReactNode",
+            "value": "ReactReactNode",
+          },
+          Object {
+            "name": "string",
+          },
+        ],
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "union",
+      },
+    },
+  ],
+}
+`;

package/template/stories/docgen-components/10278-ts-multiple-components/argTypes.snapshot

@@ -0,0 +1,26 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties 10278-ts-multiple-components 1`] = `
+Object {
+  "aProperty": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "",
+    "name": "aProperty",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "any",
+      },
+    },
+    "type": Object {
+      "name": "other",
+      "required": true,
+      "value": "any",
+    },
+  },
+}
+`;

package/template/stories/docgen-components/10278-ts-multiple-components/docgen.snapshot

@@ -0,0 +1,49 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties 10278-ts-multiple-components 1`] = `
+"/* eslint-disable react/destructuring-assignment */
+import React from 'react';
+/**
+ * A component
+ */
+const A = props => {
+  return /*#__PURE__*/React.createElement(React.Fragment, null, \\"Hi \\", props.aProperty);
+};
+
+/**
+ * B component
+ */
+const B = props => {
+  return /*#__PURE__*/React.createElement(React.Fragment, null, \\"Hi \\", props.bProperty);
+};
+A.__docgenInfo = {
+  \\"description\\": \\"A component\\",
+  \\"methods\\": [],
+  \\"displayName\\": \\"A\\",
+  \\"props\\": {
+    \\"aProperty\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"any\\"
+      },
+      \\"description\\": \\"\\"
+    }
+  }
+};
+B.__docgenInfo = {
+  \\"description\\": \\"B component\\",
+  \\"methods\\": [],
+  \\"displayName\\": \\"B\\",
+  \\"props\\": {
+    \\"bProperty\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"any\\"
+      },
+      \\"description\\": \\"\\"
+    }
+  }
+};
+export { A, B };
+export const component = A;"
+`;

package/template/stories/docgen-components/10278-ts-multiple-components/input.tsx

@@ -0,0 +1,27 @@
+/* eslint-disable react/destructuring-assignment */
+import React from 'react';
+
+interface IAProps {
+  aProperty: any;
+}
+
+interface IBProps {
+  bProperty: any;
+}
+
+/**
+ * A component
+ */
+const A = (props: IAProps): JSX.Element => {
+  return <>Hi {props.aProperty}</>;
+};
+
+/**
+ * B component
+ */
+const B = (props: IBProps): JSX.Element => {
+  return <>Hi {props.bProperty}</>;
+};
+
+export { A, B };
+export const component = A;

package/template/stories/docgen-components/10278-ts-multiple-components/properties.snapshot

@@ -0,0 +1,22 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties 10278-ts-multiple-components 1`] = `
+Object {
+  "rows": Array [
+    Object {
+      "defaultValue": null,
+      "description": "",
+      "name": "aProperty",
+      "required": true,
+      "sbType": Object {
+        "name": "other",
+        "value": "any",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "any",
+      },
+    },
+  ],
+}
+`;

package/template/stories/docgen-components/8140-js-prop-types-oneof/argTypes.snapshot

@@ -0,0 +1,127 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties 8140-js-prop-types-oneof 1`] = `
+Object {
+  "blank": Object {
+    "control": Object {
+      "type": "boolean",
+    },
+    "description": "No background or border if static alert",
+    "name": "blank",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "bool",
+      },
+    },
+    "type": Object {
+      "name": "boolean",
+      "required": false,
+    },
+  },
+  "icon": Object {
+    "control": Object {
+      "type": "text",
+    },
+    "description": "Allows icon override, accepts material icon name",
+    "name": "icon",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    "type": Object {
+      "name": "string",
+      "required": false,
+    },
+  },
+  "message": Object {
+    "control": Object {
+      "type": "text",
+    },
+    "description": "",
+    "name": "message",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    "type": Object {
+      "name": "string",
+      "required": true,
+    },
+  },
+  "mode": Object {
+    "control": Object {
+      "type": "radio",
+    },
+    "description": "",
+    "name": "mode",
+    "options": Array [
+      "static",
+      "timed",
+    ],
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "'static'",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "'static' | 'timed'",
+      },
+    },
+    "type": Object {
+      "name": "enum",
+      "required": false,
+      "value": Array [
+        "static",
+        "timed",
+      ],
+    },
+  },
+  "type": Object {
+    "control": Object {
+      "type": "radio",
+    },
+    "description": "",
+    "name": "type",
+    "options": Array [
+      "success",
+      "warning",
+      "error",
+      "primary",
+    ],
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "'warning'",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "'success' | 'warning' | 'error' | 'primary'",
+      },
+    },
+    "type": Object {
+      "name": "enum",
+      "required": false,
+      "value": Array [
+        "success",
+        "warning",
+        "error",
+        "primary",
+      ],
+    },
+  },
+}
+`;