Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .cursor/rules/guidelines.mdc
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
description: Guidelines for developing in the react-components submodule
globs:
---

# React Components Submodule

This is a shared component library. Changes here affect all consuming applications.

## Directory Structure

```
components/ # UI components
hooks/ # Custom React hooks
helpers/ # Component helper functions
types/ # TypeScript interfaces
assets/ # Static assets
```

## Component Guidelines

### Export Pattern

Use default exports for components:

```typescript
export default function MyComponent(props: MyComponentProps) { ... }
```

### Props Interface

Define interfaces in `types/` directory:

```typescript
// types/my-component.ts
export interface MyComponentProps {
required: string;
optional?: number;
}
```

### Styling

- Use Tailwind CSS classes
- Use `combineClassNames` from javascript-functions for conditional classes
- Avoid inline styles

## Hook Guidelines

- Hooks must start with `use`
- File name should match hook name
- Document return types explicitly

## Dependencies

- `@headlessui/react` - Accessible UI primitives
- `@nextui-org/react` - Tooltip component
- `@tabler/icons-react` - Icon library

## Testing

When modifying components or hooks:
1. Test in consuming applications
2. Verify TypeScript types
3. Test accessibility