kumo-astro / components
AGENTS.md4 starsChanged 9 months agoMITView on GitHub
39 UI components. Base UI primitives + Tailwind v4 styling. Compound component pattern throughout. Parent: See packages/kumo/AGENTS.md for library context. Each component follows: {name}/{name}.tsx + optional {name}.test.tsx, {name}.browser.test.tsx Every component file MUST export (lint-enforced by enforce-variant-standard): 13 components use this pattern: Input, Select, Combobox auto-wrap with Field when label prop provided:
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository11 other files it gives its agents.
- AGENTS.mdAGENTS.md
- ci/AGENTS.mdAGENTS.md
- packages/kumo/AGENTS.mdAGENTS.md
- packages/kumo-astro/AGENTS.mdAGENTS.md
- packages/kumo-blocks/AGENTS.mdAGENTS.md
- packages/kumo-docs-astro/AGENTS.mdAGENTS.md
- packages/kumo-figma/AGENTS.mdAGENTS.md
- packages/kumo-figma/src/generators/AGENTS.mdAGENTS.md
- packages/kumo-screenshot-worker/AGENTS.mdAGENTS.md
- packages/kumo-studio/AGENTS.mdAGENTS.md
- index-knowledgeSkill
The file
We split this AGENTS.md into the rules it gives an agent
2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 25
Every component file MUST export (lint-enforced by enforce-variant-standard):
- Distinctive: line 186
64 forwardRef usages: All interactive components use forwardRef
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Component Source (src/components/)
39 UI components. Base UI primitives + Tailwind v4 styling. Compound component pattern throughout.
Parent: See packages/kumo/AGENTS.md for library context.
STRUCTURE
Each component follows: {name}/{name}.tsx + optional {name}.test.tsx, {name}.browser.test.tsx
components/
├── button/button.tsx # Simple component
├── dialog/dialog.tsx # Compound (Root, Trigger, Title, Description, Close)
├── command-palette/ # Complex: 865 lines, 14 sub-components, 2 contexts
├── date-range-picker/ # Complex: 667 lines (DEPRECATED, refactoring target)
├── combobox/ # Complex: 561 lines (Root, Content, TriggerValue, TriggerInput, Item, Chip)
├── flow/ # 8 files, descendants tracking system
├── chart/ # 5 files, ECharts wrapper + timeseries + sparkline
└── ...REQUIRED EXPORTS
Every component file MUST export (lint-enforced by enforce-variant-standard):
// 1. Variants object - machine-readable styling options
export const KUMO_BUTTON_VARIANTS = {
variant: {
primary: { classes: "bg-kumo-brand ...", description: "Primary action" },
secondary: { classes: "bg-kumo-elevated ...", description: "Secondary action" },
// ...
},
size: { xs: {...}, sm: {...}, base: {...}, lg: {...} },
shape: { base: {...}, square: {...}, circle: {...} }
} as const;
// 2. Defaults - must reference keys from variants
export const KUMO_BUTTON_DEFAULT_VARIANTS = {
variant: "secondary",
size: "base",
shape: "base"
} as const;
// 3. Optional: Figma plugin metadata
export const KUMO_BUTTON_STYLING = {
baseClasses: "inline-flex items-center ...",
iconPosition: "left"
} as const;COMPONENT PATTERNS
Simple Component
export const Button = forwardRef<HTMLButtonElement, ButtonProps>(
({ variant, size, shape, className, ...props }, ref) => {
return (
<button
ref={ref}
className={cn(buttonVariants({ variant, size, shape }), className)}
{...props}
/>
);
}
);
Button.displayName = "Button"; // REQUIRED (77 total across codebase)Compound Component (Object.assign)
13 components use this pattern:
const DialogRoot = forwardRef<...>(...);
const DialogTrigger = forwardRef<...>(...);
const DialogTitle = forwardRef<...>(...);
export const Dialog = Object.assign(DialogRoot, {
Root: DialogRoot,
Trigger: DialogTrigger,
Title: DialogTitle,
// ...
});
// displayName with dot notation
DialogRoot.displayName = "Dialog";
DialogTrigger.displayName = "Dialog.Trigger";Context Hierarchy (13 contexts total)
// Multi-level context for compound components
const DialogRoleContext = createContext<"dialog" | "alertdialog">("dialog");
const ComboboxSizeContext = createContext<Size>("base");
const FlowNodeAnchorContext = createContext<AnchorRegistration | null>(null);
const SwitchGroupContext = createContext<{ controlFirst: boolean }>({
controlFirst: true,
});Base UI Adaptation (36 imports)
import { Dialog as DialogBase } from "@base-ui/react/dialog";
// Wrap with styling + kumo conventions
const DialogContent = forwardRef<...>(({ className, ...props }, ref) => (
<DialogBase.Popup
ref={ref}
className={cn("bg-kumo-elevated rounded-lg ...", className)}
{...props}
/>
));Field Wrapper Integration
Input, Select, Combobox auto-wrap with Field when label prop provided:
if (label) {
return <Field label={label} description={description} error={error}>{input}</Field>;
}
return input;Type Derivation from Variants
export type KumoButtonVariant = keyof typeof KUMO_BUTTON_VARIANTS.variant;
export type KumoButtonSize = keyof typeof KUMO_BUTTON_VARIANTS.size;
// Legacy alias for backwards compatibility
export type ButtonVariant = KumoButtonVariant;STYLING CONVENTIONS
cn() Always (43 files import it)
// CORRECT
className={cn("base-classes", conditional && "extra", className)}
// WRONG - loses passthrough className
className="base-classes"State Classes (for Figma extraction)
Tailwind state prefixes are extractable:
classes: "bg-kumo-elevated hover:bg-kumo-base focus:ring-kumo-hairline disabled:opacity-50";
// Parsed into: { default, hover, focus, disabled } state mapANTI-PATTERNS
| Pattern | Why | Instead |
Missing displayName | Breaks React DevTools | Set after forwardRef |
| Raw className string | Loses passthrough | Use cn(base, className) |
as any | Type safety | Model types correctly (3 exist, don't add) |
| Hardcoded colors | Breaks theming | Use semantic tokens |
dark: prefix | Redundant | Tokens auto-adapt |
{cond && A}{!cond && B} | Unstable child positions | {cond ? A : B} ternary |
Bare {children} with conditionals | Extensions reparent text nodes | Wrap in <span className="contents"> |
COMPLEXITY HOTSPOTS
| Component | Lines | Notes |
command-palette | 865 | 14 sub-components, two-level context, keyboard nav |
date-range-picker | 667 | 150 lines duplicated ternary (DEPRECATED) |
combobox | 561 | Complex async filtering |
pagination | 510 | Multiple layout modes |
flow | 8 files | Descendants tracking, connector drawing |
chart | 5 files | ECharts passed externally to avoid bundling |
NOTES
- 64 forwardRef usages: All interactive components use forwardRef
- Discriminated union props: ButtonWithTextProps vs IconOnlyButtonProps pattern for conditional required props
- A11y dev warnings: Components log console.warn in dev if missing accessible name
- Descendants hook:
flow/use-children.tsxusesclaimRenderOrder()andmeasurementEpochfor deterministic connector drawing - LinkProvider:
utils/link-provider.tsxabstracts framework-specific links (wrap app with custom Link component)
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

