Initial Release.

.babelrc

@@ -0,0 +1,3 @@
+{
+ "presets": ["es2015", "stage-2", "react"]
+}

.eslintrc

@@ -0,0 +1,17 @@
+{
+ "extends": "airbnb",
+ "rules": {
+ "arrow-body-style": 0,
+ "prefer-arrow-callback": 0,
+ "func-names": 0,
+ "react/jsx-no-bind": 0,
+ "react/jsx-uses-react": 1,
+ "react/prefer-stateless-function": 0
+ },
+ "parserOptions": {
+ "ecmaVersion": 6,
+ "ecmaFeatures": {
+ "experimentalObjectRestSpread": true
+ }
+ }
+}

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+*.log
+.idea
+dist

.npmignore

@@ -0,0 +1,2 @@
+src
+.babelrc

.scripts/get_gh_pages_url.js

@@ -0,0 +1,11 @@
+// IMPORTANT
+// ---------
+// This is an auto generated file with React CDK.
+// Do not modify this file.
+
+const parse = require('git-url-parse');
+var ghUrl = process.argv[2];
+const parsedUrl = parse(ghUrl);
+
+const ghPagesUrl = 'https://' + parsedUrl.owner + '.github.io/' + parsedUrl.name;
+console.log(ghPagesUrl);

.scripts/mocha_runner.js

@@ -0,0 +1,33 @@
+// IMPORTANT
+// ---------
+// This is an auto generated file with React CDK.
+// Do not modify this file.
+// Use `.scripts/user/pretest.js instead`.
+
+require('babel-core/register');
+require('babel-polyfill');
+
+// Add jsdom support, which is required for enzyme.
+var jsdom = require('jsdom').jsdom;
+
+var exposedProperties = ['window', 'navigator', 'document'];
+
+global.document = jsdom('');
+global.window = document.defaultView;
+Object.keys(document.defaultView).forEach((property) => {
+ if (typeof global[property] === 'undefined') {
+ exposedProperties.push(property);
+ global[property] = document.defaultView[property];
+ }
+});
+
+global.navigator = {
+ userAgent: 'node.js'
+};
+
+process.on('unhandledRejection', function (error) {
+ console.error('Unhandled Promise Rejection:');
+ console.error(error && error.stack || error);
+});
+
+require('./user/pretest.js');

.scripts/prepublish.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# IMPORTANT
+# ---------
+# This is an auto generated file with React CDK.
+# Do not modify this file.
+# Use `.scripts/user/prepublish.sh instead`.
+
+echo "=> Transpiling 'src' into ES5 ..."
+echo ""
+rm -rf ./dist
+./node_modules/.bin/babel --ignore tests,stories --plugins "transform-runtime" ./src --out-dir ./dist
+echo ""
+echo "=> Transpiling completed."
+
+. .scripts/user/prepublish.sh

.scripts/publish_storybook.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+# IMPORTANT
+# ---------
+# This is an auto generated file with React CDK.
+# Do not modify this file.
+
+set -e # exit with nonzero exit code if anything fails
+
+# get GIT url
+
+GIT_URL=`git config --get remote.origin.url`
+if [[ $GIT_URL == "" ]]; then
+ echo "This project is not configured with a remote git repo".
+ exit 1
+fi
+
+# clear and re-create the out directory
+rm -rf .out || exit 0;
+mkdir .out;
+
+# run our compile script, discussed above
+build-storybook -o .out
+
+# go to the out directory and create a *new* Git repo
+cd .out
+git init
+
+# inside this git repo we'll pretend to be a new user
+git config user.name "GH Pages Bot"
+git config user.email "[email protected]"
+
+# The first and only commit to this new Git repo contains all the
+# files present with the commit message "Deploy to GitHub Pages".
+git add .
+git commit -m "Deploy Storybook to GitHub Pages"
+
+# Force push from the current repo's master branch to the remote
+# repo's gh-pages branch. (All previous history on the gh-pages branch
+# will be lost, since we are overwriting it.) We redirect any output to
+# /dev/null to hide any sensitive credential data that might otherwise be exposed.
+git push --force --quiet $GIT_URL master:gh-pages > /dev/null 2>&1
+cd ..
+rm -rf .out
+
+echo ""
+echo "=> Storybook deployed to: `node .scripts/get_gh_pages_url.js $GIT_URL`"

.scripts/user/prepublish.sh

@@ -0,0 +1 @@
+# Use this file to your own code to run at NPM `prepublish` event.

.scripts/user/pretest.js

@@ -0,0 +1 @@
+// Use this file to setup any test utilities.

.storybook/config.js

@@ -0,0 +1,12 @@
+// IMPORTANT
+// ---------
+// This is an auto generated file with React CDK.
+// Do not modify this file.
+
+import { configure } from '@kadira/storybook';
+
+function loadStories() {
+ require('../src/stories');
+}
+
+configure(loadStories, module);

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing to Storybook Addon Notes Component
+
+We welcome your help to make this component better. This document will help to streamline the contributing process and save everyone's precious time.
+
+## Development Setup
+
+This component has been setup with [React CDK](https://github.com/kadirahq/react-cdk). Refer [React CDK documentation](https://github.com/kadirahq/react-cdk)) to get started with the development.

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Your Name. <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# Storybook Addon Notes Component
+
+Storybook Addon Notes Component

package.json

@@ -0,0 +1,64 @@
+{
+ "name": "@kadira/storybook-addon-notes",
+ "version": "0.0.0",
+ "description": "Write notes for your Storybook stories.",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/kadirahq/storybook-addon-notes.git"
+ },
+ "license": "MIT",
+ "scripts": {
+ "prepublish": ". ./.scripts/prepublish.sh",
+ "lint": "eslint src",
+ "lintfix": "eslint src --fix",
+ "testonly": "mocha --require .scripts/mocha_runner src/**/tests/**/*.js",
+ "test": "npm run lint && npm run testonly",
+ "test-watch": "npm run testonly -- --watch --watch-extensions js",
+ "storybook": "start-storybook -p 9010",
+ "publish-storybook": "bash .scripts/publish_storybook.sh"
+ },
+ "devDependencies": {
+ "react": "^15.0.0",
+ "react-dom": "^15.0.0",
+
+ "babel-core": "^6.5.0",
+ "babel-loader": "^6.2.4",
+ "babel-polyfill": "^6.5.0",
+ "babel-preset-es2015": "^6.5.0",
+ "babel-preset-react": "^6.5.0",
+ "babel-preset-stage-2": "^6.5.0",
+ "babel-plugin-transform-runtime": "^6.5.0",
+ "babel-cli": "^6.5.0",
+
+ "eslint": "^2.7.0",
+ "babel-eslint": "^6.0.2",
+ "eslint-config-airbnb": "^7.0.0",
+ "eslint-plugin-babel": "^3.2.0",
+ "eslint-plugin-react": "^4.3.0",
+
+ "mocha": "^2.4.5",
+ "chai": "^3.5.0",
+ "sinon": "^1.17.3",
+ "enzyme": "^2.2.0",
+ "react-addons-test-utils": "^15.0.0",
+ "jsdom": "^8.3.1",
+ "eslint-plugin-jsx-a11y": "^0.6.2",
+
+ "@kadira/storybook": "^2.5.2",
+ "git-url-parse": "^6.0.1"
+ },
+ "peerDependencies": {
+ "react": "^0.14.7 || ^15.0.0",
+ "@kadira/storybook-addons": "^v1.3.1"
+ },
+ "dependencies": {
+ "babel-runtime": "^6.5.0"
+ },
+ "main": "dist/index.js",
+ "engines": {
+ "npm": "^3.0.0"
+ },
+ "keywords": [
+ "react", "storybook", "addon"
+ ]
+}

register.js

@@ -0,0 +1 @@
+require('./dist/register.js');

src/index.js

@@ -0,0 +1,19 @@
+import React from 'react';
+import addons from '@kadira/storybook-addons';
+
+export class WithNotes extends React.Component {
+ render() {
+ const { children, notes } = this.props;
+ const channel = addons.getChannel();
+
+ // send the notes to the channel.
+ channel.emit('kadira/notes/add_notes', notes);
+ // return children elements.
+ return children;
+ }
+}
+
+WithNotes.propTypes = {
+ children: React.PropTypes.node,
+ notes: React.PropTypes.string,
+};

src/register.js

@@ -0,0 +1,74 @@
+import React from 'react';
+import addons from '@kadira/storybook-addons';
+
+const styles = {
+ notesPanel: {
+ margin: 10,
+ fontFamily: 'Arial',
+ fontSize: 14,
+ color: '#444',
+ width: '100%',
+ overflow: 'auto',
+ },
+};
+
+export class Notes extends React.Component {
+ constructor(...args) {
+ super(...args);
+ this.state = { text: '' };
+ this.onAddNotes = this.onAddNotes.bind(this);
+ }
+
+ componentDidMount() {
+ const { channel, api } = this.props;
+ // Listen to the notes and render it.
+ channel.on('kadira/notes/add_notes', this.onAddNotes);
+
+ // Clear the current notes on every story change.
+ this.stopListeningOnStory = api.onStory(() => {
+ this.onAddNotes('');
+ });
+ }
+
+ // This is some cleanup tasks when the Notes panel is unmounting.
+ componentWillUnmount() {
+ if (this.stopListeningOnStory) {
+ this.stopListeningOnStory();
+ }
+
+ this.unmounted = true;
+ const { channel } = this.props;
+ channel.removeListener('kadira/notes/add_notes', this.onAddNotes);
+ }
+
+ onAddNotes(text) {
+ this.setState({ text });
+ }
+
+ render() {
+ const { text } = this.state;
+ const textAfterFormatted = text ? text.trim().replace(/\n/g, '<br />') : '';
+
+ return (
+ <div style={styles.notesPanel}>
+ <div dangerouslySetInnerHTML={{ __html: textAfterFormatted }} />
+ </div>
+ );
+ }
+}
+
+Notes.propTypes = {
+ channel: React.PropTypes.object,
+ api: React.PropTypes.object,
+};
+
+// Register the addon with a unique name.
+addons.register('kadira/notes', (api) => {
+ // Also need to set a unique name to the panel.
+ addons.addPanel('kadira/notes/panel', {
+ title: 'Notes',
+ render: () => (
+ <Notes channel={addons.getChannel()} api={api} />
+ ),
+ });
+});

src/tests/index.js

@@ -0,0 +1,5 @@
+const { describe, it } = global;
+
+describe('Storybook Addon Notes', () => {
+ it('should have some tests');
+});