UI Spells

Static GPT Tailwind generator for Next.js.

Under development.

Use GPT-4 to generate Tailwind styles from natural language descriptions.

Generated styles are saved to a JSON cache and injected into the application at build-time: No production fetch requests, no FOUC.

Demo

Play with the useSpell() hook in a pre-configured Next.js project on CodeSandbox.

Usage

_{IMPORTANT: You must set the getStaticProps export in order to load
your styles from the JSON cache at build-time.}

After following the Setup instructions below, you can generate styles using the useSpell() hook, like so:

// src/pages/index.tsx
import { useSpell } from "@spellcraft/ui/client";
import { withStylesCache } from "@spellcraft/ui/server";

export default function Home () {
  const styles = useSpell("purple text in small font");

  return (
    <main>
      <span className={styles}>
        hello world
      </span>
    </main>
  );
}

export const getStaticProps = withStylesCache();

_{Note: In production, the hook will not cause a re-render: It is only
used to fetch new styles and add them to the cache in dev mode.}

Setup

First, ensure you create a .env file with your OpenAI API key:

# .env
OPENAI_API_KEY="YOUR-KEY-HERE"

You'll need to configure the following pages to use UI Spells:

pages/_document.tsx
pages/_app.tsx
pages/api/spellcraft.ts

And for every page you use UI Spells, you'll need to ensure getStaticProps exists and is wrapped:

export const getStaticProps = withStylesCache();

We'll go over how to set this up below.

1. Wrap `_document.tsx` with `withDocument()`:

This adds support for SSR-compatible dynamic Tailwind with @twind/next.

// pages/_document.tsx

import { withDocument } from "@spellcraft/ui/document";
export default withDocument();

2. Wrap `_app.tsx` with `withApp()`:

This wraps your app with a cache provider and utilities from @twind/next.

// pages/app.tsx

import { StrictMode } from "react";
import { type AppProps } from "next/app";

import { withApp } from "@spellcraft/ui/client";

export const MyApp = ({ Component, pageProps }: AppProps) => {
  return (
    <StrictMode>
      <Component {...pageProps} />
    </StrictMode>
  );
};

export default withApp(MyApp);

3. Add API route to `pages/api/spellcraft.ts`:

This endpoint is used only in development mode to update your styles cache.

When you publish to production, this endpoint will not run, and the styles will be loaded from the static JSON file at build-time only.

// pages/api/spellcraft.ts

import { StylesAPI } from "@spellcraft/ui/server";
export default StylesAPI;

That's it!

With pages/_document.tsx, pages/_app.tsx, and pages/api/spellcraft.ts configured, you're ready to use the useSpell() hook.

SpellcraftAI/ui