Storybook: [addon-notes] notes don't appear

Created on 18 Jan 2019  路  2Comments  路  Source: storybookjs/storybook

Describe the bug
Installing the addon as described and adding a note does not cause anything to appear in the notes pane.

To Reproduce
Follow the steps as described in the documentation.

Expected behavior
The note I specified would appear.

Code snippets
config.js

import { configure,addDecorator } from '@storybook/vue'
import { withNotes } from '@storybook/addon-notes'

const req = require.context('../src/stories', true, /stories\.js$/)
const loadStories = () => req.keys().forEach(filename => req(filename))

addDecorator(withNotes)

configure(loadStories, module)

stories.js

import { storiesOf } from '@storybook/vue'

import Component from '../../components/Component.vue'

const stories = storiesOf('Component', module)

stories.add('basic example', () => ({
    components: { Component },
    notes: 'hello world',
    template: `<component></component>`
}))

System:

  • OS: MacOS
  • Device: Macbook Pro 2017
  • Browser: Firefox 65
  • Framework: Vue
  • Addons: notes
  • Version: 4.1.7

Most helpful comment

Try this instead:

stories.add('basic example', () => ({
    components: { Component },
    template: `<component></component>`
}), {
    notes: 'hello world',
});

All 2 comments

Try this instead:

stories.add('basic example', () => ({
    components: { Component },
    template: `<component></component>`
}), {
    notes: 'hello world',
});

Would be great when this would be documented on the page of the notes addon.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

tlrobinson picture tlrobinson  路  3Comments

dnlsandiego picture dnlsandiego  路  3Comments

levithomason picture levithomason  路  3Comments

ZigGreen picture ZigGreen  路  3Comments

xogeny picture xogeny  路  3Comments