mfrachet · mfrachet · Nov 14, 2018 · Nov 14, 2018
diff --git a/.npmignore b/.npmignore
@@ -4,4 +4,5 @@ setup
 node_modules
 coverage
 .*
-yarn.lock
+yarn.lock
+example/
diff --git a/example/.gitignore b/example/.gitignore
@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,44 @@
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.<br>
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br>
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.<br>
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.<br>
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br>
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
diff --git a/example/package.json b/example/package.json
@@ -0,0 +1,26 @@
+{
+  "name": "use-socket-example",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "react": "16.7.0-alpha.0",
+    "react-dom": "16.7.0-alpha.0",
+    "react-scripts": "2.1.1",
+    "use-socket": "mfrachet/use-socket"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": [
+    ">0.2%",
+    "not dead",
+    "not ie <= 11",
+    "not op_mini all"
+  ]
+}
diff --git a/example/public/favicon.ico b/example/public/favicon.ico
diff --git a/example/public/index.html b/example/public/index.html
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1, shrink-to-fit=no"
+    />
+    <meta name="theme-color" content="#000000" />
+    <!--
+      manifest.json provides metadata used when your web app is added to the
+      homescreen on Android. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags 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>use-socket</title>
+  </head>
+  <body>
+    <noscript> You need to enable JavaScript to run this app. </noscript>
+    <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` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
diff --git a/example/public/manifest.json b/example/public/manifest.json
@@ -0,0 +1,15 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/example/src/App.js b/example/src/App.js
@@ -0,0 +1,34 @@
+import React from "react";
+import { ClientSocket } from "use-socket";
+import { Browser } from "./components/Browser";
+import { Navbar } from "./components/Navbar";
+import { Profile } from "./components/Profile";
+import { Cols, Col } from "./components/Cols";
+import { Feed } from "./components/Feed";
+import { Box } from "./components/Box";
+
+const items = [1, 2, 3];
+
+export const App = () => (
+  <ClientSocket url="https://socket-io-tweet-stream.now.sh">
+    <div className="container">
+      <Browser>
+        <Navbar leftItems={items} rightItems={items} />
+        <Cols>
+          <Col>
+            <Profile />
+            <Box />
+          </Col>
+          <Col size={3}>
+            <Feed />
+          </Col>
+          <Col>
+            <Box />
+          </Col>
+        </Cols>
+      </Browser>
+    </div>
+  </ClientSocket>
+);
+
+export default App;
diff --git a/example/src/components/Box.css b/example/src/components/Box.css
@@ -0,0 +1,15 @@
+.box {
+  border-radius: 5px;
+  border: 3px solid #dddddd;
+  background-color: #ffffff;
+  height: 200px;
+  margin-left: 20px;
+  margin-right: 20px;
+  padding: 20px;
+}
+
+.box-title {
+  height: 10px;
+  width: 100px;
+  background-color: #dddddd;
+}
diff --git a/example/src/components/Box.js b/example/src/components/Box.js
@@ -0,0 +1,8 @@
+import React from "react";
+import "./Box.css";
+
+export const Box = () => (
+  <div className="box">
+    <div className="box-title" />
+  </div>
+);
diff --git a/example/src/components/Browser.css b/example/src/components/Browser.css
@@ -0,0 +1,68 @@
+/* The browser window */
+.browser {
+  border: 3px solid #dddddd;
+  border-radius: 5px;
+  background-color: #efefef;
+  height: calc(100vh - 46px);
+  overflow: auto;
+}
+
+/* Container for columns and the top "toolbar" */
+.browser-row {
+  padding: 10px;
+  display: flex;
+  background: #dddddd;
+}
+
+/* Create three unequal columns that floats next to each other */
+.browser-column {
+  float: left;
+}
+
+.browser-middle {
+  flex: 1;
+  margin: 0 20px;
+}
+
+/* Clear floats after the columns */
+.browser-row:after {
+  content: "";
+  display: table;
+  clear: both;
+}
+
+/* Three dots */
+.browser-dot {
+  margin-top: 4px;
+  height: 12px;
+  width: 12px;
+  background-color: #bbb;
+  border-radius: 50%;
+  display: inline-block;
+  margin-left: 4px;
+}
+
+/* Style the input field */
+input.browser-input {
+  width: 100%;
+  border-radius: 3px;
+  border: none;
+  background-color: white;
+  margin-top: -8px;
+
+  color: #666;
+  padding: 5px;
+}
+
+/* Three bars (hamburger menu) */
+.browser-bar {
+  width: 17px;
+  height: 3px;
+  background-color: #aaa;
+  margin: 3px 0;
+  display: block;
+}
+
+/* Page content */
+.browser-content {
+}
diff --git a/example/src/components/Browser.js b/example/src/components/Browser.js
@@ -0,0 +1,29 @@
+import React from "react";
+import "./Browser.css";
+
+export const Browser = ({ children }) => (
+  <div className="browser">
+    <div className="browser-row">
+      <div className="browser-column">
+        <span className="browser-dot" style={{ background: "#ED594A" }} />
+        <span className="browser-dot" style={{ background: "#FDD800" }} />
+        <span className="browser-dot" style={{ background: "#5AC05A" }} />
+      </div>
+      <div className="browser-column browser-middle">
+        <input
+          type="text"
+          value="https://twitter.com/"
+          readOnly
+          className="browser-input"
+        />
+      </div>
+      <div className="browser-column">
+        <span className="browser-bar" />
+        <span className="browser-bar" />
+        <span className="browser-bar" />
+      </div>
+    </div>
+
+    <div className="browser-content">{children}</div>
+  </div>
+);
diff --git a/example/src/components/Cols.css b/example/src/components/Cols.css
diff --git a/example/src/components/Cols.js b/example/src/components/Cols.js
@@ -0,0 +1,9 @@
+import React from "react";
+
+export const Col = ({ size = 1, children }) => (
+  <div style={{ flex: size }}>{children}</div>
+);
+
+export const Cols = ({ children }) => (
+  <div style={{ display: "flex" }}>{children}</div>
+);
diff --git a/example/src/components/Feed.css b/example/src/components/Feed.css
@@ -0,0 +1,38 @@
+.feed {
+  background-color: #ffffff;
+  margin-bottom: 20px;
+}
+
+.feed-item {
+  padding: 20px;
+  border-bottom: 1px solid #dddddd;
+  animation: appear 0.3s ease-in-out;
+}
+
+.feed-author {
+  font-weight: bold;
+}
+
+.feed-authorname {
+  color: #666666;
+}
+
+.feed-avatar {
+  height: 40px;
+  width: 40px;
+  border-radius: 50%;
+  float: left;
+  margin-right: 10px;
+}
+
+@keyframes appear {
+  from {
+    opacity: 0;
+    margin-top: -10px;
+  }
+
+  to {
+    opacity: 1;
+    margin-top: 0px;
+  }
+}