README

UI components for Edge examples

The UI components exported here are being used in every edge example that has an UI. The package ships untranspiled code and only works for Next.js apps that include the following dev dependencies:

TypeScript
Tailwindcss
PostCSS

How to use

1. Package installation

Install the package with npm or yarn:

npm i @vercel/edge-functions-ui
// or
yarn add @vercel/edge-functions-ui

If the app doesn't already have the required dev dependencies install them like so:

npm i typescript tailwindcss postcss autoprefixer
// or
yarn add typescript tailwindcss postcss autoprefixer

2. Tailwindcss setup

Because the package is untranspiled, in order to get it working in your next.js app you'll need to add the following to next.config.js:

const withTM = require('@vercel/edge-functions-ui/transpile')()

module.exports = withTM({
  // Your next.js config
})

Now, if the app already has a tailwind.config.js file, open it and add the following preset and purge path:

module.exports = {
  presets: [require('@vercel/edge-functions-ui/tailwind')],
  purge: ['node_modules/@vercel/edge-functions-ui/**/*.{js,ts,jsx,tsx}'],
}

Otherwise, create it with:

module.exports = {
  presets: [require('@vercel/edge-functions-ui/tailwind')],
  purge: [
    './pages/**/*.{js,ts,jsx,tsx}',
    'node_modules/@vercel/edge-functions-ui/**/*.{js,ts,jsx,tsx}',
    // Include other paths where you use tailwind
  ],
  darkMode: false, // or 'media' or 'class'
  variants: {
    extend: {},
  },
}

3. PostCSS setup

Create a postcss.config.js file with:

// If you want to use other PostCSS plugins, see the following:
// https://tailwindcss.com/docs/using-with-preprocessors
module.exports = {
  plugins: {
    tailwindcss: {},
    autoprefixer: {},
  },
}

4. Adding global styles

Open _app.tsx and add the following import to include the global CSS of the package and Tailwind base CSS:

import '@vercel/edge-functions-ui/globals.css'

If you don't have a _app.tsx already it should look like this:

import type { AppProps } from 'next/app'
import '@vercel/edge-functions-ui/globals.css'

export default function MyApp({ Component, pageProps }: AppProps) {
  return <Component {...pageProps} />
}

Now, if I wanted to add the default layout used in all examples, I can import the Layout component and use it inside _app.tsx like so:

import type { AppProps } from 'next/app'
import type { LayoutProps } from '@vercel/edge-functions-ui/layout'
import { getLayout } from '@vercel/edge-functions-ui'
import '@vercel/edge-functions-ui/globals.css'

export default function MyApp({ Component, pageProps }: AppProps) {
  const Layout = getLayout<LayoutProps>(Component)

  return (
    <Layout title="API Rate Limiting with Upstash" path="api-rate-limit">
      <Component {...pageProps} />
    </Layout>
  )
}

Contributing

If you want to make an update to the package, go to an example and install it with npm:

npm i ../../packages/ui

npm will add a symlink and making changes to packages/ui will reload the app, once you're done feel free to create a PR!

Make sure to have dependencies installed in packages/ui with npm i or otherwise the symlink won't resolve imports

Usage no npm install needed!