Installation

Steps to set-up and start using Charcoal

Add this to your global stylesheet

@tailwind base;
@tailwind components;
@tailwind utilities;
 
body {
  @apply bg-zinc-50 dark:bg-zinc-800 text-zinc-800 dark:text-zinc-100 caret-zinc-800 dark:caret-zinc-400;
}
 
.icon {
  @apply h-4 w-4;
}
 
.focus-ring {
  @apply transition ease-in-out duration-200 focus:shadow-zinc-500 dark:ring-zinc-600 ring-zinc-400 focus:!ring-2 focus:!outline-none;
}
 
.disabled {
  @apply disabled:opacity-50 disabled:cursor-not-allowed;
}
 
.blur-background {
  @apply !bg-opacity-90 !backdrop-blur-2xl;
}
 
.container-border {
  @apply border border-zinc-200 dark:border-zinc-700;
}
 
.link {
  @apply px-1 py-0.5 hover:bg-zinc-300 dark:hover:bg-zinc-700 rounded -mx-1 text-blue-700 dark:text-blue-400;
}

and add this to your tailwind.config.ts

import type { Config } from 'tailwindcss';
 
const config: Config = {
  content: [
    './pages/**/*.{js,ts,jsx,tsx,mdx}',
    './components/**/*.{js,ts,jsx,tsx,mdx}',
    './app/**/*.{js,ts,jsx,tsx,mdx}',
    './docs/**/*.{js,ts,jsx,tsx,mdx}',
  ],
  darkMode: 'class',
  theme: {
    container: {
      center: true,
      padding: '2rem',
      screens: {
        '2xl': '1400px',
      },
    },
    extend: {
      borderRadius: {
        lg: `var(--radius)`,
        md: `calc(var(--radius) - 2px)`,
        sm: 'calc(var(--radius) - 4px)',
      },
      fontFamily: {
        sans: [
          'Inter',
          'system-ui',
          '-apple-system',
          'BlinkMacSystemFont',
          "'Segoe UI'",
          'Roboto',
          'Oxygen',
          'Ubuntu',
          'Cantarell',
          "'Open Sans'",
          "'Helvetica Neue'",
          'sans-serif',
        ],
      },
      keyframes: {
        'accordion-down': {
          from: { height: '0' },
          to: { height: 'var(--radix-accordion-content-height)' },
        },
        'accordion-up': {
          from: { height: 'var(--radix-accordion-content-height)' },
          to: { height: '0' },
        },
      },
      animation: {
        'accordion-down': 'accordion-down 0.2s ease-out',
        'accordion-up': 'accordion-up 0.2s ease-out',
      },
    },
  },
  plugins: [require('tailwindcss-animate'), require('@tailwindcss/typography')],
};
export default config;