craft-ds

Craft Design System v0.3

View the system at craft.bridger.to

Craft is a minimalist Design System developed using a single component file paired with the best design tools for Next.js. It was created by Bridger Tower to build websites with Next.js, Tailwind, shadcn/ui, and TypeScript faster

Quick Start

To install Craft in your Next.js project, run:

npx craft-ds@latest init

or

pnpx craft-ds@latest init

Or use the Starter template at starter.bridger.to

Core Components

Craft provides several core components for building responsive layouts:

Layout Components

• Layout: Sets up the basic HTML structure and applies global styles
• Main: Main content area of the page
• Section: Defines sections within the page
• Container: Contains content with a maximum width and padding
• Prose: Component for styling long-form content with appropriate typography
• Article: Renders articles with appropriate typography styles
• Box: Flexible component for creating responsive layouts

Box Component

The Box component is the heart of Craft's layout system. It provides a flexible way to create both flex and grid layouts with responsive controls:

import { Box } from "@/components/craft";

// Basic Flex Layout
<Box direction="row" wrap={true} gap={4}>
  <div>Item 1</div>
  <div>Item 2</div>
</Box>

// Responsive Layout
<Box
  direction={{
    base: "col",
    md: "row"
  }}
  wrap={{
    base: true,
    md: false
  }}
  gap={{
    base: 2,
    md: 4
  }}
>
  <div>Item 1</div>
  <div>Item 2</div>
</Box>

// Grid Layout
<Box cols={{
  base: 1,
  md: 2,
  lg: 3
}} gap={4}>
  <div>Grid Item 1</div>
  <div>Grid Item 2</div>
  <div>Grid Item 3</div>
</Box>

Box Props

• direction: Control flex direction ("row" | "col")
• wrap: Enable/disable flex wrap
• gap: Set spacing between items
• cols: Define grid columns
• rows: Define grid rows

All props support responsive objects with breakpoints: base, sm, md, lg, xl, 2xl

Typography

Typography is handled through a modified version of Tailwind Typography. The styling is applied through the Main, Prose, or Article components.

Example: The Prose component is available for styling long-form content with appropriate typography:

import { Prose } from "@/components/craft";

<Prose>
  <h1>Title</h1>
  <p>Your content here...</p>
</Prose>;

For font management, we recommend using Next.js Font Optimization with variable fonts.

Colors

Colors are managed using shadcn's theming system. Custom Tailwind classes like text-primary or bg-accent are defined in globals.css.

Find color schemes at:

• ui.shadcn.com/themes
• ui.jln.dev

Setup Guide

1. Create a Next.js application:

pnpx create-next-app@latest

2. Install Craft (this will also install shadcn/ui and dependencies):

pnpx craft-ds@latest init

3. Import and use Craft components:

import {
  Layout,
  Main,
  Section,
  Container,
  Prose,
  Article,
  Box,
} from "@/components/craft";

Dependencies

• shadcn/ui: Beautifully designed, accessible components
• React Wrap Balancer: Improves title readability

For detailed documentation and examples, visit craft.bridger.to