Merge pull request #71 from code-hike/add-storybook-docs

pomber · web-flow · commit 18f1a5e7e2b6 · 2021-07-11T12:53:56.000+01:00
Add storybook docs
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,5 @@ dist
 yarn-error.log
 .prettierignore
 .env
-.vscode
+.vscode
+storybook-static
diff --git a/.gitmodules b/.gitmodules
diff --git a/contributing.md b/contributing.md
diff --git a/external/new-react-website b/external/new-react-website
diff --git a/external/site b/external/site
diff --git a/package.json b/package.json
@@ -12,6 +12,7 @@
     "watch-package": "lerna run --scope @*/mini-frame --include-dependencies --parallel x -- watch",
     "watch-all": "lerna run --parallel x -- watch",
     "storybook": "lerna run --scope storybook start --stream",
+    "docs": "lerna run build-docs --stream",
     "dev": "lerna run --scope react-website dev --stream",
     "release": "auto shipit"
   },
diff --git a/packages/mini-browser/src/use-steps.tsx b/packages/mini-browser/src/use-steps.tsx
@@ -1,11 +1,26 @@
 import React from "react"
 
 type MiniBrowserStep = {
+  /**
+   * The url to display on the navigation bar.
+   */
   url?: string
+  /**
+   * Override the url used for the iframe and "Open in new tab" button.
+   */
   loadUrl?: string
-  children?: React.ReactNode
+  /**
+   * Scale the content of the browser.
+   */
   zoom?: number
+  /**
+   * Prepend the current origin to the url.
+   */
   prependOrigin?: boolean
+  /**
+   * The content to display in the browser. If not provided, an iframe for the url will be displayed.
+   */
+  children?: React.ReactNode
 }
 
 type InternalStep = {
diff --git a/packages/storybook/package.json b/packages/storybook/package.json
@@ -3,8 +3,9 @@
   "private": true,
   "version": "0.3.0-next.0",
   "scripts": {
-    "start": "start-storybook -c ./src",
-    "build-storybook": "build-storybook -c ./src -o ./dist"
+    "start": "start-storybook -c ./src -s ./public",
+    "build-storybook": "build-storybook -c ./src -s ./public -o ./dist",
+    "build-docs": "build-storybook -c ./src -s ./public --docs"
   },
   "dependencies": {
     "@code-hike/code-diff": "0.3.0-next.0",
@@ -17,16 +18,16 @@
     "@code-hike/sim-user": "0.3.0-next.0",
     "@code-hike/smooth-column": "0.3.0-next.0",
     "@code-hike/smooth-lines": "0.3.0-next.0",
-    "@storybook/addon-actions": "^6.0.26",
-    "@storybook/addon-controls": "^6.0.26",
-    "@storybook/addon-docs": "^6.0.26",
     "prism-svelte": "^0.4.7",
     "react": "^16.9.0",
     "react-dom": "^16.9.0"
   },
   "devDependencies": {
     "@babel/core": "^7.4.5",
-    "@storybook/react": "^6.0.26",
+    "@storybook/addon-essentials": "^6.3.0",
+    "@storybook/addons": "^6.3.2",
+    "@storybook/react": "^6.3.0",
+    "@storybook/theming": "^6.3.2",
     "babel-loader": "^8.0.6",
     "chromatic": "^5.9.2"
   }
diff --git a/packages/storybook/public/codehike.png b/packages/storybook/public/codehike.png
diff --git a/packages/storybook/public/favicon-16x16.png b/packages/storybook/public/favicon-16x16.png
diff --git a/packages/storybook/public/favicon-32x32.png b/packages/storybook/public/favicon-32x32.png
diff --git a/packages/storybook/public/favicon-96x96.png b/packages/storybook/public/favicon-96x96.png
diff --git a/packages/storybook/public/favicon.ico b/packages/storybook/public/favicon.ico
diff --git a/packages/storybook/public/logo.png b/packages/storybook/public/logo.png
diff --git a/packages/storybook/src/code.story.js b/packages/storybook/src/code.story.js
@@ -4,7 +4,7 @@ import { WithProgress } from "./utils"
 import { codeDiff } from "@code-hike/code-diff"
 
 export default {
-  title: "Smooth Code",
+  title: "Test/Smooth Code",
   argTypes: {
     center: { control: "boolean" },
     containerWidth: {
diff --git a/packages/storybook/src/column.story.js b/packages/storybook/src/column.story.js
@@ -3,7 +3,7 @@ import { WithProgress } from "./utils"
 import { SmoothColumn } from "@code-hike/smooth-column"
 
 export default {
-  title: "Smooth Column",
+  title: "Test/Smooth Column",
 }
 export const oneExitOneEnter = () => {
   const padding = 10
diff --git a/packages/storybook/src/components.tsx b/packages/storybook/src/components.tsx
@@ -0,0 +1,6 @@
+// importing and exporting components
+// so we can use them with Storybook's ArgsTable
+
+import * as mb from "@code-hike/mini-browser"
+
+export const MiniBrowser = mb.MiniBrowser
diff --git a/packages/storybook/src/intro.story.mdx b/packages/storybook/src/intro.story.mdx
@@ -0,0 +1,7 @@
+import { Meta, Story, Canvas } from "@storybook/addon-docs"
+
+<Meta title="Code Hike" />
+
+The docs for Code Hike's building blocks.
+
+For more info and higher level packages, see [codehike.org](https://codehike.org).
diff --git a/packages/storybook/src/main.js b/packages/storybook/src/main.js
@@ -1,8 +1,20 @@
 module.exports = {
-  stories: ["*.story.js"],
+  stories: ["intro.story.mdx", "*.story.@(js|mdx|tsx)"],
   addons: [
     "@storybook/addon-docs",
     "@storybook/addon-controls",
     "@storybook/addon-actions",
   ],
+  typescript: {
+    reactDocgen: "react-docgen-typescript",
+    reactDocgenTypescriptOptions: {
+      propFilter: prop => true,
+      // componentNameResolver: (exp, source) =>
+      //   console.log("!!!$$$", exp, source) || true,
+      compilerOptions: {
+        allowSyntheticDefaultImports: false,
+        esModuleInterop: false,
+      },
+    },
+  },
 }
diff --git a/packages/storybook/src/manager-head.html b/packages/storybook/src/manager-head.html
@@ -0,0 +1,24 @@
+<link
+  rel="icon"
+  type="image/png"
+  sizes="32x32"
+  href="/favicon-32x32.png"
+/>
+<link
+  rel="icon"
+  type="image/png"
+  sizes="16x16"
+  href="/favicon-16x16.png"
+/>
+
+<style>
+  .sidebar-header > *:first-child {
+    margin: 0;
+  }
+  .sidebar-header > *:nth-child(2) {
+    display: none;
+  }
+  .search-field {
+    display: none !important;
+  }
+</style>
diff --git a/packages/storybook/src/manager.js b/packages/storybook/src/manager.js
@@ -0,0 +1,38 @@
+import { addons } from "@storybook/addons"
+import { create } from "@storybook/theming"
+
+const isProd = process.env.NODE_ENV === "production"
+
+// https://storybook.js.org/docs/react/configure/theming
+const theme = create({
+  base: "light",
+  brandTitle: "Code Hike",
+  brandUrl: "https://codehike.org",
+  brandImage: "/codehike.png",
+  appBg: "#ffffff",
+  appContentBg: "#eaedf6",
+})
+
+// https://storybook.js.org/docs/react/configure/features-and-behavior
+addons.setConfig({
+  theme,
+  isFullscreen: false,
+  showNav: true,
+  showPanel: false,
+  panelPosition: "bottom",
+  enableShortcuts: false,
+  isToolshown: true,
+  selectedPanel: undefined,
+  initialActive: "sidebar",
+  sidebar: {
+    showRoots: true,
+    collapsedRoots: ["test"],
+  },
+  toolbar: {
+    title: { hidden: false },
+    zoom: { hidden: true },
+    eject: { hidden: false },
+    copy: { hidden: true },
+    fullscreen: { hidden: true },
+  },
+})
diff --git a/packages/storybook/src/mini-browser-hike.story.js b/packages/storybook/src/mini-browser-hike.story.js
@@ -4,7 +4,7 @@ import "@code-hike/mini-browser/dist/index.css"
 import { WithProgress, Page } from "./utils"
 
 export default {
-  title: "Mini Browser Hike",
+  title: "Test/Mini Browser Hike",
 }
 
 export const basic = () => (
diff --git a/packages/storybook/src/mini-browser.story.js b/packages/storybook/src/mini-browser.story.js
@@ -4,7 +4,7 @@ import "@code-hike/mini-browser/dist/index.css"
 import { WithProgress, Page } from "./utils"
 
 export default {
-  title: "Mini Browser",
+  title: "Test/Mini Browser",
 }
 
 export const basic = () => (
diff --git a/packages/storybook/src/mini-browser.story.mdx b/packages/storybook/src/mini-browser.story.mdx
@@ -0,0 +1,67 @@
+import {
+  Meta,
+  Story,
+  Canvas,
+  ArgsTable,
+} from "@storybook/addon-docs"
+import { MiniBrowser } from "./components"
+
+<Meta
+  title="Mini Browser"
+  component={MiniBrowser}
+  argTypes={{ url: { control: { type: "text" } } }}
+/>
+
+# `<MiniBrowser />`
+
+Import it with:
+
+```js
+import { MiniBrowser } from "@code-hike/mini-browser"
+```
+
+A component that looks like a browser.
+
+### Usage without `children`
+
+If you don't pass `children`, it will show an iframe using the `url` prop. If you want to display an url but load a different one use the `loadUrl` prop.
+
+export const Template = props => <MiniBrowser {...props} />
+
+<Canvas>
+  <Story
+    name="MiniBrowser without children"
+    args={{
+      url: "google.com",
+      loadUrl: "https://whatismyviewport.com/",
+      zoom: 0.5,
+      style: { height: "200px" },
+    }}
+    argTypes={{ url: { control: { type: "text" } } }}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
+
+## Props
+
+<ArgsTable story="MiniBrowser without children" />
+
+## Usage with `children`
+
+If you pass `children`, it will render the children inside the iframe.
+
+<Canvas>
+  <Story
+    name="MiniBrowser with children"
+    args={{
+      url: "google.com",
+      loadUrl: "https://whatismyviewport.com/",
+      style: { height: "200px" },
+      children: <h1>This is a child</h1>,
+    }}
+    argTypes={{ url: { control: { type: "text" } } }}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
diff --git a/packages/storybook/src/mini-editor-hike.story.js b/packages/storybook/src/mini-editor-hike.story.js
@@ -4,7 +4,7 @@ import { Page, WithProgress } from "./utils"
 import "@code-hike/mini-editor/dist/index.css"
 
 export default {
-  title: "Mini Editor Hike",
+  title: "Test/Mini Editor Hike",
 }
 
 const code1 = `console.log(1)`
diff --git a/packages/storybook/src/mini-editor-tween.story.js b/packages/storybook/src/mini-editor-tween.story.js
@@ -4,7 +4,7 @@ import { WithProgress } from "./utils"
 import "@code-hike/mini-editor/dist/index.css"
 
 export default {
-  title: "Mini Editor Tween",
+  title: "Test/Mini Editor Tween",
 }
 
 export const oneToOne = () => {
diff --git a/packages/storybook/src/mini-editor.story.js b/packages/storybook/src/mini-editor.story.js
@@ -4,7 +4,7 @@ import { Page } from "./utils"
 import "@code-hike/mini-editor/dist/index.css"
 
 export default {
-  title: "Mini Editor",
+  title: "Test/Mini Editor",
 }
 
 const code1 = `console.log(1)
diff --git a/packages/storybook/src/mini-frame.story.js b/packages/storybook/src/mini-frame.story.js
@@ -7,7 +7,7 @@ import "@code-hike/mini-frame/dist/index.css"
 import { Page } from "./utils"
 
 export default {
-  title: "Mini Frame",
+  title: "Test/Mini Frame",
 }
 
 export const basic = () => (
diff --git a/packages/storybook/src/mini-terminal.story.js b/packages/storybook/src/mini-terminal.story.js
@@ -7,7 +7,7 @@ import { WithProgress, Page } from "./utils"
 import "@code-hike/mini-terminal/dist/index.css"
 
 export default {
-  title: "Mini Terminal",
+  title: "Test/Mini Terminal",
 }
 
 export const basic = () => (
diff --git a/packages/storybook/src/player.story.js b/packages/storybook/src/player.story.js
@@ -4,7 +4,7 @@ import { Video, Controls } from "@code-hike/player"
 import videoSrc from "./assets/timer.mp4"
 
 export default {
-  title: "Player",
+  title: "Test/Player",
 }
 
 const src = videoSrc
diff --git a/packages/storybook/src/scroller.story.js b/packages/storybook/src/scroller.story.js
@@ -3,7 +3,7 @@ import { Page } from "./utils"
 import { Scroller, Step } from "@code-hike/scroller"
 
 export default {
-  title: "Scroller",
+  title: "Test/Scroller",
 }
 
 const steps = [1, 2, 3, 4, 5, 6, 7]
diff --git a/packages/storybook/src/scrollycoding.story.js b/packages/storybook/src/scrollycoding.story.js
@@ -15,7 +15,7 @@ import RepeatedSteps from "./assets/scrollycoding.repeat.mdx"
 import { MDXProvider } from "@mdx-js/react"
 
 export default {
-  title: "ScrollyCoding",
+  title: "Test/ScrollyCoding",
 }
 
 export function basic() {
diff --git a/packages/storybook/src/sim-user.story.js b/packages/storybook/src/sim-user.story.js
@@ -3,7 +3,7 @@ import { Page } from "./utils"
 import { sim } from "@code-hike/sim-user"
 
 export default {
-  title: "Sim User",
+  title: "Test/Sim User",
 }
 export const click = () => {
   const [count, setCount] = React.useState(0)
diff --git a/packages/storybook/src/smooth-lines.story.js b/packages/storybook/src/smooth-lines.story.js
@@ -3,7 +3,7 @@ import { SmoothLines } from "@code-hike/smooth-lines"
 import { WithProgress } from "./utils"
 
 export default {
-  title: "Smooth Lines",
+  title: "Test/Smooth Lines",
   argTypes: {
     center: { control: "boolean" },
     containerWidth: {
diff --git a/packages/storybook/src/steps.story.js b/packages/storybook/src/steps.story.js
diff --git a/yarn.lock b/yarn.lock
