Compare commits

...

3 Commits

Author SHA1 Message Date
8571b544e6 Move parts creation outside component function 2026-03-11 19:16:26 -07:00
1b6a19befe 0.0.5 2026-03-11 14:41:34 -07:00
1e8f37650e Add static Component.Part syntax 2026-03-11 14:41:23 -07:00
8 changed files with 293 additions and 8 deletions

View File

@ -24,7 +24,9 @@ CSS is hostile to humans at scale: global namespace, no markup-to-definition lin
**Parts** - Sub-components within a component (e.g., Header, Body, Footer)
- Defined via `parts: { PartName: { ...styles } }`
- Accessible in render as `parts.PartName`
- Also accessible as static properties: `Component.PartName` (no custom render needed)
- Generate classes like `ComponentName_PartName`
- Variant part styles generate dual CSS: direct class (`.Part.variant`) and descendant (`.Root.variant .Part`)
**Variants** - Conditional styling based on props
- Boolean: `variants: { active: { color: 'blue' } }``<Component active />`

View File

@ -118,6 +118,43 @@ console.log(<Profile pic={user.pic} bio={user.bio} />)
console.log(<Profile size="small" pic={user.pic} bio={user.bio} />)
```
### parts + `Component.Part`
Parts are also available as static properties on the component, so you
can compose without writing a custom `render()`:
```tsx
const Card = define("Card", {
padding: 20,
background: "#111",
parts: {
Title: { base: "h2", fontSize: 24 },
Body: { color: "gray" },
},
variants: {
dark: {
background: "black",
parts: {
Body: { color: "white" },
},
},
},
})
// Usage
<Card>
<Card.Title>Hello</Card.Title>
<Card.Body>World</Card.Body>
</Card>
<Card dark>
<Card.Title>Dark mode</Card.Title>
<Card.Body>Variant styles reach parts automatically</Card.Body>
</Card>
```
### selectors
Use `selectors` to write custom CSS selectors. Reference the current

View File

@ -416,6 +416,79 @@ Generated CSS classes:
.Card_Footer { border-top: 1px solid #333; font-size: 12px; margin-top: 16px; padding-top: 12px; }
```
### Static part access (`Component.Part`)
Parts are also available as static properties on the component itself. This lets you compose components without writing a custom `render` function:
```tsx
const Card = define('Card', {
padding: 20,
background: '#111',
parts: {
Title: { base: 'h2', fontSize: 24 },
Body: { padding: 10, color: '#888' },
},
})
// Use parts directly as Component.Part
<Card>
<Card.Title>Hello</Card.Title>
<Card.Body>World</Card.Body>
</Card>
```
This renders:
```html
<div class="Card">
<h2 class="Card_Title">Hello</h2>
<div class="Card_Body">World</div>
</div>
```
When a variant is set on the parent, descendant CSS selectors ensure the variant styles reach the static parts automatically:
```tsx
const Tabs = define('Tabs', {
display: 'flex',
parts: {
Tab: { base: 'button', color: 'gray' },
},
variants: {
active: {
parts: {
Tab: { color: 'blue' },
},
},
},
})
// Variant on parent styles the child parts via descendant selectors
<Tabs active>
<Tabs.Tab>Home</Tabs.Tab>
<Tabs.Tab>Settings</Tabs.Tab>
</Tabs>
```
Generated CSS (both selectors for both usage patterns):
```css
/* For render({ parts }) path — direct class on part */
.Tabs_Tab.active { color: blue; }
/* For Component.Part path — descendant of variant root */
.Tabs.active .Tabs_Tab { color: blue; }
```
Static parts can also receive variant props directly for per-instance control:
```tsx
<Tabs.Tab active>Home</Tabs.Tab> <!-- class="Tabs_Tab active" -->
<Tabs.Tab>Settings</Tabs.Tab> <!-- class="Tabs_Tab" -->
```
### Parts with states
Parts can have their own pseudo-selectors:

View File

@ -426,6 +426,43 @@ console.log(<Profile pic={user.pic} bio={user.bio} />)
console.log(<Profile size="small" pic={user.pic} bio={user.bio} />)
\`\`\`
### parts + \`Component.Part\`
Parts are also available as static properties on the component, so you
can compose without writing a custom \`render()\`:
\`\`\`tsx
const Card = define("Card", {
padding: 20,
background: "#111",
parts: {
Title: { base: "h2", fontSize: 24 },
Body: { color: "gray" },
},
variants: {
dark: {
background: "black",
parts: {
Body: { color: "white" },
},
},
},
})
// Usage
<Card>
<Card.Title>Hello</Card.Title>
<Card.Body>World</Card.Body>
</Card>
<Card dark>
<Card.Title>Dark mode</Card.Title>
<Card.Body>Variant styles reach parts automatically</Card.Body>
</Card>
\`\`\`
### selectors
Use \`selectors\` to write custom CSS selectors. Reference the current

View File

@ -1,6 +1,6 @@
{
"name": "@because/forge",
"version": "0.0.4",
"version": "0.0.5",
"type": "module",
"main": "src/index.tsx",
"module": "src/index.tsx",

View File

@ -245,8 +245,12 @@ function registerStyles(name: string, def: TagDef) {
for (const [partName, partDef] of Object.entries(variantDef.parts ?? {})) {
const basePartClassName = makeClassName(name, partName)
// Direct class on part (for render({ parts }) path where parts inherit variant props)
const partClassName = `${basePartClassName}.${variantName}`
registerClassStyles(name, partClassName, partDef)
// Descendant selector (for Component.Part path where root has variant class)
const descendantClassName = `${baseClassName}.${variantName} .${basePartClassName}`
registerClassStyles(name, descendantClassName, partDef)
}
} else {
// Keyed variant - iterate over the keys
@ -255,8 +259,13 @@ function registerStyles(name: string, def: TagDef) {
registerClassStyles(name, className, variantDef)
for (const [partName, partDef] of Object.entries(variantDef.parts ?? {})) {
const basePartClassName = makeClassName(name, partName)
// Direct class on part (for render({ parts }) path)
const partClassName = makeClassName(name, partName, variantName, variantKey)
registerClassStyles(name, partClassName, partDef)
// Descendant selector (for Component.Part path)
const descendantClassName = `${className} .${basePartClassName}`
registerClassStyles(name, descendantClassName, partDef)
}
}
}
@ -288,17 +297,23 @@ export function define(nameOrDef: string | TagDef, defIfNamed?: TagDef) {
const currentProps: Record<string, any> = {}
const Root = makeComponent(name, def, currentProps)
const parts: Record<string, Function> = { Root }
return (props: Record<string, any>) => {
for (const [part] of Object.entries(def.parts ?? {}))
parts[part] = makeComponent(name, def, currentProps, part)
const component = (props: Record<string, any>) => {
for (const key in currentProps) delete currentProps[key]
Object.assign(currentProps, props)
const parts: Record<string, Function> = { Root }
for (const [part] of Object.entries(def.parts ?? {}))
parts[part] = makeComponent(name, def, props, part)
return def.render?.({ props, parts }) ?? <Root {...props}>{props.children}</Root>
}
// Attach parts as static properties for Component.Part syntax
for (const [part] of Object.entries(def.parts ?? {}))
(component as any)[part] = makeComponent(name, def, {}, part)
return component
}
// automatic names

View File

@ -1058,6 +1058,127 @@ describe('edge cases', () => {
})
})
describe('Component.Part static access', () => {
test('parts are accessible as static properties', () => {
const Component = define('StaticParts', {
parts: {
Header: { base: 'header' },
Body: { base: 'main' }
}
})
expect(typeof (Component as any).Header).toBe('function')
expect(typeof (Component as any).Body).toBe('function')
})
test('static parts render with correct className and element', () => {
const Component = define('StaticPartRender', {
parts: {
Logo: { base: 'a', color: 'blue' },
Nav: { base: 'nav', display: 'flex' }
}
}) as any
const logoHtml = renderToString(Component.Logo({ href: '/', children: 'Home' }))
expect(logoHtml).toContain('class="StaticPartRender_Logo"')
expect(logoHtml).toContain('<a')
expect(logoHtml).toContain('href="/"')
expect(logoHtml).toContain('Home')
const navHtml = renderToString(Component.Nav({ children: 'Links' }))
expect(navHtml).toContain('class="StaticPartRender_Nav"')
expect(navHtml).toContain('<nav')
})
test('static parts work as JSX children of parent component', () => {
const Card = define('StaticCard', {
padding: 20,
parts: {
Title: { base: 'h2', fontSize: 24 },
Body: { base: 'div', padding: 10 }
}
}) as any
const html = renderToString(Card({
children: [
Card.Title({ children: 'Hello' }),
Card.Body({ children: 'World' })
]
}))
expect(html).toContain('class="StaticCard"')
expect(html).toContain('class="StaticCard_Title"')
expect(html).toContain('class="StaticCard_Body"')
expect(html).toContain('Hello')
expect(html).toContain('World')
})
test('variant on parent applies to static parts via descendant selector CSS', () => {
define('StaticVariantParts', {
parts: {
Item: { color: 'black' }
},
variants: {
theme: {
dark: {
backgroundColor: 'black',
parts: {
Item: { color: 'white' }
}
}
}
}
})
const css = getStylesCSS()
// Descendant selector for Component.Part usage
expect(css).toContain('.StaticVariantParts.theme-dark .StaticVariantParts_Item')
// Direct class selector still generated for render({ parts }) usage
expect(css).toContain('.StaticVariantParts_Item.theme-dark')
})
test('boolean variant on parent generates descendant selector CSS', () => {
define('StaticBoolVariant', {
parts: {
Icon: { base: 'span', opacity: 0.5 }
},
variants: {
active: {
parts: {
Icon: { opacity: 1 }
}
}
}
})
const css = getStylesCSS()
expect(css).toContain('.StaticBoolVariant.active .StaticBoolVariant_Icon')
expect(css).toContain('.StaticBoolVariant_Icon.active')
})
test('static parts can receive variant props directly', () => {
const Tabs = define('StaticTabs', {
parts: {
Tab: { base: 'button', color: 'gray' }
},
variants: {
active: {
parts: {
Tab: { color: 'blue' }
}
}
}
}) as any
const activeHtml = renderToString(Tabs.Tab({ active: true, children: 'Home' }))
expect(activeHtml).toContain('StaticTabs_Tab active')
expect(activeHtml).toContain('Home')
const inactiveHtml = renderToString(Tabs.Tab({ children: 'Settings' }))
expect(inactiveHtml).toContain('class="StaticTabs_Tab"')
expect(inactiveHtml).not.toContain('active')
})
})
describe('css() - global styles', () => {
test('registers bare element selectors', () => {
css({

View File

@ -19,12 +19,12 @@ export function parseCSS(css: string): Record<string, Record<string, string>> {
const className = match[1]
const cssText = match[2]
styles[className] = {}
styles[className] ??= {}
const propMatches = Array.from(cssText.matchAll(/\s*([^:]+):\s*([^;]+);/g))
for (const propMatch of propMatches) {
if (!propMatch[1] || !propMatch[2]) continue
styles[className]![propMatch[1].trim()] = propMatch[2].trim()
styles[className]![propMatch[1].trim()] ??= propMatch[2].trim()
}
}