@storybook/addon-ondevice-notes 6.0.1-beta.4 → 6.0.1-beta.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +16 -20
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  The Notes Addon allows you to write notes (text or markdown) for your stories in [Storybook](https://storybook.js.org).
4
4
 
5
- ![Storybook Addon Notes Demo](docs/demo.png)
6
-
7
5
  ## Installation
8
6
 
9
7
  ```sh
@@ -12,18 +10,12 @@ yarn add -D @storybook/addon-ondevice-notes
12
10
 
13
11
  ## Configuration
14
12
 
15
- Create a file called `rn-addons.js` in your storybook config.
16
-
17
- Add following content to it:
18
-
19
- ```js
20
- import '@storybook/addon-ondevice-notes/register';
21
- ```
22
-
23
- Then import `rn-addons.js` next to your `getStorybookUI` call.
13
+ Then, add following content to `.storybook/main.js`:
24
14
 
25
15
  ```js
26
- import './rn-addons';
16
+ module.exports = {
17
+ addons: ['@storybook/addon-ondevice-notes'],
18
+ };
27
19
  ```
28
20
 
29
21
  ## Usage
@@ -31,13 +23,17 @@ import './rn-addons';
31
23
  Use the `notes` parameter to add a note to stories:
32
24
 
33
25
  ```js
34
- import { storiesOf } from '@storybook/react-native';
35
-
36
- import Component from './Component';
37
-
38
- storiesOf('Component', module).add('with some emoji', () => <Component />, {
39
- notes: 'A small component',
40
- });
26
+ export default {
27
+ title: 'My title',
28
+ component: MyComponent,
29
+ parameters: {
30
+ notes: `
31
+ # Here I can add some markdown
32
+
33
+ Put a full new line between each element.
34
+ `,
35
+ },
36
+ };
41
37
  ```
42
38
 
43
- See the [crna-kitchen-sink app](../../examples/crna-kitchen-sink) for more examples.
39
+ See the [example app](../../examples/native) for more examples.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/addon-ondevice-notes",
3
- "version": "6.0.1-beta.4",
3
+ "version": "6.0.1-beta.7",
4
4
  "description": "Write notes for your react-native Storybook stories.",
5
5
  "keywords": [
6
6
  "addon",
@@ -45,5 +45,5 @@
45
45
  "publishConfig": {
46
46
  "access": "public"
47
47
  },
48
- "gitHead": "6d1be22ec495ee10489fd6d59386a1c3b1eaa264"
48
+ "gitHead": "8eb7ea7834e59194bc72376725af56960ffffcaf"
49
49
  }