Skip to content

Variant ​

Create different sub stories around the same component by using the <Variant> tag multiple times inside the same <Story> tag.

title ​

Title of the variant.

vue
<template>
  <Story title="Cars">
    <Variant title="default">
      🚗
    </Variant>
    <Variant title="Fast">
      🏎️
    </Variant>
    <Variant title="Slow">
      🚜
    </Variant>
  </Story>
</template>

id ​

Id of the variant used in the URL. By default, the id is automatically generated with the index of the variant in the list. Setting an id manually will ensure the URL parameter doesn't change with the order of the variants in the story.

vue
<template>
  <Story>
    <Variant id="default">
      🚗
    </Variant>
    <Variant id="fast">
      🏎️
    </Variant>
    <Variant id="slow">
      🚜
    </Variant>
  </Story>
</template>

initState ​

Function that returns the initial state.

vue
<script setup>
function initState() {
  return {
    disabled: false,
    content: 'Hello world'
  }
}
</script>

<template>
  <Story title="My Button">
    <Variant title="Default" :init-state="initState">
      <template #default="{ state }">
        <button :disabled="state.disabled">
          {{ state.content }}
        </button>
      </template>
    </Variant>
  </Story>
</template>

Learn more

setupApp ​

A function to configure the Vue application.

It receives a payload object as parameter with the following properties:

  • app: The Vue application instance.
  • story: The story object.
  • variant: The variant object.
vue
<script setup>
function mySetupApp({ app, story, variant }) {
  app.provide('demo', 'meow')
}
</script>

<template>
  <Story>
    <Variant :setup-app="mySetupApp">
      <!-- ... -->
    </Variant>
  </Story>
</template>

Learn more

icon ​

An Iconify id to customize the variant icon in the UI.

vue
<template>
  <Story>
    <Variant icon="lucide:car">
      🚗
    </Variant>
  </Story>
</template>

iconColor ​

The icon color.

vue
<template>
  <Story>
    <Variant icon-color="#8B5CF6">
      🚗
    </Variant>
  </Story>
</template>

source ​

The copyable source code of the variant.

vue
<script setup>
const source = `<h1>Toto</h1>

<input
  v-model.number="count"
  type="number"
>`
</script>

<template>
  <Story>
    <Variant :source="source">
      <!-- ... -->
    </Variant>
  </Story>
</template>

responsiveDisabled ​

Disables the responsive menu, preview resize handles and makes the preview always fit the available space.

vue
<template>
  <Story>
    <Variant responsive-disabled>
      <!-- ... -->
    </Variant>
  </Story>
</template>

autoPropsDisabled ​

Disables the automatic detection of props of the components in the story.

vue
<template>
  <Story>
    <Variant auto-props-disabled>
      <!-- ... -->
    </Variant>
  </Story>
</template>

autoProps ​

Overrides or hides the automatic control of a prop, by the prop's name, for this variant. It replaces the story's autoProps whole. What each value does is in Override or hide a control.

vue
<template>
  <Variant :auto-props="{ level: { control: 'slider', min: 1, max: 6 }, tone: 'text' }">
    <MyButton />
  </Variant>
</template>

meta ​

Free-form data attached to the variant, for your own code to read. Poveste reads no key of a variant's meta. How a TypeScript book declares its keys is under meta on a story.

vue
<template>
  <Story>
    <Variant
      title="Without wrapper"
      :meta="{ wrapper: false }"
    >
      <!-- ... -->
    </Variant>
  </Story>
</template>

Slot: default ​

Content of the variant.

Props:

  • state: Object with the current state of the variant (if you are using initState).
vue
<template>
  <Story>
    <Variant>
      <template #default="{ state }">
        <pre>{{ state }}</pre>
      </template>
    </Variant>
  </Story>
</template>

Slot: controls ​

Content of the 'Controls' pane used to interact with the story.

Props:

  • state: Object with the current state of the variant (if you are using initState).
vue
<template>
  <Story>
    <Variant>
      <template #controls="{ state }">
        <!-- Interact with state here -->
        {{ state }}
      </template>
    </Variant>
  </Story>
</template>

Learn more

Slot: source ​

Manual copyable source code.

vue
<template>
  <Story>
    <Variant>
      <template #source>
        <textarea v-pre>
          <h1>Toto</h1>

          <input
            v-model.number="count"
            type="number"
          >
        </textarea>
      </template>
    </Variant>
  </Story>
</template>

Learn more

Released under the MIT License. Updates on Bluesky and X.