Skip to content

CLAUDE.md

Latest commit

 

History

History
46 lines (32 loc) · 1.73 KB

CLAUDE.md

File metadata and controls

46 lines (32 loc) · 1.73 KB

CLAUDE.md

This file provides guidance to Claude Code when working with code in this repository.

Project Overview

@uniweb/kit is the standard component library for Uniweb foundations. It provides React components, hooks, and utilities that foundation themes import to build websites on the Uniweb platform.

Important: No Build Step

This package ships raw source files — there is no bundler or build step. The exports field in package.json points directly to ./src/index.js. Consumers (Uniweb foundations) bundle kit code themselves via Vite.

File Structure

  • src/index.js — Single entry point; re-exports everything
  • src/components/ — Unstyled primitive components (Image, Link, Media, Icon, Text, etc.)
  • src/styled/ — Pre-styled Tailwind-based components (Section, Visual, Prose, Article, etc.)
  • src/hooks/ — React hooks (useWebsite, useRouting, useTheme, useInView, etc.)
  • src/utils/ — Utilities (cn for class merging, detectMediaType, parseIconRef, etc.)
  • src/search/ — Client-side search (Fuse.js-based)
  • src/theme-tokens.css — CSS custom properties for theming (exported separately)

Component Convention

Each component lives in its own folder with an index.js barrel file:

src/components/Image/
  Image.jsx    # Implementation
  index.js     # Re-export

Dependencies

  • @uniweb/core — Runtime core (published separately, referenced as latest)
  • clsx + tailwind-merge — Class name merging (cn() utility)
  • fuse.js — Client-side search
  • shiki — Syntax highlighting
  • React 18/19 as peer dependency

Publishing

  1. Bump version in package.json
  2. Commit and push to main
  3. Run npm publish --access public

No build step is needed before publishing.