From 433265eaccc2458832b07d0e8e5542425bef271e Mon Sep 17 00:00:00 2001 From: Rickard Andersson Date: Thu, 10 Aug 2023 13:04:41 +0300 Subject: [PATCH] testing: make `storybook` preview render properly --- .gitignore | 1 + .storybook/main.ts | 27 +- .storybook/preview-head.html | 3 + .storybook/preview.ts | 15 - .storybook/preview.tsx | 25 ++ src/App.tsx | 3 +- .../{LayoutComponent => }/LandingPage.css | 0 src/components/LandingPage.stories.ts | 20 + .../{LayoutComponent => }/LandingPage.tsx | 26 +- .../{LayoutComponent => }/LayoutComponent.tsx | 0 .../{QuickStartBar => }/QuickStartBar.css | 0 src/components/QuickStartBar.tsx | 47 +++ .../QuickStartBar/QuickStartBar.tsx | 31 -- .../{LayoutComponent => }/layout.css | 2 +- src/index.css | 6 +- src/main.tsx | 2 +- src/stories/Button.stories.ts | 50 --- src/stories/Button.tsx | 47 --- src/stories/Configure.mdx | 364 ------------------ src/stories/Header.stories.ts | 27 -- src/stories/Header.tsx | 54 --- src/stories/Page.stories.ts | 29 -- src/stories/Page.tsx | 73 ---- src/stories/button.css | 30 -- src/stories/header.css | 32 -- src/stories/page.css | 69 ---- 26 files changed, 133 insertions(+), 850 deletions(-) create mode 100644 .storybook/preview-head.html delete mode 100644 .storybook/preview.ts create mode 100644 .storybook/preview.tsx rename src/components/{LayoutComponent => }/LandingPage.css (100%) create mode 100644 src/components/LandingPage.stories.ts rename src/components/{LayoutComponent => }/LandingPage.tsx (98%) rename src/components/{LayoutComponent => }/LayoutComponent.tsx (100%) rename src/components/{QuickStartBar => }/QuickStartBar.css (100%) create mode 100644 src/components/QuickStartBar.tsx delete mode 100644 src/components/QuickStartBar/QuickStartBar.tsx rename src/components/{LayoutComponent => }/layout.css (99%) delete mode 100644 src/stories/Button.stories.ts delete mode 100644 src/stories/Button.tsx delete mode 100644 src/stories/Configure.mdx delete mode 100644 src/stories/Header.stories.ts delete mode 100644 src/stories/Header.tsx delete mode 100644 src/stories/Page.stories.ts delete mode 100644 src/stories/Page.tsx delete mode 100644 src/stories/button.css delete mode 100644 src/stories/header.css delete mode 100644 src/stories/page.css diff --git a/.gitignore b/.gitignore index 185b2502..7d3fadfb 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,4 @@ dist-ssr !.yarn/sdks !.yarn/versions /.tamagui/ +/storybook-static/ diff --git a/.storybook/main.ts b/.storybook/main.ts index 6d68d18c..5cad1144 100644 --- a/.storybook/main.ts +++ b/.storybook/main.ts @@ -1,19 +1,20 @@ -import type { StorybookConfig } from "@storybook/react-vite"; +import type { StorybookConfig } from '@storybook/react-vite' const config: StorybookConfig = { - stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"], + framework: '@storybook/react-vite', + + stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'], addons: [ - "@storybook/addon-links", - "@storybook/addon-essentials", - "@storybook/addon-onboarding", - "@storybook/addon-interactions", + '@storybook/addon-links', + '@storybook/addon-essentials', + '@storybook/addon-interactions', + 'storybook-addon-designs', + 'storybook-dark-mode', ], - framework: { - name: "@storybook/react-vite", - options: {}, - }, + docs: { - autodocs: "tag", + autodocs: 'tag', }, -}; -export default config; +} + +export default config diff --git a/.storybook/preview-head.html b/.storybook/preview-head.html new file mode 100644 index 00000000..7100922b --- /dev/null +++ b/.storybook/preview-head.html @@ -0,0 +1,3 @@ + diff --git a/.storybook/preview.ts b/.storybook/preview.ts deleted file mode 100644 index 1c372b69..00000000 --- a/.storybook/preview.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type { Preview } from "@storybook/react"; - -const preview: Preview = { - parameters: { - actions: { argTypesRegex: "^on[A-Z].*" }, - controls: { - matchers: { - color: /(background|color)$/i, - date: /Date$/, - }, - }, - }, -}; - -export default preview; diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx new file mode 100644 index 00000000..8109ae5c --- /dev/null +++ b/.storybook/preview.tsx @@ -0,0 +1,25 @@ +import React from 'react' +import type { Preview } from '@storybook/react' +import { TamaguiProvider } from '@tamagui/web' +import { Provider as StatusProvider } from '@status-im/components' +import '../src/index.css' +import appConfig from '../tamagui.config' + +const preview: Preview = { + parameters: { + // layout: 'centered', + }, + decorators: [ + Story => { + return ( + + + + + + ) + }, + ], +} + +export default preview diff --git a/src/App.tsx b/src/App.tsx index 44948ea8..0e64f693 100644 --- a/src/App.tsx +++ b/src/App.tsx @@ -1,10 +1,9 @@ import { TamaguiProvider } from 'tamagui' import { createBrowserRouter, RouterProvider } from 'react-router-dom' import { Provider as StatusProvider } from '@status-im/components' - import './App.css' import config from '../tamagui.config' -import LandingPage from './components/LayoutComponent/LandingPage' +import LandingPage from './components/LandingPage' const router = createBrowserRouter([ { diff --git a/src/components/LayoutComponent/LandingPage.css b/src/components/LandingPage.css similarity index 100% rename from src/components/LayoutComponent/LandingPage.css rename to src/components/LandingPage.css diff --git a/src/components/LandingPage.stories.ts b/src/components/LandingPage.stories.ts new file mode 100644 index 00000000..8ba9e266 --- /dev/null +++ b/src/components/LandingPage.stories.ts @@ -0,0 +1,20 @@ +import type { Meta, StoryObj } from '@storybook/react' + +import LandingPage from './LandingPage' + +const meta = { + title: 'Pages/LandingPage', + component: LandingPage, + parameters: { + layout: 'centered', + }, + tags: ['autodocs'], + argTypes: {}, +} satisfies Meta + +export default meta +type Story = StoryObj + +export const Page: Story = { + args: {}, +} diff --git a/src/components/LayoutComponent/LandingPage.tsx b/src/components/LandingPage.tsx similarity index 98% rename from src/components/LayoutComponent/LandingPage.tsx rename to src/components/LandingPage.tsx index 5a770a92..d6bc3dc6 100644 --- a/src/components/LayoutComponent/LandingPage.tsx +++ b/src/components/LandingPage.tsx @@ -1,8 +1,6 @@ import LayoutComponent from './LayoutComponent' import './LandingPage.css' -import QuickStartBar from '../QuickStartBar/QuickStartBar' -import DeviceCPULoad from '../DeviceCPULoad' -import NodesLogo from '../NodesLogo' +import QuickStartBar from './QuickStartBar' function LandingPage() { return ( @@ -17,7 +15,14 @@ function Content() { return (
- +
+
+ +
+

+ nodesBETA +

+
@@ -30,8 +35,8 @@ function Content() { fill="none" > @@ -67,13 +72,13 @@ function Content() { viewBox="0 0 20 20" fill="none" > - +
-
) } diff --git a/src/components/LayoutComponent/LayoutComponent.tsx b/src/components/LayoutComponent.tsx similarity index 100% rename from src/components/LayoutComponent/LayoutComponent.tsx rename to src/components/LayoutComponent.tsx diff --git a/src/components/QuickStartBar/QuickStartBar.css b/src/components/QuickStartBar.css similarity index 100% rename from src/components/QuickStartBar/QuickStartBar.css rename to src/components/QuickStartBar.css diff --git a/src/components/QuickStartBar.tsx b/src/components/QuickStartBar.tsx new file mode 100644 index 00000000..8d82ad84 --- /dev/null +++ b/src/components/QuickStartBar.tsx @@ -0,0 +1,47 @@ +import './QuickStartBar.css' + +function QuickStartBar() { + return ( + + ) +} + +export default QuickStartBar diff --git a/src/components/QuickStartBar/QuickStartBar.tsx b/src/components/QuickStartBar/QuickStartBar.tsx deleted file mode 100644 index 1145038f..00000000 --- a/src/components/QuickStartBar/QuickStartBar.tsx +++ /dev/null @@ -1,31 +0,0 @@ -import './QuickStartBar.css' - -function QuickStartBar() { - return ( - - ) -} - -export default QuickStartBar \ No newline at end of file diff --git a/src/components/LayoutComponent/layout.css b/src/components/layout.css similarity index 99% rename from src/components/LayoutComponent/layout.css rename to src/components/layout.css index cc9c610f..5f6c2929 100644 --- a/src/components/LayoutComponent/layout.css +++ b/src/components/layout.css @@ -105,4 +105,4 @@ header > div { /* height: 100%; */ height: 140%; width: auto; - } \ No newline at end of file + } diff --git a/src/index.css b/src/index.css index 1019558c..63cb7388 100644 --- a/src/index.css +++ b/src/index.css @@ -4,7 +4,7 @@ font-weight: 400; color-scheme: light dark; - color: rgba(255, 255, 255, 0.87); + color: rgba(0, 0, 0, 0.87); background-color: #242424; font-synthesis: none; @@ -14,6 +14,10 @@ -webkit-text-size-adjust: 100%; } +#storybook-root { + width: 100%; +} + body { margin: 0; display: flex; diff --git a/src/main.tsx b/src/main.tsx index 3d7150da..c4fc9bba 100644 --- a/src/main.tsx +++ b/src/main.tsx @@ -6,5 +6,5 @@ import './index.css' ReactDOM.createRoot(document.getElementById('root')!).render( - , + ) diff --git a/src/stories/Button.stories.ts b/src/stories/Button.stories.ts deleted file mode 100644 index 7a68cbfe..00000000 --- a/src/stories/Button.stories.ts +++ /dev/null @@ -1,50 +0,0 @@ -import type { Meta, StoryObj } from '@storybook/react'; - -import { Button } from './Button'; - -// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export -const meta = { - title: 'Example/Button', - component: Button, - parameters: { - // Optional parameter to center the component in the Canvas. More info: https://storybook.js.org/docs/react/configure/story-layout - layout: 'centered', - }, - // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs - tags: ['autodocs'], - // More on argTypes: https://storybook.js.org/docs/react/api/argtypes - argTypes: { - backgroundColor: { control: 'color' }, - }, -} satisfies Meta; - -export default meta; -type Story = StoryObj; - -// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args -export const Primary: Story = { - args: { - primary: true, - label: 'Button', - }, -}; - -export const Secondary: Story = { - args: { - label: 'Button', - }, -}; - -export const Large: Story = { - args: { - size: 'large', - label: 'Button', - }, -}; - -export const Small: Story = { - args: { - size: 'small', - label: 'Button', - }, -}; diff --git a/src/stories/Button.tsx b/src/stories/Button.tsx deleted file mode 100644 index 3cb9c42f..00000000 --- a/src/stories/Button.tsx +++ /dev/null @@ -1,47 +0,0 @@ -import './button.css' - -interface ButtonProps { - /** - * Is this the principal call to action on the page? - */ - primary?: boolean - /** - * What background color to use - */ - backgroundColor?: string - /** - * How large should the button be? - */ - size?: 'small' | 'medium' | 'large' - /** - * Button contents - */ - label: string - /** - * Optional click handler - */ - onClick?: () => void -} - -/** - * Primary UI component for user interaction - */ -export const Button = ({ - primary = false, - size = 'medium', - backgroundColor, - label, - ...props -}: ButtonProps) => { - const mode = primary ? 'storybook-button--primary' : 'storybook-button--secondary' - return ( - - ) -} diff --git a/src/stories/Configure.mdx b/src/stories/Configure.mdx deleted file mode 100644 index a50fcea3..00000000 --- a/src/stories/Configure.mdx +++ /dev/null @@ -1,364 +0,0 @@ -import { Meta } from "@storybook/blocks"; - -import Github from "./assets/github.svg"; -import Discord from "./assets/discord.svg"; -import Youtube from "./assets/youtube.svg"; -import Tutorials from "./assets/tutorials.svg"; -import Styling from "./assets/styling.png"; -import Context from "./assets/context.png"; -import Assets from "./assets/assets.png"; -import Docs from "./assets/docs.png"; -import Share from "./assets/share.png"; -import FigmaPlugin from "./assets/figma-plugin.png"; -import Testing from "./assets/testing.png"; -import Accessibility from "./assets/accessibility.png"; -import Theming from "./assets/theming.png"; -import AddonLibrary from "./assets/addon-library.png"; - -export const RightArrow = () => - - - - - -
-
- # Configure your project - - Because Storybook works separately from your app, you'll need to configure it for your specific stack and setup. Below, explore guides for configuring Storybook with popular frameworks and tools. If you get stuck, learn how you can ask for help from our community. -
-
-
- A wall of logos representing different styling technologies -

Add styling and CSS

-

Like with web applications, there are many ways to include CSS within Storybook. Learn more about setting up styling within Storybook.

- Learn more -
-
- An abstraction representing the composition of data for a component -

Provide context and mocking

-

Often when a story doesn't render, it's because your component is expecting a specific environment or context (like a theme provider) to be available.

- Learn more -
-
- A representation of typography and image assets -
-

Load assets and resources

-

To link static files (like fonts) to your projects and stories, use the - `staticDirs` configuration option to specify folders to load when - starting Storybook.

- Learn more -
-
-
-
-
-
- # Do more with Storybook - - Now that you know the basics, let's explore other parts of Storybook that will improve your experience. This list is just to get you started. You can customise Storybook in many ways to fit your needs. -
- -
-
-
- A screenshot showing the autodocs tag being set, pointing a docs page being generated -

Autodocs

-

Auto-generate living, - interactive reference documentation from your components and stories.

- Learn more -
-
- A browser window showing a Storybook being published to a chromatic.com URL -

Publish to Chromatic

-

Publish your Storybook to review and collaborate with your entire team.

- Learn more -
-
- Windows showing the Storybook plugin in Figma -

Figma Plugin

-

Embed your stories into Figma to cross-reference the design and live - implementation in one place.

- Learn more -
-
- Screenshot of tests passing and failing -

Testing

-

Use stories to test a component in all its variations, no matter how - complex.

- Learn more -
-
- Screenshot of accessibility tests passing and failing -

Accessibility

-

Automatically test your components for a11y issues as you develop.

- Learn more -
-
- Screenshot of Storybook in light and dark mode -

Theming

-

Theme Storybook's UI to personalize it to your project.

- Learn more -
-
-
-
-
-
-

Addons

-

Integrate your tools with Storybook to connect workflows.

- Discover all addons -
-
- Integrate your tools with Storybook to connect workflows. -
-
- -
-
- Github logo - Join our contributors building the future of UI development. - - Star on GitHub -
-
- Discord logo -
- Get support and chat with frontend developers. - - Join Discord server -
-
-
- Youtube logo -
- Watch tutorials, feature previews and interviews. - - Watch on YouTube -
-
-
- A book -

Follow guided walkthroughs on for key workflows.

- - Discover tutorials -
-
- - diff --git a/src/stories/Header.stories.ts b/src/stories/Header.stories.ts deleted file mode 100644 index 458391a3..00000000 --- a/src/stories/Header.stories.ts +++ /dev/null @@ -1,27 +0,0 @@ -import type { Meta, StoryObj } from '@storybook/react'; - -import { Header } from './Header'; - -const meta = { - title: 'Example/Header', - component: Header, - // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs - tags: ['autodocs'], - parameters: { - // More on how to position stories at: https://storybook.js.org/docs/react/configure/story-layout - layout: 'fullscreen', - }, -} satisfies Meta; - -export default meta; -type Story = StoryObj; - -export const LoggedIn: Story = { - args: { - user: { - name: 'Jane Doe', - }, - }, -}; - -export const LoggedOut: Story = {}; diff --git a/src/stories/Header.tsx b/src/stories/Header.tsx deleted file mode 100644 index 3bccb939..00000000 --- a/src/stories/Header.tsx +++ /dev/null @@ -1,54 +0,0 @@ -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) => ( -
-
-
- - - - - - - -

Acme

-
-
- {user ? ( - <> - - Welcome, {user.name}! - -
-
-
-) diff --git a/src/stories/Page.stories.ts b/src/stories/Page.stories.ts deleted file mode 100644 index 69852a2b..00000000 --- a/src/stories/Page.stories.ts +++ /dev/null @@ -1,29 +0,0 @@ -import type { Meta, StoryObj } from '@storybook/react'; -import { within, userEvent } from '@storybook/testing-library'; - -import { Page } from './Page'; - -const meta = { - title: 'Example/Page', - component: Page, - parameters: { - // More on how to position stories at: https://storybook.js.org/docs/react/configure/story-layout - layout: 'fullscreen', - }, -} satisfies Meta; - -export default meta; -type Story = StoryObj; - -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); - }, -}; diff --git a/src/stories/Page.tsx b/src/stories/Page.tsx deleted file mode 100644 index e1174830..00000000 --- a/src/stories/Page.tsx +++ /dev/null @@ -1,73 +0,0 @@ -import React from 'react'; - -import { Header } from './Header'; -import './page.css'; - -type User = { - name: string; -}; - -export const Page: React.FC = () => { - const [user, setUser] = React.useState(); - - return ( -
-
setUser({ name: 'Jane Doe' })} - onLogout={() => setUser(undefined)} - onCreateAccount={() => setUser({ name: 'Jane Doe' })} - /> - -
-

Pages in Storybook

-

- We recommend building UIs with a{' '} - - component-driven - {' '} - process starting with atomic components and ending with pages. -

-

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

-
    -
  • - Use a higher-level connected component. Storybook helps you compose such data from the - "args" of child component stories -
    • -
  • - Assemble data in the page component from your services. You can mock these services out - using Storybook. -
    • -
-

- Get a guided tutorial on component-driven development at{' '} - - Storybook tutorials - - . Read more in the{' '} - - docs - - . -

-
- Tip Adjust the width of the canvas with the{' '} - - - - - - Viewports addon in the toolbar -
-
-
- ); -}; diff --git a/src/stories/button.css b/src/stories/button.css deleted file mode 100644 index dc91dc76..00000000 --- a/src/stories/button.css +++ /dev/null @@ -1,30 +0,0 @@ -.storybook-button { - font-family: 'Nunito Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif; - font-weight: 700; - border: 0; - border-radius: 3em; - cursor: pointer; - display: inline-block; - line-height: 1; -} -.storybook-button--primary { - color: white; - background-color: #1ea7fd; -} -.storybook-button--secondary { - color: #333; - background-color: transparent; - box-shadow: rgba(0, 0, 0, 0.15) 0px 0px 0px 1px inset; -} -.storybook-button--small { - font-size: 12px; - padding: 10px 16px; -} -.storybook-button--medium { - font-size: 14px; - padding: 11px 20px; -} -.storybook-button--large { - font-size: 16px; - padding: 12px 24px; -} diff --git a/src/stories/header.css b/src/stories/header.css deleted file mode 100644 index d9a70528..00000000 --- a/src/stories/header.css +++ /dev/null @@ -1,32 +0,0 @@ -.storybook-header { - font-family: 'Nunito Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif; - border-bottom: 1px solid rgba(0, 0, 0, 0.1); - padding: 15px 20px; - display: flex; - align-items: center; - justify-content: space-between; -} - -.storybook-header svg { - display: inline-block; - vertical-align: top; -} - -.storybook-header h1 { - font-weight: 700; - font-size: 20px; - line-height: 1; - margin: 6px 0 6px 10px; - display: inline-block; - vertical-align: top; -} - -.storybook-header button + button { - margin-left: 10px; -} - -.storybook-header .welcome { - color: #333; - font-size: 14px; - margin-right: 10px; -} diff --git a/src/stories/page.css b/src/stories/page.css deleted file mode 100644 index 098dad11..00000000 --- a/src/stories/page.css +++ /dev/null @@ -1,69 +0,0 @@ -.storybook-page { - font-family: 'Nunito Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif; - font-size: 14px; - line-height: 24px; - padding: 48px 20px; - margin: 0 auto; - max-width: 600px; - color: #333; -} - -.storybook-page h2 { - font-weight: 700; - font-size: 32px; - line-height: 1; - margin: 0 0 4px; - display: inline-block; - vertical-align: top; -} - -.storybook-page p { - margin: 1em 0; -} - -.storybook-page a { - text-decoration: none; - color: #1ea7fd; -} - -.storybook-page ul { - padding-left: 30px; - margin: 1em 0; -} - -.storybook-page li { - margin-bottom: 8px; -} - -.storybook-page .tip { - display: inline-block; - border-radius: 1em; - font-size: 11px; - line-height: 12px; - font-weight: 700; - background: #e7fdd8; - color: #66bf3c; - padding: 4px 12px; - margin-right: 10px; - vertical-align: top; -} - -.storybook-page .tip-wrapper { - font-size: 13px; - line-height: 20px; - margin-top: 40px; - margin-bottom: 40px; -} - -.storybook-page .tip-wrapper svg { - display: inline-block; - height: 12px; - width: 12px; - margin-right: 4px; - vertical-align: top; - margin-top: 3px; -} - -.storybook-page .tip-wrapper svg path { - fill: #1ea7fd; -}