docs: add logo in sidebar example

Author: rakannimer

examples/logo-in-sidebar/.gitignore

@@ -0,0 +1,2 @@
+.docz
+node_modules

examples/logo-in-sidebar/README.md

@@ -0,0 +1,41 @@
+# Logo In Sidebar Docz example
+
+## Using `create-docz-app`
+
+```sh
+npx create-docz-app docz-app-logo-in-sidebar --example logo-in-sidebar
+# or
+yarn create docz-app docz-app-logo-in-sidebar --example logo-in-sidebar
+```
+
+## Download manually
+
+```sh
+curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/logo-in-sidebar
+mv logo-in-sidebar docz-logo-in-sidebar-example
+cd docz-logo-in-sidebar-example
+```
+
+## Setup
+
+```sh
+yarn # npm i
+```
+
+## Run
+
+```sh
+yarn dev # npm run dev
+```
+
+## Build
+
+```sh
+yarn build # npm run build
+```
+
+## Serve built app
+
+```sh
+yarn serve # npm run serve
+```

examples/logo-in-sidebar/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "docz-example-logo-in-sidebar",
+  "private": true,
+  "version": "2.0.0-rc.41",
+  "license": "MIT",
+  "files": [
+    "src/",
+    "doczrc.js",
+    "package.json"
+  ],
+  "scripts": {
+    "dev": "docz dev",
+    "build": "docz build",
+    "serve": "docz serve"
+  },
+  "dependencies": {
+    "docz": "next",
+    "prop-types": "^15.7.2",
+    "react": "^16.8.6",
+    "react-dom": "^16.8.6",
+    "scheduler": "^0.15.0"
+  }
+}

examples/logo-in-sidebar/src/components/Alert.jsx

@@ -0,0 +1,34 @@
+import React from "react";
+import t from "prop-types";
+
+const kinds = {
+  info: "#5352ED",
+  positive: "#2ED573",
+  negative: "#FF4757",
+  warning: "#FFA502"
+};
+
+export const Alert = ({ children, kind, ...rest }) => (
+  <div
+    style={{
+      padding: 20,
+      borderRadius: 3,
+      color: "white",
+      background: kinds[kind] || "white"
+    }}
+    {...rest}
+  >
+    {children}
+  </div>
+);
+
+Alert.propTypes = {
+  /**
+   * The kind prop is used to set the alert's background color
+   */
+  kind: t.oneOf(["info", "positive", "negative", "warning"])
+};
+
+Alert.defaultProps = {
+  kind: "info"
+};

examples/logo-in-sidebar/src/components/Alert.mdx

@@ -0,0 +1,28 @@
+---
+name: Alert
+menu: Components
+---
+
+import { Playground, Props } from 'docz'
+import { Alert } from './Alert'
+
+# Alert
+
+## Properties
+
+<Props of={Alert} />
+
+## Basic usage
+
+<Playground>
+  <Alert>Some message</Alert>
+</Playground>
+
+## Using different kinds
+
+<Playground>
+  <Alert kind="info">Some message</Alert>
+  <Alert kind="positive">Some message</Alert>
+  <Alert kind="negative">Some message</Alert>
+  <Alert kind="warning">Some message</Alert>
+</Playground>

examples/logo-in-sidebar/src/gatsby-theme-docz/components/Header/index.js

@@ -0,0 +1,3 @@
+export const Header = () => {
+  return null;
+};

examples/logo-in-sidebar/src/gatsby-theme-docz/components/Sidebar/index.js

@@ -0,0 +1,58 @@
+/** @jsx jsx */
+import React, { useState, useRef, useEffect } from "react";
+import { Global } from "@emotion/core";
+import { jsx, Box } from "theme-ui";
+import { useMenus, useCurrentDoc } from "docz";
+
+import * as styles from "gatsby-theme-docz/src/components/Sidebar/styles";
+import { NavSearch } from "gatsby-theme-docz/src/components/NavSearch";
+import { NavLink } from "gatsby-theme-docz/src/components/NavLink";
+import { NavGroup } from "gatsby-theme-docz/src/components/NavGroup";
+
+export const Sidebar = React.forwardRef((props, ref) => {
+  const [query, setQuery] = useState("");
+  const menus = useMenus({ query });
+  const currentDoc = useCurrentDoc();
+  const currentDocRef = useRef();
+  const handleChange = ev => {
+    setQuery(ev.target.value);
+  };
+  useEffect(() => {
+    if (ref.current && currentDocRef.current) {
+      ref.current.scrollTo(0, currentDocRef.current.offsetTop);
+    }
+  }, []);
+  return (
+    <>
+      <Box onClick={props.onClick} sx={styles.overlay(props)}>
+        {props.open && <Global styles={styles.global} />}
+      </Box>
+      <Box ref={ref} sx={styles.wrapper(props)} data-testid="sidebar">
+        <img src="https://placekitten.com/200/100" />
+
+        <NavSearch
+          placeholder="Type to search..."
+          value={query}
+          onChange={handleChange}
+        />
+        {menus &&
+          menus.map(menu => {
+            if (!menu.route)
+              return <NavGroup key={menu.id} item={menu} sidebarRef={ref} />;
+            if (menu.route === currentDoc.route) {
+              return (
+                <NavLink key={menu.id} item={menu} ref={currentDocRef}>
+                  {menu.name}
+                </NavLink>
+              );
+            }
+            return (
+              <NavLink key={menu.id} item={menu}>
+                {menu.name}
+              </NavLink>
+            );
+          })}
+      </Box>
+    </>
+  );
+});

examples/logo-in-sidebar/src/index.mdx

@@ -0,0 +1,34 @@
+---
+name: Getting Started
+route: /
+---
+
+# Getting Started
+
+Design systems enable teams to build better products faster by making design reusable—reusability makes scale possible. This is the heart and primary value of design systems. A design system is a collection of reusable components, guided by clear standards, that can be assembled together to build any number of applications.
+
+Regardless of the technologies and tools behind them, a successful design system follows these guiding principles:
+
+- **It’s consistent**. The way components are built and managed follows a predictable pattern.
+- **It’s self-contained**. Your design system is treated as a standalone dependency.
+- **It’s reusable**. You’ve built components so they can be reused in many contexts.
+- **It’s accessible**. Applications built with your design system are usable by as many people as possible, no matter how they access the web.
+- **It’s robust**. No matter the product or platform to which your design system is applied, it should perform with grace and minimal bugs.
+
+## Consistency
+
+Your first, most important task when starting out is to define the rules of your system, document them, and ensure that everyone follows them. When you have clearly documented code standards and best practices in place, designers and developers from across your organization can easily use and, more importantly, contribute to your design system.
+
+Design systems enable teams to build better products faster by making design reusable—reusability makes scale possible. This is the heart and primary value of design systems. A design system is a collection of reusable components, guided by clear standards, that can be assembled together to build any number of applications.
+
+Regardless of the technologies and tools behind them, a successful design system follows these guiding principles:
+
+- **It’s consistent**. The way components are built and managed follows a predictable pattern.
+- **It’s self-contained**. Your design system is treated as a standalone dependency.
+- **It’s reusable**. You’ve built components so they can be reused in many contexts.
+- **It’s accessible**. Applications built with your design system are usable by as many people as possible, no matter how they access the web.
+- **It’s robust**. No matter the product or platform to which your design system is applied, it should perform with grace and minimal bugs.
+
+## Consistency
+
+Your first, most important task when starting out is to define the rules of your system, document them, and ensure that everyone follows them. When you have clearly documented code standards and best practices in place, designers and developers from across your organization can easily use and, more importantly, contribute to your design system.