From 85b7c793b45f1d32919e1644c1872b1c94c5d3b8 Mon Sep 17 00:00:00 2001 From: Jonathan Summers-Muir Date: Wed, 14 Sep 2022 17:44:32 +0200 Subject: [PATCH] Update DEVELOPERS.md --- DEVELOPERS.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index a0dd47cb371..c3448678b88 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -195,6 +195,15 @@ The monorepo has a set of shared components under `/packages`: - `/packages/config`: All shared config - `/packages/spec`: Generates documentation using spec files. - `/packages/tsconfig`: Shared Typescript settings +- `/packages/ui`: Shared UI components (formerly @supabase/ui) + +To use these 'packages', or any of their components from a Next.JS app, you must use `next-transpile-modules` in the `next.config.js` file. This looks like: + +```tsx +// next.config.js +const withTM = require('next-transpile-modules')(['ui', 'common']) +module.exports = withTM({}) +``` ### Installing packages