@storybook/svelte-vite 9.0.0-alpha.9 → 9.0.0-beta.1

package/template/stories_svelte-vite-default-ts/docgen/ts-legacy.svelte

@@ -0,0 +1,98 @@
+<script lang="ts">
+  import type { Snippet } from 'svelte';
+  import type { LiteralNumbers, LiteralStrings } from './types';
+  import { MyEnum } from './types';
+
+  type MyObject = {
+    foo: string;
+    bar: number;
+  };
+
+  /** Boolean */
+  export let boolean: boolean = true;
+  /** String */
+  export let string: string = 'default';
+  /** String (required) */
+  export let stringRequired: string;
+  /** Number */
+  export let number: number = 123;
+  /** True literal */
+  export let trueLiteral: true | undefined = undefined;
+  /** Symbol */
+  export let symbol: symbol | undefined = undefined;
+  /** Null */
+  export let nullValue: null = null;
+  /** Undefined */
+  export let undefinedValue: undefined = undefined;
+  /** Any */
+  export let any: any = null;
+  /** Date */
+  export let date: Date = new Date('20 Jan 1983');
+  /** Array of numbers */
+  export let arrayOfNumbers: number[] = [1, 20, 300];
+  /** Enum */
+  export let enumValue: MyEnum = MyEnum.FOO;
+  /** Union of literal strings */
+  export let unionLiteralStrings: LiteralStrings = 'apple';
+  /** Union of literal numbers */
+  export let unionLiteralNumbers: LiteralNumbers = 1000;
+  /** Object */
+  export let object: MyObject | undefined = undefined;
+  /** Inline object */
+  export let inlineObject:
+    | {
+        foo: string;
+        bar: number;
+      }
+    | undefined = undefined;
+  /** Record */
+  export let record: Record<string, number> = { a: 1, b: 2 };
+  /** Union of types */
+  export let unionTypes: number | string = 123;
+  /** Intersection of types */
+  export let intersection: ({ a: number } & { b: string }) | undefined = undefined;
+  /** Event callback function */
+  export let func: (event: MouseEvent) => number = () => 10;
+  /** Snippet contents */
+  export let children: Snippet;
+  /** Actual arg types inferred from the component */
+  export let argTypes: Record<string, any> = {};
+</script>
+
+<h1>Docgen: TS - legacy</h1>
+
+<h2>Args</h2>
+<pre>{JSON.stringify(
+    {
+      boolean,
+      string,
+      stringRequired,
+      number,
+      trueLiteral,
+      symbol,
+      nullValue,
+      undefinedValue,
+      any,
+      date,
+      arrayOfNumbers,
+      enumValue,
+      unionLiteralStrings,
+      unionLiteralNumbers,
+      object,
+      inlineObject,
+      record,
+      unionTypes,
+      intersection,
+      func,
+    },
+    null,
+    2
+  )}</pre>
+
+<h2>Children</h2>
+{#if children}
+  {@render children()}
+{/if}
+
+<h2>Arg Types</h2>
+<pre>{JSON.stringify(argTypes, null, 2)}</pre>

package/template/stories_svelte-vite-default-ts/docgen/ts-referenced-prop-types.stories.ts

@@ -0,0 +1,16 @@
+import type { Meta } from '@storybook/svelte-vite';
+
+import TSReferencedPropTypes from './ts-referenced-prop-types.svelte';
+
+const meta = {
+  component: TSReferencedPropTypes,
+  tags: ['autodocs'],
+  render: (args, { argTypes }) => ({
+    Component: TSReferencedPropTypes,
+    props: { ...args, argTypes },
+  }),
+} satisfies Meta<typeof TSReferencedPropTypes>;
+
+export default meta;
+
+export const Default = {};

package/template/stories_svelte-vite-default-ts/docgen/ts-referenced-prop-types.svelte

@@ -0,0 +1,107 @@
+<script lang="ts">
+  import type { Snippet } from 'svelte';
+  import type { LiteralNumbers, LiteralStrings } from './types';
+  import { MyEnum } from './types';
+
+  type MyObject = {
+    foo: string;
+    bar: number;
+  };
+
+  type PropsA = {
+    /** Boolean */
+    boolean?: boolean;
+    /** String */
+    string?: string;
+    /** String (required) */
+    stringRequired: string;
+    /** Number */
+    number?: number;
+  };
+  type PropsB = {
+    /** True literal */
+    trueLiteral?: true;
+    /** Symbol */
+    symbol?: symbol;
+    /** Null */
+    nullValue?: null;
+    /** Undefined */
+    undefinedValue?: undefined;
+    /** Any */
+    any?: any;
+    /** Date */
+    date?: Date;
+    /** Array of numbers */
+    arrayOfNumbers?: number[];
+    /** Enum */
+    enumValue?: MyEnum;
+    /** Union of literal strings */
+    unionLiteralStrings?: LiteralStrings;
+    /** Union of literal numbers */
+    unionLiteralNumbers?: LiteralNumbers;
+    /** Object */
+    object?: MyObject;
+    /** Inline object */
+    inlineObject?: {
+      foo: string;
+      bar: number;
+    };
+    /** Record */
+    record?: Record<string, number>;
+    /** Union of types */
+    unionTypes?: number | string;
+    /** Intersection of types */
+    intersection?: { a: number } & { b: string };
+    /** Event callback function */
+    func?: (event: MouseEvent) => number;
+    /** Snippet contents */
+    children: Snippet;
+    /** Actual arg types inferred from the component */
+    argTypes: Record<string, any>;
+  };
+
+  let {
+    boolean = true,
+    string = 'default',
+    stringRequired,
+    number = 123,
+    nullValue = null,
+    arrayOfNumbers = [1, 20, 300],
+    enumValue = MyEnum.FOO,
+    record = { a: 1, b: 2 },
+    date = new Date('20 Jan 1983'),
+    unionTypes = 123,
+    children,
+    func = () => 10,
+    argTypes,
+  }: PropsA & PropsB = $props();
+</script>
+
+<h1>Docgen: TS - referenced prop types</h1>
+
+<h2>Args</h2>
+<pre>{JSON.stringify(
+    {
+      boolean,
+      string,
+      stringRequired,
+      number,
+      nullValue,
+      arrayOfNumbers,
+      enumValue,
+      record,
+      date,
+      unionTypes,
+      func,
+    },
+    null,
+    2
+  )}</pre>
+
+<h2>Children</h2>
+{#if children}
+  {@render children()}
+{/if}
+
+<h2>Arg Types</h2>
+<pre>{JSON.stringify(argTypes, null, 2)}</pre>

package/template/stories_svelte-vite-default-ts/docgen/ts.stories.ts

@@ -0,0 +1,16 @@
+import type { Meta } from '@storybook/svelte-vite';
+
+import TS from './ts.svelte';
+
+const meta = {
+  component: TS,
+  tags: ['autodocs'],
+  render: (args, { argTypes }) => ({
+    Component: TS,
+    props: { ...args, argTypes },
+  }),
+} satisfies Meta<typeof TS>;
+
+export default meta;
+
+export const Default = {};

package/template/stories_svelte-vite-default-ts/docgen/ts.svelte

@@ -0,0 +1,125 @@
+<script lang="ts">
+  import type { Snippet } from 'svelte';
+  import type { LiteralNumbers, LiteralStrings } from './types';
+  import { MyEnum } from './types';
+
+  type MyObject = {
+    foo: string;
+    bar: number;
+  };
+
+  type Props = {
+    /** Boolean */
+    boolean?: boolean;
+    /** String */
+    string?: string;
+    /** String (required) */
+    stringRequired: string;
+    /** Number */
+    number?: number;
+    /** True literal */
+    trueLiteral?: true | undefined;
+    /** Symbol */
+    symbol?: symbol | undefined;
+    /** Null */
+    nullValue?: null;
+    /** Undefined */
+    undefinedValue?: undefined;
+    /** Any */
+    any?: any;
+    /** Date */
+    date?: Date;
+    /** Array of numbers */
+    arrayOfNumbers?: number[];
+    /** Enum */
+    enumValue?: MyEnum;
+    /** Union of literal strings */
+    unionLiteralStrings?: LiteralStrings;
+    /** Union of literal numbers */
+    unionLiteralNumbers?: LiteralNumbers;
+    /** Object */
+    object?: MyObject | undefined;
+    /** Inline object */
+    inlineObject?:
+      | {
+          foo: string;
+          bar: number;
+        }
+      | undefined;
+    /** Record */
+    record?: Record<string, number>;
+    /** Union of types */
+    unionTypes?: number | string;
+    /** Intersection of types */
+    intersection?: ({ a: number } & { b: string }) | undefined;
+    /** Event callback function */
+    func?: (event: MouseEvent) => number;
+    /** Children */
+    children: Snippet;
+    /** Actual arg types inferred from the component */
+    argTypes: Record<string, any>;
+  };
+
+  const {
+    boolean = true,
+    string = 'default',
+    stringRequired,
+    number = 123,
+    trueLiteral = undefined,
+    symbol = undefined,
+    nullValue = null,
+    undefinedValue = undefined,
+    any = null,
+    date = new Date('20 Jan 1983'),
+    arrayOfNumbers = [1, 20, 300],
+    enumValue = MyEnum.FOO,
+    unionLiteralStrings = 'apple',
+    unionLiteralNumbers = 100,
+    object = undefined,
+    inlineObject = undefined,
+    record = { a: 1, b: 2 },
+    unionTypes = 123,
+    intersection = undefined,
+    func = () => 10,
+    children,
+    argTypes,
+  }: Props = $props();
+</script>
+
+<h1>Docgen: TS</h1>
+
+<h2>Args</h2>
+<pre>{JSON.stringify(
+    {
+      boolean,
+      string,
+      stringRequired,
+      number,
+      trueLiteral,
+      symbol,
+      nullValue,
+      undefinedValue,
+      any,
+      date,
+      arrayOfNumbers,
+      enumValue,
+      unionLiteralStrings,
+      unionLiteralNumbers,
+      object,
+      inlineObject,
+      record,
+      unionTypes,
+      intersection,
+      func,
+    },
+    null,
+    2
+  )}</pre>
+
+<h2>Children</h2>
+{#if children}
+  {@render children()}
+{/if}
+
+<h2>Arg Types</h2>
+<pre>{JSON.stringify(argTypes, null, 2)}</pre>

package/template/cli/js/Button.stories.js

@@ -1,43 +0,0 @@
-import Button from './Button.svelte';
-
-// More on how to set up stories at: https://storybook.js.org/docs/writing-stories
-export default {
-  title: 'Example/Button',
-  component: Button,
-  tags: ['autodocs'],
-  argTypes: {
-    backgroundColor: { control: 'color' },
-    size: {
-      control: { type: 'select' },
-      options: ['small', 'medium', 'large'],
-    },
-  },
-};
-
-// More on writing stories with args: https://storybook.js.org/docs/writing-stories/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/js/Header.stories.js

@@ -1,22 +0,0 @@
-import Header from './Header.svelte';
-
-export default {
-  title: 'Example/Header',
-  component: Header,
-  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs
-  tags: ['autodocs'],
-  parameters: {
-    // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
-    layout: 'fullscreen',
-  },
-};
-
-export const LoggedIn = {
-  args: {
-    user: {
-      name: 'Jane Doe',
-    },
-  },
-};
-
-export const LoggedOut = {};

package/template/cli/js/Page.stories.js

@@ -1,28 +0,0 @@
-import { expect, userEvent, waitFor, within } from '@storybook/test';
-
-import Page from './Page.svelte';
-
-export default {
-  title: 'Example/Page',
-  component: Page,
-  parameters: {
-    // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
-    layout: 'fullscreen',
-  },
-};
-
-export const LoggedOut = {};
-
-// More on component testing: https://storybook.js.org/docs/writing-tests/component-testing
-export const LoggedIn = {
-  play: async ({ canvasElement }) => {
-    const canvas = within(canvasElement);
-    const loginButton = canvas.getByRole('button', { name: /Log in/i });
-    await expect(loginButton).toBeInTheDocument();
-    await userEvent.click(loginButton);
-    await waitFor(() => expect(loginButton).not.toBeInTheDocument());
-
-    const logoutButton = canvas.getByRole('button', { name: /Log out/i });
-    await expect(logoutButton).toBeInTheDocument();
-  },
-};

package/template/cli/svelte-5-js/Button.stories.svelte

@@ -1,31 +0,0 @@
-<script module>
-  import { defineMeta } from '@storybook/addon-svelte-csf';
-  import Button from './Button.svelte';
-  import { fn } from 'storybook/test';
-
-  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
-  const { Story } = defineMeta({
-    title: 'Example/Button',
-    component: Button,
-    tags: ['autodocs'],
-    argTypes: {
-      backgroundColor: { control: 'color' },
-      size: {
-        control: { type: 'select' },
-        options: ['small', 'medium', 'large'],
-      },
-    },
-    args: {
-      onClick: fn(),
-    }
-  });
-</script>
-
-<!-- More on writing stories with args: https://storybook.js.org/docs/writing-stories/args -->
-<Story name="Primary" args={{ primary: true, label: 'Button' }} />
-
-<Story name="Secondary" args={{ label: 'Button' }} />
-
-<Story name="Large" args={{ size: 'large', label: 'Button' }} />
-
-<Story name="Small" args={{ size: 'small', label: 'Button' }} />

package/template/cli/svelte-5-js/Button.svelte

@@ -1,26 +0,0 @@
-<script>
-  import './button.css';
-
-  /**
-   * @typedef {Object} Props
-   * @property {boolean} [primary] Is this the principal call to action on the page?
-   * @property {string} [backgroundColor] What background color to use
-   * @property {'small' | 'medium' | 'large'} [size] How large should the button be?
-   * @property {string} label Button contents
-   * @property {() => void} [onClick] The onclick event handler
-   */
-
-  /** @type {Props} */
-  const { primary = false, backgroundColor, size = 'medium', label, onClick } = $props();
-</script>
-
-<button
-  type="button"
-  class={['storybook-button', `storybook-button--${size}`].join(' ')}
-  class:storybook-button--primary={primary}
-  class:storybook-button--secondary={!primary}
-  style:background-color={backgroundColor}
-  onclick={onClick}
->
-  {label}
-</button>

package/template/cli/svelte-5-js/Header.svelte

@@ -1,47 +0,0 @@
-<script>
-  import './header.css';
-  import Button from './Button.svelte';
-
-  /**
-   * @typedef {Object} Props
-   * @property {{name: string}} [user] The user object
-   * @property {() => void} [onLogin] The login event handler
-   * @property {() => void} [onLogout] The logout event handler
-   * @property {() => void} [onCreateAccount] The account creation event handler
-   */
-
-  /** @type {Props} */
-  const { user, onLogin, onLogout, onCreateAccount } = $props();
-</script>
-
-<header>
-  <div class="storybook-header">
-    <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>
-      {#if user}
-        <span class="welcome">
-          Welcome, <b>{user.name}</b>!
-        </span>
-        <Button size="small" onClick={onLogout} label="Log out" />
-      {:else}
-        <Button size="small" onClick={onLogin} label="Log in" />
-        <Button primary size="small" onClick={onCreateAccount} label="Sign up" />
-      {/if}
-    </div>
-  </div>
-</header>

package/template/cli/svelte-5-js/Page.svelte

@@ -1,70 +0,0 @@
-<script>
-  import './page.css';
-  import Header from './Header.svelte';
-
-  let user = $state(null);
-</script>
-
-<article>
-  <Header
-    {user}
-    onLogin={() => (user = { name: 'Jane Doe' })}
-    onLogout={() => (user = null)}
-    onCreateAccount={() => (user = { name: 'Jane Doe' })}
-  />
-
-  <section class="storybook-page">
-    <h2>Pages in Storybook</h2>
-    <p>
-      We recommend building UIs with a
-      <a
-        href="https://blog.hichroma.com/component-driven-development-ce1109d56c8e"
-        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>

package/template/cli/svelte-5-ts-3-8/Header.svelte

@@ -1,45 +0,0 @@
-<script lang="ts">
-  import './header.css';
-  import Button from './Button.svelte';
-
-  interface Props {
-    user?: { name: string };
-    onLogin?: () => void;
-    onLogout?: () => void;
-    onCreateAccount?: () => void;
-  }
-
-  const { user, onLogin, onLogout, onCreateAccount }: Props = $props();
-</script>
-
-<header>
-  <div class="storybook-header">
-    <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>
-      {#if user}
-        <span class="welcome">
-          Welcome, <b>{user.name}</b>!
-        </span>
-        <Button size="small" onClick={onLogout} label="Log out" />
-      {:else}
-        <Button size="small" onClick={onLogin} label="Log in" />
-        <Button primary size="small" onClick={onCreateAccount} label="Sign up" />
-      {/if}
-    </div>
-  </div>
-</header>