Getting Started
Next.js
Everything you need to set up Tremor with Next.js.
Installation
Tremor is designed for React and requires React v18.2.0+
- 1
Create a new Next.js project:
In our terminal, we create a new Next.js project. Stick to Tailwind CSS, use the src/ directory and the app router.npx create-next-app@latest my-project --ts --tailwind --eslint --app --src-dir && cd my-project
- 2
Install dependencies:
To install: tailwind-variants, clsx, and tailwind-merge, run:
npm install tailwind-variants clsx tailwind-merge
(Optional) If you plan to use all components, you can add all Radix UI dependencies here:
npm install @radix-ui/react-accordion @radix-ui/react-checkbox @radix-ui/react-dialog @radix-ui/react-hover-card @radix-ui/react-label @radix-ui/react-popover @radix-ui/react-radio-group @radix-ui/react-select @radix-ui/react-slot @radix-ui/react-switch @radix-ui/react-tabs @radix-ui/react-toast @radix-ui/react-tooltip date-fns react-day-picker @internationalized/date @react-stately/datepicker @react-aria/datepicker
All our components use Remix Icon. To install, run:
npm install @remixicon/react
- 3
Add font and dark mode background:
In all our examples, we use Geist Font. This is not required, use any other font you like. To install, run:
npm install geist
Then in your app/layout.tsx, add the font and dark mode background like this:
import type { Metadata } from "next";import { GeistSans } from "geist/font/sans"; // import fontimport "./globals.css"; export const metadata: Metadata = { title: "Create Next App", description: "Generated by create next app",}; export default function RootLayout({ children,}: Readonly<{ children: React.ReactNode;}>) { return ( // add font to className, also add antialiased and dark mode <html lang="en" className={`${GeistSans.className} antialiased dark:bg-gray-950`}> <body>{children}</body> </html> );}
- 4
Install @tailwindcss/forms
Learn more about Tailwind CSS Forms here. To install, run:
npm install -D @tailwindcss/forms
- 5
Update tailwind.config.ts
In order for the animations to be applied correctly, we extend the tailwind.config.ts. We also add the @tailwindcss/forms. Note that we also added the paths to the template files in the content section.
import type { Config } from "tailwindcss" const config: Config = { content: [ "./src/pages/**/*.{js,ts,jsx,tsx,mdx}", "./src/components/**/*.{js,ts,jsx,tsx,mdx}", "./src/app/**/*.{js,ts,jsx,tsx,mdx}", "./src/lib/**/*.{js,ts,jsx,tsx,mdx}", ], theme: { extend: { keyframes: { hide: { from: { opacity: "1" }, to: { opacity: "0" }, }, slideDownAndFade: { from: { opacity: "0", transform: "translateY(-6px)" }, to: { opacity: "1", transform: "translateY(0)" }, }, slideLeftAndFade: { from: { opacity: "0", transform: "translateX(6px)" }, to: { opacity: "1", transform: "translateX(0)" }, }, slideUpAndFade: { from: { opacity: "0", transform: "translateY(6px)" }, to: { opacity: "1", transform: "translateY(0)" }, }, slideRightAndFade: { from: { opacity: "0", transform: "translateX(-6px)" }, to: { opacity: "1", transform: "translateX(0)" }, }, accordionOpen: { from: { height: "0px" }, to: { height: "var(--radix-accordion-content-height)" }, }, accordionClose: { from: { height: "var(--radix-accordion-content-height)", }, to: { height: "0px" }, }, dialogOverlayShow: { from: { opacity: "0" }, to: { opacity: "1" }, }, dialogContentShow: { from: { opacity: "0", transform: "translate(-50%, -45%) scale(0.95)", }, to: { opacity: "1", transform: "translate(-50%, -50%) scale(1)" }, }, }, animation: { hide: "hide 150ms cubic-bezier(0.16, 1, 0.3, 1)", slideDownAndFade: "slideDownAndFade 150ms cubic-bezier(0.16, 1, 0.3, 1)", slideLeftAndFade: "slideLeftAndFade 150ms cubic-bezier(0.16, 1, 0.3, 1)", slideUpAndFade: "slideUpAndFade 150ms cubic-bezier(0.16, 1, 0.3, 1)", slideRightAndFade: "slideRightAndFade 150ms cubic-bezier(0.16, 1, 0.3, 1)", // Accordion accordionOpen: "accordionOpen 150ms cubic-bezier(0.87, 0, 0.13, 1)", accordionClose: "accordionClose 150ms cubic-bezier(0.87, 0, 0.13, 1)", // Dialog dialogOverlayShow: "dialogOverlayShow 150ms cubic-bezier(0.16, 1, 0.3, 1)", dialogContentShow: "dialogContentShow 150ms cubic-bezier(0.16, 1, 0.3, 1)", }, }, }, plugins: [require("@tailwindcss/forms")],}export default config
- 6
Add utilities and helpers
Our components depend on a few utilities. You can read more about them in the Utilities section cx, focusInput, hasErrorInput, focusRing.
Create a new lib folder in /src. Add a new utils.ts file inside. Paste the following utilities into this file.
import clsx, { type ClassValue } from "clsx"import { twMerge } from "tailwind-merge" export function cx(...args: ClassValue[]) { return twMerge(clsx(...args))} // Tremor Raw focusInput [v0.0.1] export const focusInput = [ // base "focus:ring-2", // ring color "focus:ring-blue-200 focus:dark:ring-blue-700/30", // border color "focus:border-blue-500 focus:dark:border-blue-700",] // Tremor Raw focusRing [v0.0.1] export const focusRing = [ // base "outline outline-offset-2 outline-0 focus-visible:outline-2", // outline color "outline-blue-500 dark:outline-blue-500",] // Tremor Raw hasErrorInput [v0.0.1] export const hasErrorInput = [ // base "ring-2", // border color "border-red-500 dark:border-red-700", // ring color "ring-red-200 dark:ring-red-700/30",]
- 7
Notes on your project structure
When adding components, we recommend adding them to a components directory inside /src. Here is an example on how we'd structure our app:
.├── src│ ├── app│ │ ├── favicon.ico│ │ ├── globals.css│ │ ├── layout.tsx│ │ └── page.tsx│ ├── components│ │ ├── Accordion.tsx│ │ ├── Badge.tsx│ │ └── ...│ └── lib│ └── utils.ts├── package-lock.json├── package.json├── postcss.config.js├── tailwind.config.ts└── tsconfig.json
Dark mode usage:
For all examples, we use bg-gray-950 as the overall background color. You can add this to your <html className="dark:bg-gray-950"> tag.
Font smoothing (antialiasing):
On our website, we apply font smoothing and recommend you do the same. Simply add the antialiased utility to the HTML tag <html className="antialiased">.