Add examples for vanilla and React

Examples are provided for Vanilla and React.

README.md

@@ -0,0 +1,9 @@
+# goofy-goober
+
+Minimal styling, powered by Goober.
+
+Generate class names, while only focusing on pluggable styles.
+
+## Usage
+
+See the [examples folder](./examples) for usage details.

examples/README.md

@@ -0,0 +1,7 @@
+# goofy-goober
+## Examples
+
+The current list of available examples are as follows:
+
+- [Vanilla](./vanilla)
+- [React (using Next)](./react-next)

examples/react-next/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

examples/react-next/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

examples/react-next/README.md

@@ -0,0 +1,8 @@
+# goofy-goober
+# React Example (using [Next](https://nextjs.org))
+
+The setup for Next can be found in [src/pages/_app.tsx](./src/pages/_app.tsx) for the initialization and
+[src/pages/_document.tsx](./src/pages/_document.tsx) for collecting styles for server-side rendering. Actual usage can
+be found in [src/pages/index.tsx](./src/pages/index.tsx).
+
+Install dependencies and run the example, which can be viewed on `http://localhost:3000`.

examples/react-next/next.config.js

@@ -0,0 +1,9 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  experimental: {
+    externalDir: true,
+  },
+}
+
+module.exports = nextConfig

examples/react-next/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@tesseract-design/goofy-goober-example-react-next",
+  "version": "0.1.0",
+  "private": true,
+  "description": "Example project using goofy-goober",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "alias": {
+    "@tesseract-design/goofy-goober": "../../src"
+  },
+  "dependencies": {
+    "@types/node": "18.15.11",
+    "@types/react": "18.0.33",
+    "@types/react-dom": "18.0.11",
+    "eslint": "8.38.0",
+    "eslint-config-next": "13.3.0",
+    "next": "13.3.0",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "typescript": "5.0.4"
+  }
+}

examples/react-next/public/next.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>

examples/react-next/public/vercel.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 283 64"><path fill="black" d="M141 16c-11 0-19 7-19 18s9 18 20 18c7 0 13-3 16-7l-7-5c-2 3-6 4-9 4-5 0-9-3-10-7h28v-3c0-11-8-18-19-18zm-9 15c1-4 4-7 9-7s8 3 9 7h-18zm117-15c-11 0-19 7-19 18s9 18 20 18c6 0 12-3 16-7l-8-5c-2 3-5 4-8 4-5 0-9-3-11-7h28l1-3c0-11-8-18-19-18zm-10 15c2-4 5-7 10-7s8 3 9 7h-19zm-39 3c0 6 4 10 10 10 4 0 7-2 9-5l8 5c-3 5-9 8-17 8-11 0-19-7-19-18s8-18 19-18c8 0 14 3 17 8l-8 5c-2-3-5-5-9-5-6 0-10 4-10 10zm83-29v46h-9V5h9zM37 0l37 64H0L37 0zm92 5-27 48L74 5h10l18 30 17-30h10zm59 12v10l-3-1c-6 0-10 4-10 10v15h-9V17h9v9c0-5 6-9 13-9z"/></svg>

examples/react-next/src/pages/_app.tsx

@@ -0,0 +1,10 @@
+import type { AppProps } from 'next/app'
+import * as React from 'react';
+import { setup } from '@tesseract-design/goofy-goober';
+import * as prefixer from 'goober/prefixer';
+
+setup(React.createElement, prefixer.prefix);
+
+export default function App({ Component, pageProps }: AppProps) {
+  return <Component {...pageProps} />
+}

examples/react-next/src/pages/_document.tsx

@@ -0,0 +1,44 @@
+import NextDocument, {Html, Head, Main, NextScript, DocumentContext} from 'next/document';
+import { extractCss } from '@tesseract-design/goofy-goober';
+
+
+export default class Document extends NextDocument {
+  static async getInitialProps(ctx: DocumentContext) {
+    const page = await ctx.renderPage()
+
+    const style = extractCss();
+
+    const initialProps = await NextDocument.getInitialProps(ctx)
+
+    return {
+      ...initialProps,
+      ...page,
+      style,
+    }
+  }
+
+  render() {
+    const { style: rawStyle } = this.props as Record<string, unknown>
+    const style = rawStyle as string
+
+    return (
+      <Html>
+        <Head>
+          {
+            style.length > 0
+            && (
+              <style
+                id="_goober"
+                dangerouslySetInnerHTML={{ __html: style }}
+              />
+            )
+          }
+        </Head>
+        <body>
+          <Main />
+          <NextScript />
+        </body>
+      </Html>
+    )
+  }
+}

examples/react-next/src/pages/index.tsx

@@ -0,0 +1,36 @@
+import {css} from '@tesseract-design/goofy-goober';
+
+const getClassName = (borderColor?: string) => css.cx(
+  css`
+    padding: 1rem;
+  `,
+  css.nest('.child-class')(
+    css`
+      color: red;
+    `,
+  ),
+  css.media('(min-width: 600px)')(
+    css`
+      padding: 2rem;
+    `,
+  ),
+  css.if(typeof borderColor === 'string')(
+    css`
+      border-width: 1px;
+      border-style: solid;
+    `
+  ),
+  css.dynamic({
+    'border-color': borderColor,
+  }),
+)
+
+export default function Home() {
+  return (
+    <div className={getClassName('red')}>
+      <div className="child-class">
+        Hello World
+      </div>
+    </div>
+  )
+}

examples/react-next/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "paths": {
+      "@/*": ["./src/*"],
+      "@tesseract-design/goofy-goober": ["../../src"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}

examples/vanilla/.gitignore

@@ -0,0 +1 @@
+.parcel-cache

examples/vanilla/README.md

@@ -0,0 +1,7 @@
+# goofy-goober
+# Vanilla Example
+
+The usage for vanilla can be found in [script.ts](./script.ts).
+
+This example runs on Parcel. Install dependencies and run the example, which
+can be viewed on `http://localhost:1234`.

examples/vanilla/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en-PH">
+  <head>
+    <meta charset="UTF-8">
+    <title>Goofy Goober Example</title>
+  </head>
+  <body>
+    <script type="module" src="script.ts"></script>
+  </body>
+</html>

examples/vanilla/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@tesseract-design/goofy-goober-example-vanilla",
+  "version": "1.0.0",
+  "description": "Example project using goofy-goober",
+  "main": "index.js",
+  "repository": "https://code.modal.sh/tesseract-design/goofy-goober",
+  "author": "TheoryOfNekomata <allan.crisostomo@outlook.com>",
+  "license": "MIT",
+  "private": false,
+  "dependencies": {
+    "parcel": "^2.8.3"
+  },
+  "alias": {
+    "@tesseract-design/goofy-goober": "../../src"
+  },
+  "scripts": {
+    "start": "parcel index.html"
+  }
+}

examples/vanilla/script.ts

@@ -0,0 +1,44 @@
+import { css, extractCss } from '@tesseract-design/goofy-goober';
+
+const getClassName = (borderColor?: string) => css.cx(
+  css`
+    padding: 1rem;
+  `,
+  css.nest('.child-class')(
+    css`
+      color: red;
+    `,
+  ),
+  css.media('(min-width: 600px)')(
+    css`
+      padding: 2rem;
+    `,
+  ),
+  css.if(typeof borderColor === 'string')(
+    css`
+      border-width: 1px;
+      border-style: solid;
+    `
+  ),
+  css.dynamic({
+    'border-color': borderColor,
+  }),
+)
+
+// Use setup() only with React/Preact
+
+const element = document.createElement('div')
+const childElement = document.createElement('div')
+childElement.classList.add('child-class')
+childElement.innerText = 'Hello, world!'
+element.appendChild(childElement)
+element.classList.add(...getClassName('red').split(' '))
+document.body.appendChild(element)
+
+const styleId = 'goofy-goober'
+const style = document.getElementById(styleId) ?? document.createElement('style')
+style.id = styleId
+style.innerText = extractCss()
+if (style.parentElement === null) {
+  document.head.appendChild(style)
+}

examples/vanilla/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "sourceMap": true,
+    "paths": {
+      "@tesseract-design/goofy-goober": ["../../src"]
+    },
+    "moduleResolution": "Node"
+  },
+  "exclude": [
+    "node_modules"
+  ]
+}