@storybook/addon-ondevice-notes
TypeScript icon, indicating that this package has built-in type declarations

7.6.18 • Public • Published

Storybook Notes Addon for react-native

The Notes Addon allows you to write notes (text or markdown) for your stories in Storybook.

Installation

yarn add -D @storybook/addon-ondevice-notes

Configuration

Then, add following content to .storybook/main.ts:

import { StorybookConfig } from '@storybook/react-native';

const main: StorybookConfig = {
  addons: ['@storybook/addon-ondevice-notes'],
};

export default main;

Usage

Use the notes parameter to add a note to stories:

import type { Meta } from '@storybook/react';
import { MyComponent } from './MyComponent';

const meta = {
  title: 'My title',
  component: MyComponent,
  parameters: {
    notes: `
     # Here I can add some markdown
     
     Put a full new line between each element.
    `,
  },
} satisfies Meta<typeof MyComponent>;

export default meta;

See the example app for more examples.

Package Sidebar

Install

npm i @storybook/addon-ondevice-notes

Weekly Downloads

34,832

Version

7.6.18

License

MIT

Unpacked Size

145 kB

Total Files

13

Last publish

Collaborators

  • domyen
  • kasperpeulen
  • valentinpalkovic
  • jreinhold
  • kylegach
  • ndelangen
  • shilman
  • tmeasday
  • ghengeveld
  • winkervsbecks
  • yannbf
  • dannyhw
  • gongreg