Merge pull request #12 from andrewsuzuki/1.3.0

1.3.0
andrewsuzuki · Apr 25, 2017 · d84b3f9 · d84b3f9
2 parents 9ff0474 + 4c48fb6
commit d84b3f9
Show file tree

Hide file tree

Showing 28 changed files with 8,399 additions and 130 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,20 @@
+module.exports = {
+  "env": {
+    "browser": true,
+  },
+  "extends": "airbnb",
+  "parser": "babel-eslint",
+  "rules": {
+    "no-confusing-arrow": 0,
+    "no-shadow": 0,
+    "no-underscore-dangle": 0,
+    "semi": [1, "never"],
+    "arrow-parens": [2, "always"],
+    "import/no-extraneous-dependencies": 0,
+    "import/prefer-default-export": 0,
+    "jsx-a11y/no-static-element-interactions": 0,
+    "react/jsx-filename-extension": [1, { "extensions": [".js", ".jsx"] }],
+    "react/no-unused-prop-types": 0,
+    "react/forbid-prop-types": 0,
+  },
+}
diff --git a/.eslintrc.yml b/.eslintrc.yml
diff --git a/README.md b/README.md
@@ -14,6 +14,8 @@ npm install --save react-twitter-widgets
 
 ## Example
 
+[Click here](./site/screenshot.png) for a preview of all available widgets with example code.
+
 ```javascript
 import { Timeline } from 'react-twitter-widgets'
 // var Timeline = require('react-twitter-widgets').Timeline

diff --git a/package.json b/package.json
@@ -1,13 +1,14 @@
 {
   "name": "react-twitter-widgets",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Twitter widgets as React components",
   "main": "dist/index.js",
   "scripts": {
     "clean": "rimraf dist",
     "build": "npm run clean && babel src --out-dir dist",
     "prepublish": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint src"
   },
   "repository": {
     "type": "git",
@@ -36,23 +37,29 @@
   },
   "homepage": "https://github.com/andrewsuzuki/react-twitter-widgets#readme",
   "devDependencies": {
-    "babel-cli": "^6.6.4",
-    "babel-core": "^6.6.4",
-    "babel-eslint": "^5.0.0",
-    "babel-preset-es2015": "^6.6.0",
-    "babel-preset-react": "^6.5.0",
-    "babel-preset-stage-0": "^6.5.0",
-    "eslint": "^1.10.3",
-    "eslint-plugin-react": "^4.1.0",
+    "babel-cli": "^6.24.1",
+    "babel-core": "^6.24.1",
+    "babel-eslint": "^7.0.0",
+    "babel-preset-es2015": "^6.18.0",
+    "babel-preset-react": "^6.16.0",
+    "babel-preset-stage-0": "^6.16.0",
+    "eslint": "^3.19.0",
+    "eslint-config-airbnb": "^14.1.0",
+    "eslint-plugin-babel": "^4.0.0",
+    "eslint-plugin-import": "^2.2.0",
+    "eslint-plugin-jsx-a11y": "^4.0.0",
+    "eslint-plugin-react": "^6.10.3",
+    "react": "^15.3.0",
     "rimraf": "^2.5.2"
   },
   "dependencies": {
     "exenv": "^1.2.1",
     "lodash.clonedeep": "^4.3.1",
     "lodash.isequal": "^4.1.1",
+    "prop-types": "^15.3.0",
     "scriptjs": "^2.5.8"
   },
   "peerDependencies": {
-    "react": ">=0.13"
+    "react": "^15.3.0"
   }
 }
diff --git a/site/.gitignore b/site/.gitignore
@@ -0,0 +1,18 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
diff --git a/site/package.json b/site/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "site",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "prop-types": "^15.5.8",
+    "react": "^15.5.4",
+    "react-dom": "^15.5.4"
+  },
+  "devDependencies": {
+    "react-scripts": "0.9.5"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test --env=jsdom",
+    "eject": "react-scripts eject"
+  }
+}
diff --git a/site/public/favicon.ico b/site/public/favicon.ico
diff --git a/site/public/index.html b/site/public/index.html
@@ -0,0 +1,31 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
+    <!--
+      Notice the use of %PUBLIC_URL% in the tag above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start`.
+      To create a production bundle, use `npm run build`.
+    -->
+  </body>
+</html>
diff --git a/site/screenshot.png b/site/screenshot.png
diff --git a/site/src/App.css b/site/src/App.css
@@ -0,0 +1,31 @@
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  animation: App-logo-spin infinite 20s linear;
+  height: 80px;
+}
+
+.App-header {
+  display: flex;
+  flex-direction: column;
+  justify-content: space-around;
+  min-height: 280px;
+  padding: 30px;
+  background-color: #222;
+  color: white;
+}
+
+.App-header h1, .App-header h2 {
+  margin: 0;
+}
+
+.App-content {
+  margin-top: 40px;
+}
+
+@keyframes App-logo-spin {
+  from { transform: rotate(0deg); }
+  to { transform: rotate(360deg); }
+}
diff --git a/site/src/App.js b/site/src/App.js
@@ -0,0 +1,35 @@
+import React, { Component } from 'react'
+
+import logo from './logo.svg'
+
+import './App.css'
+
+import WidgetExample from './WidgetExample'
+
+import widgetPropExamples from './widgetPropExamples'
+
+
+class App extends Component {
+  render() {
+    return (
+      <div className="App">
+        <div className="App-header">
+          <img src={logo} className="App-logo" alt="logo" />
+          <h1>react-twitter-widgets</h1>
+          <h2>by Andrew Suzuki (@andrewsuzuki)</h2>
+        </div>
+        <div className="App-content">
+          {Object.keys(widgetPropExamples).map((name) =>
+            <WidgetExample
+              key={name}
+              widget={name}
+              widgetProps={widgetPropExamples[name]}
+            />
+          )}
+        </div>
+      </div>
+    )
+  }
+}
+
+export default App
diff --git a/site/src/App.test.js b/site/src/App.test.js
@@ -0,0 +1,8 @@
+import React from 'react'
+import ReactDOM from 'react-dom'
+import App from './App'
+
+it('renders without crashing', () => {
+  const div = document.createElement('div')
+  ReactDOM.render(<App />, div)
+})
diff --git a/site/src/WidgetExample.css b/site/src/WidgetExample.css
@@ -0,0 +1,16 @@
+.WidgetExample-container {
+  width: 500px;
+  margin: 0 auto 40px;
+  padding: 20px;
+  background: #f0f0f0;
+}
+
+@media screen and (max-width: 550px) {
+  .WidgetExample-container {
+    width: 90%;
+  }
+}
+
+.WidgetExample-container pre {
+  display: inline-block;
+}
diff --git a/site/src/WidgetExample.js b/site/src/WidgetExample.js
@@ -0,0 +1,64 @@
+import React, { Component } from 'react'
+import PropTypes from 'prop-types'
+
+import './WidgetExample.css'
+
+import {
+  Follow,
+  Hashtag,
+  Mention,
+  Share,
+  Timeline,
+  Tweet,
+} from '../../dist'
+
+
+const widgetNameToComponentMap = {
+  Follow,
+  Hashtag,
+  Mention,
+  Share,
+  Timeline,
+  Tweet,
+}
+
+
+const jsonPropertyQuoteRegex = /"([^(")"]+)":/g
+
+
+export default class WidgetExample extends Component {
+  render() {
+    const { widget, widgetProps } = this.props
+
+    const c = widgetNameToComponentMap[widget] || 'div'
+
+    // Generate a string of jsx-like props for
+    // code example based on on widgetProps
+    const propsString = Object.keys(widgetProps).map((wpn) => {
+      const v = widgetProps[wpn]
+
+      const displayValue = (typeof v === 'string')
+        ? `"${v}"`
+        // json-stringify props, then remove quotes from property names
+        : `{${JSON.stringify(widgetProps[wpn]).replace(jsonPropertyQuoteRegex, '$1:')}}`
+
+      return `  ${wpn}=${displayValue}`
+    }).join('\n')
+
+    const exampleCode = `<${widget}\n${propsString}\n/>`
+
+    return (
+      <div className="WidgetExample-container">
+        <h3>{widget}</h3>
+        <pre>{exampleCode}</pre>
+        <br /><br />
+        {React.createElement(c, widgetProps)}
+      </div>
+    )
+  }
+}
+
+WidgetExample.propTypes = {
+  widget: PropTypes.oneOf(Object.keys(widgetNameToComponentMap)).isRequired,
+  widgetProps: PropTypes.object.isRequired,
+}
diff --git a/site/src/index.css b/site/src/index.css
@@ -0,0 +1,21 @@
+html {
+  box-sizing: border-box;
+}
+
+*, *:before, *:after {
+  box-sizing: inherit;
+}
+
+body {
+  margin: 0;
+  padding: 0;
+  font-family: sans-serif;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  margin-top: 0;
+}
+
+pre {
+  text-align: left;
+}
diff --git a/site/src/index.js b/site/src/index.js
@@ -0,0 +1,9 @@
+import React from 'react'
+import ReactDOM from 'react-dom'
+import App from './App'
+import './index.css'
+
+ReactDOM.render(
+  <App />,
+  document.getElementById('root')
+)
diff --git a/site/src/logo.svg b/site/src/logo.svg