Devup UI

Build-time CSS extraction. No runtime JS for styling.

Critical: Components Are Compile-Time Only

All @devup-ui/react components (Box, Flex, Text, etc.) throw Error('Cannot run on the runtime'). They are placeholders that build plugins transform to <div className="...">.

tsx

// BEFORE BUILD (what you write):
<Box bg="red" p={4} _hover={{ bg: "blue" }} />

// AFTER BUILD (what runs in browser):
<div className="a b c" />  // + CSS: .a{background:red} .b{padding:16px} .c:hover{background:blue}

Core Conventions (from AGENTS.md)

•Zero-Runtime: NEVER use runtime styling. All styles must be resolvable at build time.
•Strict Types: NEVER use as any or @ts-ignore on style props.
•Shorthands: ALWAYS use shorthands (bg, p, m, w, h) instead of full names (background, padding...).
•Theme Tokens: ALWAYS use $ prefix for tokens in props (e.g., bg="$primary").

Style Prop Syntax

Shorthands (ALWAYS use these)

Short	Full	Short	Full
`bg`	background	`m`, `mt`, `mr`, `mb`, `ml`, `mx`, `my`	margin-*
`p`, `pt`, `pr`, `pb`, `pl`, `px`, `py`	padding-*	`w`, `h`	width, height
`minW`, `maxW`, `minH`, `maxH`	min/max width/height	`boxSize`	width + height (same value)
`gap`	gap

Spacing Scale (× 4 = px)

tsx

<Box p={1} />    // padding: 4px
<Box p={4} />    // padding: 16px
<Box p="4" />    // padding: 16px (unitless string also × 4)
<Box p="20px" /> // padding: 20px (with unit = exact value)

Responsive Arrays (5 breakpoints)

tsx

// [mobile, mid, tablet, mid, PC] - 5 levels
// Use indices 0, 2, 4 most frequently. Use null to skip.

<Box bg={["red", null, "blue", null, "yellow"]} />  // mobile=red, tablet=blue, PC=yellow
<Box p={[2, null, 4, null, 6]} />                   // mobile=8px, tablet=16px, PC=24px
<Box w={["100%", null, "50%"]} />                   // mobile=100%, tablet+=50%

Pseudo-Selectors (underscore prefix)

tsx

<Box
  _hover={{ bg: "blue" }}
  _focus={{ outline: "2px solid blue" }}
  _active={{ bg: "darkblue" }}
  _dark={{ bg: "gray.800" }} // theme variant
  _before={{ content: '""' }}
  _firstChild={{ mt: 0 }}
/>

Dynamic Values = CSS Variables

tsx

// Static value -> class
<Box bg="red" />  // className="a" + .a{background:red}

// Dynamic value -> CSS variable
<Box bg={props.color} />  // className="a" style={{"--a":props.color}} + .a{background:var(--a)}

// Conditional -> preserved
<Box bg={isActive ? "blue" : "gray"} />  // className={isActive ? "a" : "b"}

Dynamic Values with Custom Components

css() only accepts static values (extracted at build time). For dynamic values on custom components, use <Box as={Component}>:

tsx

// WRONG - css() cannot handle dynamic values
const MyComponent = ({ width }) => (
  <CustomComponent className={css({ w: width })} /> // ERROR: width is dynamic!
);

// CORRECT - use Box with `as` prop for dynamic values
const MyComponent = ({ width }) => (
  <Box as={CustomComponent} w={width} /> // Works: generates CSS variable
);

Styling APIs

css() Returns className String (NOT object)

tsx

import { css, styled, globalCss, keyframes } from "@devup-ui/react";
import clsx from "clsx";

// css() returns a className STRING - use with className prop
const cardStyle = css({ bg: "white", p: 4, borderRadius: "8px" });
<Box className={cardStyle} />  // CORRECT

// WRONG - css() is NOT an object to spread
// <Box {...cardStyle} />  // ERROR!

// Combine multiple styles with clsx
const baseStyle = css({ p: 4, borderRadius: "8px" });
const activeStyle = css({ bg: "$primary", color: "white" });
<Box className={clsx(baseStyle, isActive && activeStyle)} styleOrder={1} />

// styleOrder={1} REQUIRED when mixing className with direct props
<Box className={cardStyle} bg="$background" styleOrder={1} />

styled() API

tsx

// Styled component (familiar styled-components/Emotion API)
const Card = styled("div", { bg: "white", p: 4, _hover: { shadow: "lg" } });

globalCss() and keyframes()

tsx

// Global styles
globalCss({ body: { margin: 0 }, "*": { boxSizing: "border-box" } });

// Keyframes
const spin = keyframes({
  from: { transform: "rotate(0)" },
  to: { transform: "rotate(360deg)" },
});
<Box animation={`${spin} 1s linear infinite`} />;

Theme (devup.json)

json

{
  "theme": {
    "colors": {
      "default": { "primary": "#0070f3", "text": "#000" },
      "dark": { "primary": "#3291ff", "text": "#fff" }
    },
    "typography": {
      "heading": {
        "fontFamily": "Pretendard",
        "fontSize": "24px",
        "fontWeight": 700
      }
    }
  }
}

Use colors with $ prefix: <Box color="$primary" /> Use typography without prefix: <Box typography="heading" />

Theme API:

tsx

import {
  useTheme,
  setTheme,
  getTheme,
  initTheme,
  ThemeScript,
} from "@devup-ui/react";
setTheme("dark"); // switch theme
const theme = useTheme(); // hook for current theme
<ThemeScript />; // SSR hydration (add to <head>)

Build Plugin Setup

// vite.config.ts
import DevupUI from "@devup-ui/vite-plugin";
export default defineConfig({ plugins: [react(), DevupUI()] });

// next.config.ts
import { DevupUI } from "@devup-ui/next-plugin";
export default DevupUI({
  // Next.js config here
});

// rsbuild.config.ts
import DevupUI from "@devup-ui/rsbuild-plugin";
export default defineConfig({ plugins: [DevupUI()] });

$color Token Scope

$color tokens only work in JSX props. Use var(--color) in external objects.

tsx

// CORRECT - $color in JSX prop
<Box bg="$primary" />
<Box bg={{ active: '$primary', inactive: '$gray' }[status]} />  // inline object OK

// WRONG - $color in external object (won't be transformed)
const colors = { active: '$primary' }  // '$primary' stays as string literal
<Box bg={colors.active} />  // broken!

// CORRECT - var(--color) in external object
const colors = { active: 'var(--primary)' }
<Box bg={colors.active} />  // works

Anti-Patterns (NEVER do)

Wrong	Right	Why
`<Box style={{ color: "red" }}>`	`<Box color="red">`	style prop bypasses extraction
`<Box {...css({...})} />`	`<Box className={css({...})} />`	css() returns string, not object
`css({ bg: variable })`	`<Box bg={variable}>` or `<Box as={Comp} bg={variable}>`	css()/globalCss() only accept static values
`$color` in external object	`var(--color)` in external object	$color only transformed in JSX props
No build plugin configured	Configure plugin first	Components throw at runtime without transformation
`as any` or `@ts-ignore`	Fix types properly	Strict types are enforced for a reason