@storybook/vue3 7.0.0-beta.8 → 7.0.0-rc.0

package/template/cli/ts-4-9/Page.stories.ts

@@ -0,0 +1,34 @@
+import type { Meta, StoryObj } from '@storybook/vue3';
+import { within, userEvent } from '@storybook/testing-library';
+import MyPage from './Page.vue';
+
+const meta = {
+  title: 'Example/Page',
+  component: MyPage,
+  render: () => ({
+    components: { MyPage },
+    template: '<my-page />',
+  }),
+  parameters: {
+    // More on how to position stories at: https://storybook.js.org/docs/7.0/vue/configure/story-layout
+    layout: 'fullscreen',
+  },
+  // This component will have an automatically generated docsPage entry: https://storybook.js.org/docs/7.0/vue/writing-docs/docs-page
+  tags: ['autodocs'],
+} satisfies Meta<typeof MyPage>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// More on interaction testing: https://storybook.js.org/docs/7.0/vue/writing-tests/interaction-testing
+export const LoggedIn: Story = {
+  play: async ({ canvasElement }: any) => {
+    const canvas = within(canvasElement);
+    const loginButton = await canvas.getByRole('button', {
+      name: /Log in/i,
+    });
+    await userEvent.click(loginButton);
+  },
+};
+
+export const LoggedOut: Story = {};

package/template/cli/ts-4-9/Page.vue

@@ -0,0 +1,70 @@
+<template>
+  <article>
+    <my-header :user="user" @login="onLogin" @logout="onLogout" @create-account="onCreateAccount" />
+
+    <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 class="tip-wrapper">
+        <span class="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" fill-rule="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>
+</template>
+
+<script lang="ts" setup>
+import './page.css';
+import MyHeader from './Header.vue';
+
+import { ref } from 'vue';
+
+const user = ref<{ name: string } | null>(null)
+
+const onLogin = () => {
+  user.value = { name: 'Jane Doe' };
+};
+const onLogout = () => {
+  user.value = null;
+};
+const onCreateAccount = () => {
+  user.value = { name: 'Jane Doe' };
+};
+
+</script>

package/template/components/Button.vue

@@ -45,8 +45,8 @@ export default {
       })),
       onClick() {
         emit('click');
-      }
-    }
+      },
+    };
   },
 };
 </script>

package/template/components/Html.vue

@@ -3,7 +3,6 @@
 </template>
 
 <script>
-
 export default {
   name: 'my-html',
 
@@ -14,7 +13,6 @@ export default {
     },
   },
 
-
-  setup() { },
+  setup() {},
 };
 </script>

package/template/components/index.js

@@ -1,4 +1,4 @@
-import globalThis from 'global';
+import { global as globalThis } from '@storybook/global';
 
 import Button from './Button.vue';
 import Pre from './Pre.vue';

package/template/stories/OverrideArgs.stories.js

@@ -20,13 +20,12 @@ export default {
         type: 'select',
         options: Object.keys(icons),
       },
-      defaultValue: 'Primary',
     },
   },
   render: (args) => {
     // Individual properties can be overridden by spreading the args
     // and the replacing the key-values that need to be updated
-    args = { ...args, icon: icons[args.icon] }; // eslint-disable-line no-param-reassign
+    args = { ...args, icon: icons[args.icon || 'Primary'] }; // eslint-disable-line no-param-reassign
     return {
       // Components used in your story `template` are defined in the `components` object
       components: { OverrideArgs },

package/template/stories/ReactiveArgs.stories.js

@@ -0,0 +1,44 @@
+import { expect } from '@storybook/jest';
+import { global as globalThis } from '@storybook/global';
+import { within, userEvent } from '@storybook/testing-library';
+import { UPDATE_STORY_ARGS, STORY_ARGS_UPDATED, RESET_STORY_ARGS } from '@storybook/core-events';
+import ReactiveArgs from './ReactiveArgs.vue';
+
+export default {
+  component: ReactiveArgs,
+  argTypes: {
+    // To show that other props are passed through
+    backgroundColor: { control: 'color' },
+  },
+};
+
+export const ReactiveTest = {
+  args: {
+    label: 'Button',
+  },
+  // test that args are updated correctly in rective mode
+  play: async ({ canvasElement, id }) => {
+    const channel = globalThis.__STORYBOOK_ADDONS_CHANNEL__;
+    const canvas = within(canvasElement);
+
+    await channel.emit(RESET_STORY_ARGS, { storyId: id });
+    await new Promise((resolve) => {
+      channel.once(STORY_ARGS_UPDATED, resolve);
+    });
+    const reactiveButton = await canvas.getByRole('button');
+    await expect(reactiveButton).toHaveTextContent('Button 0');
+
+    await userEvent.click(reactiveButton); // click to update the label to increment the count + 1
+    await channel.emit(UPDATE_STORY_ARGS, {
+      storyId: id,
+      updatedArgs: { label: 'updated' },
+    });
+    await new Promise((resolve) => {
+      channel.once(STORY_ARGS_UPDATED, resolve);
+    });
+    await expect(canvas.getByRole('button')).toHaveTextContent('updated 1');
+
+    await userEvent.click(reactiveButton); // click to update the label to increment the count + 1
+    await expect(reactiveButton).toHaveTextContent('updated 2');
+  },
+};

package/template/stories/ReactiveArgs.vue

@@ -0,0 +1,40 @@
+<template>
+  <button type="button" @click="onClick" :class="classes" :style="style">{{ label }} {{ counter }}</button>
+</template>
+
+<script>
+import { computed, ref } from 'vue';
+
+export default {
+  name: 'reactive-args',
+
+  props: {
+    label: {
+      type: String,
+    },
+
+    backgroundColor: {
+      type: String
+    },
+  },
+
+  setup(props, { emit }) {
+    const classes = {
+      'storybook-button': true,
+      'storybook-button--primary': true,
+      'storybook-button--large': true,
+    };
+    const style = computed(() => ({
+      backgroundColor: props.backgroundColor,
+    }));
+    const counter = ref(0);
+    const onClick = () => {
+      emit('click', 1);
+      counter.value += 1;
+    };
+
+    // Notice that `icon` prop component is still passed through even though it isn't mapped
+    return { classes, style, counter, onClick }
+  },
+};
+</script>

package/template/stories/decorators.stories.js

@@ -1,4 +1,4 @@
-import globalThis from 'global';
+import { global as globalThis } from '@storybook/global';
 import { h } from 'vue';
 
 const { Button, Pre } = globalThis.Components;

package/template/stories/preview.js

@@ -1,4 +1,4 @@
-import globalThis from 'global';
+import { global as globalThis } from '@storybook/global';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { setup } from '@storybook/vue3';
 

package/template/stories/vue3-mdx.stories.mdx

@@ -1,4 +1,4 @@
-import globalThis from 'global';
+import { global as globalThis } from '@storybook/global';
 import { Meta, Story, Canvas } from '@storybook/addon-docs';
 
 <Meta title="stories/renderers/vue3/vue3-mdx" />

package/dist/chunk-OBKGUFRJ.mjs

@@ -1,4 +0,0 @@
-import{h}from"vue";import{sanitizeStoryContextUpdate}from"@storybook/preview-api";function normalizeFunctionalComponent(options){return typeof options=="function"?{render:options,name:options.name}:options}function prepare(rawStory,innerStory){let story=rawStory;return story==null?null:innerStory?{...normalizeFunctionalComponent(story),components:{...story.components||{},story:innerStory}}:{render(){return h(story)}}}function decorateStory(storyFn,decorators){return decorators.reduce((decorated,decorator)=>context=>{let story,decoratedStory=decorator(update=>(story=decorated({...context,...sanitizeStoryContextUpdate(update)}),story),context);return story||(story=decorated(context)),decoratedStory===story?story:prepare(decoratedStory,story)},context=>prepare(storyFn(context)))}import{dedent}from"ts-dedent";import{createApp,h as h2}from"vue";var render=(props,context)=>{let{id,component:Component}=context;if(!Component)throw new Error(`Unable to render story ${id} as the component annotation is missing from the default export`);return h2(Component,props)},setupFunction=app=>{},setup=fn=>{setupFunction=fn},map=new Map;function renderToCanvas({title,name,storyFn,showMain,showError,showException},canvasElement){let element,storybookApp=createApp({unmounted(){map.delete(canvasElement)},render(){return map.set(canvasElement,storybookApp),setupFunction(storybookApp),h2(element)}});if(storybookApp.config.errorHandler=e=>showException(e),element=storyFn(),!element){showError({title:`Expecting a Vue component from the story: "${name}" of "${title}".`,description:dedent`
-      Did you forget to return the Vue component from the story?
-      Use "() => ({ template: '<my-comp></my-comp>' })" or "() => ({ components: MyComp, template: '<my-comp></my-comp>' })" when defining the story.
-      `});return}showMain(),map.get(canvasElement)?.unmount(),storybookApp.mount(canvasElement)}export{decorateStory,render,setup,renderToCanvas};