@storybook/ui - npm Package Compare versions

Comparing version 3.0.0-rc.0 to 3.0.0-rc.2

CHANGELOG.md

 ## Change Log
 
 ### v3.10.1
+
 07-Dec-2016
@@ -9,2 +10,3 @@
 ### v3.10.0
+
 05-Dec-2016
@@ -15,2 +17,3 @@
 ### v3.9.0
+
 30-Nov-2016
@@ -21,2 +24,3 @@
 ### v3.8.0
+
 16-Nov-2016
@@ -27,2 +31,3 @@
 ### v3.7.0
+
 13-Nov-2016
@@ -33,2 +38,3 @@
 ### v3.6.4
+
 12-Nov-2016
@@ -39,64 +45,77 @@
 ### v3.6.3
+
 17-Oct-2016
 
-* Improve shortcut help view for Windows users [PR54](https://github.com/kadirahq/storybook-ui/pull/54)
+-   Improve shortcut help view for Windows users [PR54](https://github.com/kadirahq/storybook-ui/pull/54)
 
 ### v3.6.2
+
 04-Oct-2016
 
-* Fix a style regression introduced by the previous PR. See: [PR47](https://github.com/kadirahq/storybook-ui/pull/47)
+-   Fix a style regression introduced by the previous PR. See: [PR47](https://github.com/kadirahq/storybook-ui/pull/47)
 
 ### v3.6.1
+
 29-Sep-2016
 
-* Use links in story list for accessibility [PR43](https://github.com/kadirahq/storybook-ui/pull/43)
+-   Use links in story list for accessibility [PR43](https://github.com/kadirahq/storybook-ui/pull/43)
 
 ### v3.6.0
+
 27-Sep-2016
 
-* Dynamic Panel titles [PR42](https://github.com/kadirahq/storybook-ui/pull/42)
+-   Dynamic Panel titles [PR42](https://github.com/kadirahq/storybook-ui/pull/42)
 
 ### v3.5.0
+
 26-Sep-2016
 
-* Set layout state with provider api [PR41](https://github.com/kadirahq/storybook-ui/pull/41)
+-   Set layout state with provider api [PR41](https://github.com/kadirahq/storybook-ui/pull/41)
 
 ### v3.4.1
+
 2-Sep-2016
 
-* Call the onStory callback as soon as it listens. [PR38](https://github.com/kadirahq/storybook-ui/pull/38)
+-   Call the onStory callback as soon as it listens. [PR38](https://github.com/kadirahq/storybook-ui/pull/38)
 
 ### v3.4.0
+
 2-Sep-2016
 
-* Custom query params are not stored in a separate object. [PR37](https://github.com/kadirahq/storybook-ui/pull/37)
+-   Custom query params are not stored in a separate object. [PR37](https://github.com/kadirahq/storybook-ui/pull/37)
 
 ### v3.3.4
+
 30-Aug-2016
 
-* Add missing react-dom peerDependency [PR35](https://github.com/kadirahq/storybook-ui/pull/35)
+-   Add missing react-dom peerDependency [PR35](https://github.com/kadirahq/storybook-ui/pull/35)
 
 ### v3.3.3
+
 30-Aug-2016
 
-* Avoid re-rendering panel content [PR36](https://github.com/kadirahq/storybook-ui/pull/36)
+-   Avoid re-rendering panel content [PR36](https://github.com/kadirahq/storybook-ui/pull/36)
 
 ### v3.3.2
+
 24-Aug-2016
 
-* When some url params are already present ui is displayed in the default way. [PR33](https://github.com/kadirahq/storybook-ui/pull/33)
+-   When some url params are already present ui is displayed in the default way. [PR33](https://github.com/kadirahq/storybook-ui/pull/33)
 
 ### v3.3.1
+
 24-Aug-2016
 
-* Avoid adding custom query params to the state if its undefined. [PR32](https://github.com/kadirahq/storybook-ui/pull/32)
-* Prevent emit story event for every redux store change. [PR31](https://github.com/kadirahq/storybook-ui/pull/31)
+-   Avoid adding custom query params to the state if its undefined. [PR32](https://github.com/kadirahq/storybook-ui/pull/32)
+-   Prevent emit story event for every redux store change. [PR31](https://github.com/kadirahq/storybook-ui/pull/31)
 
 ### v3.3.0
+
 23-Aug-2016
 
-* Add 'setQueryParams' and 'getQueryParams' to api. [PR30](https://github.com/kadirahq/storybook-ui/pull/30)
-* Selected down panel in url. [PR29](https://github.com/kadirahq/storybook-ui/pull/29)
+-   Add 'setQueryParams' and 'getQueryParams' to api. [PR30](https://github.com/kadirahq/storybook-ui/pull/30)
+-   Selected down panel in url. [PR29](https://github.com/kadirahq/storybook-ui/pull/29)
 
 ### v3.2.0
+
 09-Aug-2016
@@ -107,2 +126,3 @@
 ### v3.1.1
+
 05-Aug-2016
@@ -113,2 +133,3 @@
 ### v3.1.0
+
 05-Aug-2016
@@ -122,44 +143,44 @@
 
-* Remove Action Logger and add support for custom panels [PR22](https://github.com/kadirahq/storybook-ui/pull/22)
+-   Remove Action Logger and add support for custom panels [PR22](https://github.com/kadirahq/storybook-ui/pull/22)
 
 ### v2.6.1
 
-* Remove some React warnings due to bad code.
+-   Remove some React warnings due to bad code.
 
 ### v2.6.0
 
-* Remove logger name with the updated react-inspector. [PR21](https://github.com/kadirahq/storybook-ui/pull/21)
+-   Remove logger name with the updated react-inspector. [PR21](https://github.com/kadirahq/storybook-ui/pull/21)
 
 ### v2.5.0
 
-* API to set options added. [PR20](https://github.com/kadirahq/storybook-ui/pull/20)
-* Ability to dock action logger in right. [PR18](https://github.com/kadirahq/storybook-ui/pull/18)
-* Add transition to latest added log. [PR16](https://github.com/kadirahq/storybook-ui/pull/16)
+-   API to set options added. [PR20](https://github.com/kadirahq/storybook-ui/pull/20)
+-   Ability to dock action logger in right. [PR18](https://github.com/kadirahq/storybook-ui/pull/18)
+-   Add transition to latest added log. [PR16](https://github.com/kadirahq/storybook-ui/pull/16)
 
 ### v2.4.0
 
-* Show cross only if text present in the filter box. [PR13](https://github.com/kadirahq/storybook-ui/pull/13)
-* Update react-fuzzy. [PR12](https://github.com/kadirahq/storybook-ui/pull/12)
-* Improved logging with react-inspector. [PR11](https://github.com/kadirahq/storybook-ui/pull/11)
+-   Show cross only if text present in the filter box. [PR13](https://github.com/kadirahq/storybook-ui/pull/13)
+-   Update react-fuzzy. [PR12](https://github.com/kadirahq/storybook-ui/pull/12)
+-   Improved logging with react-inspector. [PR11](https://github.com/kadirahq/storybook-ui/pull/11)
 
 ### v2.3.0
 
-* Add support for Redux DevTools extension. See [PR8](https://github.com/kadirahq/storybook-ui/pull/8).
-* Add fuzzy search support with a brand new search overlay. See [PR7](https://github.com/kadirahq/storybook-ui/pull/7).
+-   Add support for Redux DevTools extension. See [PR8](https://github.com/kadirahq/storybook-ui/pull/8).
+-   Add fuzzy search support with a brand new search overlay. See [PR7](https://github.com/kadirahq/storybook-ui/pull/7).
 
 ### v2.2.0
 
-* Add fullscreen and other shortcut state to the URL. See [PR5](https://github.com/kadirahq/storybook-ui/pull/5)
+-   Add fullscreen and other shortcut state to the URL. See [PR5](https://github.com/kadirahq/storybook-ui/pull/5)
 
 ### v2.1.1
 
-* Add a hacking guide.
-* Refactored the module code base and removed provider code.
+-   Add a hacking guide.
+-   Refactored the module code base and removed provider code.
 
 ### v2.1.0
 
-* When creating the provider, it's required to extend from the base Provider. See [this example](https://github.com/kadirahq/storybook-ui/blob/master/example/client/provider.js#L10) for more info.
+-   When creating the provider, it's required to extend from the base Provider. See [this example](https://github.com/kadirahq/storybook-ui/blob/master/example/client/provider.js#L10) for more info.
 
 ### v2.0.0
 
-* Expose the whole Manager UI from this module. See the usage in [react-storybook](https://github.com/storybooks/react-storybook/blob/master/src/client/manager/index.js).
+-   Expose the whole Manager UI from this module. See the usage in [react-storybook](https://github.com/storybooks/react-storybook/blob/master/src/client/manager/index.js).

package.json

 {
   "name": "@storybook/ui",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.0-rc.2",
   "description": "Core Storybook UI",
@@ -5,0 +5,0 @@ "repository": {

README.md

 # Storybook UI
+
 [![Greenkeeper badge](https://badges.greenkeeper.io/storybooks/storybook.svg)](https://greenkeeper.io/)
@@ -13,4 +14,20 @@ [![Build Status](https://travis-ci.org/storybooks/storybook.svg?branch=master)](https://travis-ci.org/storybooks/storybook)
 
-![Storybook UI Demo](./docs/storybook-ui-demo.png)
+## Table of Contents
 
+-   [Usage](#usage)
+-   [API](#api)
+    -   [.setOptions()](#setoptions)
+-   [.setStories()](#setstories)
+-   [.onStory()](#onstory)
+-   [Hacking Guide](#hacking-guide)
+    -   [The App](#the-app)
+    -   [Changing UI](#changing-ui)
+    -   [Redux](#redux)
+    -   [Mounting](#mounting)
+    -   [App Context](#app-context)
+    -   [Actions](#actions)
+    -   [Core API](#core-api)
+    -   [Keyboard Shortcuts](#keyboard-shortcuts)
+    -   [URL Changes](#url-changes)
+
 ## Usage
@@ -65,15 +82,17 @@
 
-### .setOptions([option])
+### .setOptions()
 
 ```js
-handleAPI(api) {
-  api.setOptions({
-    name: 'My Component', // change the name displayed in the left top portion
-    url: 'https://github.com/user/my-component', // change its URL
-    sortStoriesByKind: true // Sort the list of stories by their "kind"
-  });
-}
+class ReactProvider extends Provider {
+  handleAPI(api) {
+    api.setOptions({
+      name: 'My Component', // change the name displayed in the left top portion
+      url: 'https://github.com/user/my-component', // change its URL
+      sortStoriesByKind: true // Sort the list of stories by their "kind"
+    });
+  }
+};
 ```
 
-## .setStories([stories])
+## .setStories()
 
@@ -83,14 +102,16 @@ This API is used to pass the`kind` and `stories` list to storybook-ui.
 ```js
-handleAPI(api) {
-  api.setStories([
-    {
-      kind: 'Component 1',
-      stories: ['State 1', 'State 2']
-    },
+class ReactProvider extends Provider {
+  handleAPI(api) {
+    api.setStories([
+      {
+        kind: 'Component 1',
+        stories: ['State 1', 'State 2']
+      },
 
-    {
-      kind: 'Component 2',
-      stories: ['State a', 'State b']
-    }
-  ]);
+      {
+        kind: 'Component 2',
+        stories: ['State a', 'State b']
+      }
+    ]);
+  }
 }
@@ -104,11 +125,11 @@ ```
 ```js
-handleAPI(api) {
-  api.onStory((kind, story) => {
-      this.globalState.emit('change', kind, story);
-  });
+class ReactProvider extends Provider {
+  handleAPI(api) {
+    api.onStory((kind, story) => {
+        this.globalState.emit('change', kind, story);
+    });
+  }
 }
 ```
 
-
-
 ## Hacking Guide
@@ -115,0 +136,0 @@

No alert changes

Improved metrics

Total package byte prevSize

611673

increased by0.11%

Number of lines in readme file

189

increased by12.5%

No dependency changes