92 lines
4.2 KiB
Markdown
92 lines
4.2 KiB
Markdown
# Architecture
|
||
|
||
The shared UI package used by both `apps/website` (Nuxt 3) and `apps/app-frontend` (Vue 3 + Tauri). Components here must be platform-agnostic — use dependency injection for platform-specific behavior.
|
||
|
||
## Folder Structure
|
||
|
||
```
|
||
src/
|
||
├── components/ # Vue components organized by feature domain
|
||
├── composables/ # Vue 3 composition API hooks
|
||
├── layouts/ # Self-contained page layouts (see below)
|
||
├── providers/ # Dependency injection contexts (createContext pattern)
|
||
├── utils/ # Utility functions and constants
|
||
├── pages/ # Cross platform page components
|
||
├── locales/ # 34 language locale files (FormatJS)
|
||
├── styles/ # Tailwind CSS utilities
|
||
```
|
||
|
||
Each subdirectory under `components/` has an `index.ts` barrel file. All public API is re-exported from the root `index.ts`.
|
||
|
||
### `src/layouts/`
|
||
|
||
Self-contained page layouts shared across frontends. Split into two categories:
|
||
|
||
- **`shared/`** — Reusable layout modules with their own components, composables, providers, and types. Each module is a self-contained unit (e.g. `shared/content-tab/` contains the content/mods tab layout with its own `layout.vue`, `components/`, `composables/`, `providers/`, and `types.ts`).
|
||
- **`wrapped/`** — Page-level Vue components that mirror route structures. These are full page implementations consumed by the desktop application and, where appropriate, the website.
|
||
|
||
Files inside `layouts/` use the `#ui/*` import alias (resolved via the `"imports"` field in `package.json`) to reference other `src/` modules like `#ui/components/base/ButtonStyled.vue` or `#ui/composables/i18n`.
|
||
|
||
# Code Guidelines
|
||
|
||
### Tailwind Configuration
|
||
|
||
All frontend packages share a Tailwind preset at `packages/tooling-config/tailwind/tailwind-preset.ts`. This package's `tailwind.config.ts` extends it:
|
||
|
||
```ts
|
||
import preset from '@modrinth/tooling-config/tailwind/tailwind-preset.ts'
|
||
```
|
||
|
||
CSS custom properties are defined in `packages/assets/styles/variables.scss` with light, dark, and OLED theme variants.
|
||
|
||
### Color Usage Rules
|
||
|
||
**Use `surface-*` variables for backgrounds — never aliased `bg-*` color variables:**
|
||
|
||
| Token | Usage |
|
||
| ---------------- | ----------------------------------------- |
|
||
| `bg-surface-1` | Deepest background layer |
|
||
| `bg-surface-1.5` | Odd row background (tables) |
|
||
| `bg-surface-2` | Even row background, secondary panels |
|
||
| `bg-surface-3` | Headers, floating bar backgrounds, inputs |
|
||
| `bg-surface-4` | Cards, elevated surfaces |
|
||
| `bg-surface-5` | Borders, dividers |
|
||
|
||
**For text colors:**
|
||
|
||
| Class | Usage |
|
||
| ---------------- | -------------------------------- |
|
||
| `text-contrast` | Primary headings |
|
||
| `text-primary` | Default body text |
|
||
| `text-secondary` | Reduced emphasis, secondary info |
|
||
|
||
**Brand and semantic colors** not all exposed as Figma variables — refer to `packages/assets/styles/variables.scss` for the full set:
|
||
|
||
- `bg-{color}`, `text-{color}` etc. — Primary brand colors
|
||
- `bg-{color}-highlight` — 25% opacity semantic highlights
|
||
|
||
**Color palette** (each with shades 50–950): red, orange, green, blue, purple, gray. Platform-specific colors also exist (fabric, forge, quilt, neoforge, etc.).
|
||
|
||
## Dependency Injection
|
||
|
||
This package defines the DI layer using `createContext` from `src/providers/index.ts`. See the `dependency-injection` skill (`.claude/skills/dependency-injection/SKILL.md`) for full documentation.
|
||
|
||
Key providers exported from this package:
|
||
|
||
- `provideModrinthClient` / `injectModrinthClient` — API client
|
||
- `provideNotificationManager` / `injectNotificationManager` — Notifications
|
||
|
||
## Vue Template Rules
|
||
|
||
### Multi-statement event handlers
|
||
|
||
Never use newline-separated statements in Vue template event handlers like `@click`. Vue's template compiler cannot parse multi-line expressions separated only by newlines. Always use semicolons on a single line:
|
||
|
||
```vue
|
||
<!-- BAD: will cause "Unexpected token" parse error -->
|
||
@click=" foo = true $emit('bar') "
|
||
|
||
<!-- GOOD -->
|
||
@click="foo = true; $emit('bar')"
|
||
```
|