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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/vue3",
-  "version": "7.0.0-alpha.46",
+  "version": "7.0.0-alpha.48",
   "description": "Storybook Vue 3 renderer",
   "keywords": [
     "storybook"
@@ -41,6 +41,7 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist/**/*",
+    "template/**/*",
     "README.md",
     "*.js",
     "*.d.ts"
@@ -50,11 +51,11 @@
     "prep": "../../../scripts/prepare/bundle.ts"
   },
   "dependencies": {
-    "@storybook/addons": "7.0.0-alpha.46",
-    "@storybook/core-client": "7.0.0-alpha.46",
-    "@storybook/docs-tools": "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/docs-tools": "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",
@@ -90,5 +91,5 @@
     ],
     "platform": "browser"
   },
-  "gitHead": "c64b5be851ed2affac56e1daaac3f453fbe6f230"
+  "gitHead": "b58a29b785462f8a8b711b6bb2d7223fd6dc17fd"
 }

package/template/cli/Button.stories.js

@@ -0,0 +1,64 @@
+import MyButton from './Button.vue';
+
+// More on default export: https://storybook.js.org/docs/vue/writing-stories/introduction#default-export
+export default {
+  title: 'Example/Button',
+  component: MyButton,
+  // This component will have an automatically generated docsPage entry: https://storybook.js.org/docs/vue/writing-docs/docs-page
+  tags: ['docsPage'],
+  // More on component templates: https://storybook.js.org/docs/vue/writing-stories/introduction#using-args
+  render: (args) => ({
+    // Components used in your story `template` are defined in the `components` object
+    components: {
+      MyButton,
+    },
+    // The story's `args` need to be mapped into the template through the `setup()` method
+    setup() {
+      return {
+        args,
+      };
+    },
+    // And then the `args` are bound to your component with `v-bind="args"`
+    template: '<my-button v-bind="args" />',
+  }),
+  // More on argTypes: https://storybook.js.org/docs/vue/api/argtypes
+  argTypes: {
+    backgroundColor: {
+      control: 'color',
+    },
+    onClick: {},
+    size: {
+      control: {
+        type: 'select',
+      },
+      options: ['small', 'medium', 'large'],
+    },
+  },
+};
+
+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/Button.vue

@@ -0,0 +1,52 @@
+<template>
+  <button type="button" :class="classes" @click="onClick" :style="style">{{ label }}</button>
+</template>
+
+<script>
+import './button.css';
+import { reactive, computed } from 'vue';
+
+export default {
+  name: 'my-button',
+
+  props: {
+    label: {
+      type: String,
+      required: true,
+    },
+    primary: {
+      type: Boolean,
+      default: false,
+    },
+    size: {
+      type: String,
+      validator: function (value) {
+        return ['small', 'medium', 'large'].indexOf(value) !== -1;
+      },
+    },
+    backgroundColor: {
+      type: String,
+    },
+  },
+
+  emits: ['click'],
+
+  setup(props, { emit }) {
+    props = reactive(props);
+    return {
+      classes: computed(() => ({
+        'storybook-button': true,
+        'storybook-button--primary': props.primary,
+        'storybook-button--secondary': !props.primary,
+        [`storybook-button--${props.size || 'medium'}`]: true,
+      })),
+      style: computed(() => ({
+        backgroundColor: props.backgroundColor,
+      })),
+      onClick() {
+        emit('click');
+      }
+    }
+  },
+};
+</script>

package/template/cli/Header.stories.js

@@ -0,0 +1,41 @@
+import MyHeader from './Header.vue';
+
+export default {
+  title: 'Example/Header',
+  component: MyHeader,
+  // This component will have an automatically generated docsPage entry: https://storybook.js.org/docs/vue/writing-docs/docs-page
+  tags: ['docsPage'],
+  render: (args) => ({
+    // Components used in your story `template` are defined in the `components` object
+    components: {
+      MyHeader,
+    },
+    // The story's `args` need to be mapped into the template through the `setup()` method
+    setup() {
+      // Story args can be spread into the returned object
+      return {
+        ...args,
+      };
+    },
+    // Then, the spread values can be accessed directly in the template
+    template: '<my-header :user="user" />',
+  }),
+  parameters: {
+    // More on Story layout: https://storybook.js.org/docs/vue/configure/story-layout
+    layout: 'fullscreen',
+  },
+};
+
+export const LoggedIn = {
+  args: {
+    user: {
+      name: 'Jane Doe',
+    },
+  },
+};
+
+export const LoggedOut = {
+  args: {
+    user: null,
+  },
+};

package/template/cli/Header.vue

@@ -0,0 +1,41 @@
+<template>
+  <header>
+    <div class="wrapper">
+      <div>
+        <svg width="32" height="32" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg">
+          <g fill="none" fill-rule="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>
+        <span class="welcome" v-if="user">Welcome, <b>{{ user.name }}</b>!</span>
+        <my-button size="small" @click="$emit('logout')" label="Log out" v-if="user" />
+        <my-button size="small" @click="$emit('login')" label="Log in" v-if="!user" />
+        <my-button primary size="small" @click="$emit('createAccount')" label="Sign up" v-if="!user" />
+      </div>
+    </div>
+  </header>
+</template>
+
+<script>
+import './header.css';
+import MyButton from './Button.vue';
+
+export default {
+  name: 'my-header',
+
+  components: { MyButton },
+
+  props: {
+    user: {
+      type: Object,
+    },
+  },
+
+  emits: ['login', 'logout', 'createAccount'],
+};
+</script>

package/template/cli/Page.stories.js

@@ -0,0 +1,36 @@
+import { within, userEvent } from '@storybook/testing-library';
+import MyPage from './Page.vue';
+
+export default {
+  title: 'Example/Page',
+  component: MyPage,
+  render: () => ({
+    // Components used in your story `template` are defined in the `components` object
+    components: { MyPage },
+    // Here we define the `template`
+    template: '<my-page />',
+  }),
+  parameters: {
+    // More on Story layout: https://storybook.js.org/docs/vue/configure/story-layout
+    layout: 'fullscreen',
+  },
+};
+
+export const LoggedOut = {};
+
+// More on interaction testing: https://storybook.js.org/docs/vue/writing-tests/interaction-testing
+export const LoggedIn = {
+  render: () => ({
+    components: {
+      MyPage,
+    },
+    template: '<my-page />',
+  }),
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+    const loginButton = await canvas.getByRole('button', {
+      name: /Log in/i,
+    });
+    await userEvent.click(loginButton);
+  },
+};

package/template/cli/Page.vue

@@ -0,0 +1,88 @@
+<template>
+  <article>
+    <my-header
+      :user="user"
+      @login="onLogin"
+      @logout="onLogout"
+      @createAccount="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>
+import './page.css';
+import MyHeader from './Header.vue';
+
+export default {
+  name: 'my-page',
+
+  components: { MyHeader },
+
+  data() {
+    return {
+      user: null
+    }
+  },
+
+  methods: {
+    onLogin() {
+      this.user = { name: 'Jane Doe' };
+    },
+    onLogout() {
+      this.user = null;
+    },
+    onCreateAccount() {
+      this.user = { name: 'Jane Doe' };
+    },
+  },
+};
+</script>

package/template/components/Button.vue

@@ -0,0 +1,52 @@
+<template>
+  <button type="button" :class="classes" @click="onClick" :style="style">{{ label }}</button>
+</template>
+
+<script>
+import './button.css';
+import { reactive, computed } from 'vue';
+
+export default {
+  name: 'my-button',
+
+  props: {
+    label: {
+      type: String,
+      required: true,
+    },
+    primary: {
+      type: Boolean,
+      default: false,
+    },
+    size: {
+      type: String,
+      validator: function (value) {
+        return ['small', 'medium', 'large'].indexOf(value) !== -1;
+      },
+    },
+    backgroundColor: {
+      type: String,
+    },
+  },
+
+  emits: ['click'],
+
+  setup(props, { emit }) {
+    props = reactive(props);
+    return {
+      classes: computed(() => ({
+        'storybook-button': true,
+        'storybook-button--primary': props.primary,
+        'storybook-button--secondary': !props.primary,
+        [`storybook-button--${props.size || 'medium'}`]: true,
+      })),
+      style: computed(() => ({
+        backgroundColor: props.backgroundColor,
+      })),
+      onClick() {
+        emit('click');
+      }
+    }
+  },
+};
+</script>

package/template/components/Form.vue

@@ -0,0 +1,44 @@
+<template>
+  <form id="interaction-test-form" @submit.prevent="onSubmit">
+    <label>
+      Enter Value
+      <input type="text" data-testid="value" :value="value" required @click="setValue" />
+    </label>
+    <button type="submit">Submit</button>
+    <p v-if="complete">Completed!!</p>
+  </form>
+</template>
+
+<script>
+export default {
+  name: 'my-form',
+
+  props: {
+    onSuccess: {
+      type: Function,
+    },
+  },
+
+  data() {
+    return {
+      value: '',
+      complete: false,
+    };
+  },
+
+  methods: {
+    setValue(event) {
+      this.value = event.target.value;
+    },
+    onSubmit() {
+      this.onSuccess(this.value);
+      setTimeout(() => {
+        this.complete = true;
+      }, 500);
+      setTimeout(() => {
+        this.complete = false;
+      }, 1500);
+    },
+  },
+};
+</script>

package/template/components/Html.vue

@@ -0,0 +1,20 @@
+<template>
+  <div v-html="content"></div>
+</template>
+
+<script>
+
+export default {
+  name: 'my-html',
+
+  props: {
+    content: {
+      type: String,
+      required: true,
+    },
+  },
+
+
+  setup() { },
+};
+</script>

package/template/components/Pre.vue

@@ -0,0 +1,34 @@
+<template>
+  <pre data-testid="pre" :style="style">{{ finalText }}</pre>
+</template>
+
+<script>
+import { reactive, computed } from 'vue';
+
+export default {
+  name: 'my-pre',
+
+  props: {
+    // deepscan-disable-next-line
+    style: {
+      type: Object,
+    },
+    object: {
+      type: Object,
+    },
+    text: {
+      type: String,
+      default: '',
+    },
+  },
+
+  setup(props, { emit }) {
+    props = reactive(props);
+    return {
+      finalText: computed(() =>
+        props.object ? JSON.stringify(props.object, null, 2) : props.text
+      ),
+    };
+  },
+};
+</script>

package/template/components/button.css

@@ -0,0 +1,30 @@
+.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;
+}

package/template/components/index.js

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

package/template/stories/GlobalUsage.stories.js

@@ -0,0 +1,29 @@
+import GlobalUsage from './GlobalUsage.vue';
+
+export default {
+  component: GlobalUsage,
+  argTypes: {},
+  render: (args) => ({
+    // Components used in your story `template` are defined in the `components` object
+    components: { GlobalUsage },
+    // The story's `args` need to be mapped into the template through the `setup()` method
+    setup() {
+      return { args };
+    },
+    // And then the `args` are bound to your component with `v-bind="args"`
+    template: '<global-usage v-bind="args" />',
+  }),
+};
+
+export const Primary = {
+  args: {
+    primary: true,
+    label: 'Globally Defined',
+  },
+};
+
+export const Secondary = {
+  args: {
+    label: 'Globally Defined',
+  },
+};

package/template/stories/GlobalUsage.vue

@@ -0,0 +1,3 @@
+<template>
+  <global-button v-bind="$props" />
+</template>

package/template/stories/OverrideArgs.stories.js

@@ -0,0 +1,43 @@
+import OverrideArgs from './OverrideArgs.vue';
+
+// Emulate something that isn't serializable
+const icons = {
+  Primary: {
+    template: '<span>Primary Icon</span>',
+  },
+  Secondary: {
+    template: '<span>Secondary Icon</span>',
+  },
+};
+
+export default {
+  component: OverrideArgs,
+  argTypes: {
+    // To show that other props are passed through
+    backgroundColor: { control: 'color' },
+    icon: {
+      control: {
+        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
+    return {
+      // Components used in your story `template` are defined in the `components` object
+      components: { OverrideArgs },
+      // Updated `args` need to be mapped into the template through the `setup()` method
+      setup() {
+        return { args };
+      },
+      // And then the `args` are bound to your component with `v-bind="args"`
+      template: '<override-args v-bind="args" />',
+    };
+  },
+};
+
+export const TestOne = {};

package/template/stories/OverrideArgs.vue

@@ -0,0 +1,40 @@
+<template>
+  <button type="button" :class="classes" :style="style">
+    <!-- You can use <component /> with `:is` when passing a component as a prop -->
+    <component :is="icon" />
+  </button>
+</template>
+
+<script lang="typescript">
+import { h, computed, reactive } from 'vue';
+
+export default {
+  name: 'override-args',
+
+  props: {
+    icon: {
+      type: Object,
+      required: true,
+    },
+
+    backgroundColor: {
+      type: String
+    },
+  },
+
+  // @ts-expect-error (Converted from ts-ignore)
+  setup(props, { emit }) {
+    const classes = {
+      'storybook-button': true,
+      'storybook-button--primary': true,
+      'storybook-button--large': true,
+    };
+    const style = computed(() => ({
+      backgroundColor: props.backgroundColor,
+    }));
+
+    // Notice that `icon` prop component is still passed through even though it isn't mapped
+    return { classes, style, }
+  },
+};
+</script>

package/template/stories/decorators.stories.js

@@ -0,0 +1,66 @@
+import globalThis from 'global';
+import { h } from 'vue';
+
+const { Button, Pre } = globalThis.Components;
+
+export default {
+  component: Button,
+};
+
+export const ComponentTemplate = {
+  args: { label: 'With component' },
+  decorators: [
+    () => ({
+      components: {
+        Pre,
+      },
+      template: `
+        <Pre text="decorator" />
+        <story/>
+      `,
+    }),
+  ],
+};
+
+export const SimpleTemplate = {
+  args: { label: 'With border' },
+  decorators: [
+    () => ({
+      template: `
+        <div style="border: 5px solid red;">
+          <story/>
+        </div>
+        `,
+    }),
+  ],
+};
+
+export const VueWrapper = {
+  args: { label: 'With Vue wrapper' },
+  decorators: [
+    (storyFn) => {
+      // Call the `storyFn` to receive a component that Vue can render
+      const story = storyFn();
+      // Vue 3 "Functional" component as decorator
+      return () => {
+        return h('div', { style: 'border: 2px solid blue' }, h(story));
+      };
+    },
+  ],
+};
+
+export const DynamicWrapper = {
+  args: { label: 'With dynamic wrapper', primary: true },
+  argTypes: {
+    // Number type is detected, but we still want to constrain the range from 1-6
+    level: { control: { type: 'range', min: 1, max: 6 } },
+  },
+  decorators: [
+    (storyFn, { args }) => ({
+      template: `<div :style="{ borderWidth: level, borderColor: 'red', borderStyle: 'solid' }"><story /></div>`,
+      data() {
+        return { level: `${args.level}px` };
+      },
+    }),
+  ],
+};

package/template/stories/preview.js

@@ -0,0 +1,13 @@
+import globalThis from 'global';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { setup } from '@storybook/vue3';
+
+// TODO: I'd like to be able to export rather than imperatively calling an imported function
+// export const setup = (app) => {
+//   app.component('GlobalButton', Button);
+// };
+
+setup((app) => {
+  // This adds a component that can be used globally in stories
+  app.component('GlobalButton', globalThis.Components.Button);
+});

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

@@ -0,0 +1,46 @@
+import globalThis from 'global';
+import { Meta, Story, Canvas } from '@storybook/addon-docs';
+
+<Meta title="stories/renderers/vue3/vue3-mdx" />
+
+# Vue3-specific MDX Stories
+
+export const Button = globalThis.Components.Button;
+
+export const Template = (args, { argTypes }) => ({
+  components: { MyButton: Button },
+  template: '<my-button v-bind="args" />',
+  setup() {
+    return { args };
+  },
+});
+
+## Primary
+
+<Canvas>
+  <Story name="Primary">
+    {{
+      components: { MyButton: Button },
+      template: '<my-button :primary="true" label="Primary button" />',
+    }}
+  </Story>
+</Canvas>
+
+## Secondary
+
+<Canvas>
+  <Story name="Secondary">
+    {{
+      components: { MyButton: Button },
+      template: '<my-button :primary="false" label="Secondary button" />',
+    }}
+  </Story>
+</Canvas>
+
+## From template
+
+<Canvas>
+  <Story name="From Template" args={{ label: 'From template' }}>
+    {Template.bind({})}
+  </Story>
+</Canvas>