2026-02-27 17:21:35 +00:00
# Architecture
The shared UI package used by both `apps/frontend` (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
feat: content tab rewrite for worlds (#5136)
* feat: base content card component
* fix: tooltips + colors
* feat: fix orgs
* feat: base content tab internals rewrite
* feat: fix invalidmodal
* feat: add ContentModpackCard
* fix: extract types
* draft: layout
* feat: unlink modal
* feat: impl content tab
* fix: lint
* fix: toggling
* temp: disable updating stuff
* feat: selection v-model
* feat: bulk selection
* feat: mods tab rough draft
* feat: use fuse.js
* feat: add project combobox
* clean up project combobox
* feat: start install to play modal
* fix: events
* feat: use v-on
* feat: bulk actions + fix floating action bar width
* feat: figma alignments
* feat: migrate toggle to tailwind
* fix: row borders
* feat: disabled state
* feat: virtual list impl for card table based on window scroll
* fix: lint
* feat: virtualization + smaller contentcard items
* feat: use ContentCardTable + ContentCardItems
* feat: fix gap + border issues on last elm
* feat: cleanup + use proper searching
* fix: use TeleportOverflowMenu
* fix: fallback to svg if src is invalid on avatar component
* fix: storybook
* feat: start on updater modal
* feat: finish content updater modal
* feat: i18n pass
* feat: impl modal
* feat(app): backend changes for content tab refactor (#5237)
* feat: include_changelog=false for updater modal
* fix: hash overrides
* feat: update checking for modpack
* feat: qa
* feat: modpack content modal
* fix: padding in table to match modals + tightness
* fix: lint
* feat: delete modal
* feat: fix toggle bugs
* fix: prepr
* fix: duplicate messages
* qa: full width search
* qa: use bg-surface-1.5
* qa: animation for filter pills
* qa: standardize hover colors
* fix: border-[1px] is border
* qa: mass de-select actually mass selecting
* qa: match figma designs for floating action bar
* qa: modal fixes
* q: modal fixes x2
* fix: table border
* qa: confirm modals
* qa: modal alignment
* qa: re-add stuck heading + dedupe logic
* qa: dedupe virtual scrolling + remove dead components
* qa: responsiveness for content table + link fixes
* qa: version column link, tooltips + lint fixes
* qa: instance busy protections
* fix: installation freeze bug
* chore: remove old mods page
* refactor: deduplicate layout
* chore: delete old content page(s)
* qa
* qa
* qa
* feat: sort btn - to iterate
* fix: ml
* feat: date added
* fix: lint
* fix: formatting.ts removal
* feat: get_dependencies_as_content_items
* qa: final QA changes
* refactor: deduplicate + polish content.rs
* feat: hook up content.vue with v1
* feat: hide v1 content api behind frontend feature flag
* fix: query keys + copy on empty state
* chore: i18n pass
* feat: reimpl unlink + upload endpoint
* feat: use bulk endpoints v1
* fix: lint
* fix: flags
* fix: responsiveness via container queries
* fix: lint
* qa: 1
* qa: fixes
* qa: fix ssr issues with browse content
* qa: header page divider
* qa: modals
* fix: prepr
* fix: issues
* fix: lint
* fix: toggle v1 ff
* qa: 5
* qa: delete modal copy
* feat: creation flow modals (#5383)
* refactor: delete content v0 usages + impl
* feat: qa + fixes
* feat: installing banner using state event
* feat: fix modpack card bugs + filtering issues
* refactor: delete backups v0 api module
* feat: v1 servers GET endpoint
* fix: backups
* feat: swap to kyros upload v1 addon
* fix: use tanstack for loader.vue
* feat: finish install from discovery modal
* qa: bug fixes
* feat: set up installation settings
* fix: lint
* fix: typos
* fix: bugs
* fix: disable inline content
* feat: content tab improvements — upload UX, installation settings, and client-only indicators
Upload cancellation and navigation guard:
- Add ConfirmLeaveModal that prompts when navigating away during upload
- Cancel in-flight XHR uploads when user confirms leaving the page
- Add beforeunload handler to warn on browser/tab close during upload
- Track uploadedBytes/totalBytes in UploadState for progress display
- Replace Collapsible with Transition for upload progress admonition
- Show byte progress and percentage in upload banner
- Clamp upload progress to prevent exceeding 100%
Installation settings (server.properties):
- Add KnownPropertiesFields and PropertiesFields types to Archon types
- Add buildProperties() to creation flow context to collect gamemode,
difficulty, seed, world type, structures, and generator settings
- Pass properties through installContent on onboarding, discovery, and
ServerSetupModal flows
Server setup and discovery flow improvements:
- Migrate ServerSetupModal from servers_v0.reinstall to content_v1.installContent
- Replace loaderApiNames lookup with toApiLoader() helper
- Remove eraseDataOnInstall toggle — always use soft_override: false
- Simplify modpack install on discovery page to use first available version
and route through creation flow modal for both onboarding and non-onboarding
- Differentiate post-install navigation: content page for onboarding,
loader options for existing servers
Modpack update flow:
- Replace updateModpack() call with installContent() using soft_override: true
to support version selection in the content updater modal
Client-only mod indicators:
- Add environment field to AddonVersion (reuses Labrinth.Projects.v3.Environment)
- Add environment to ContentItem and isClientOnly to ContentCardTableItem
- Show orange TriangleAlertIcon with tooltip on client-only mods in content table
- Add "Client-only" filter pill to content filtering (controlled via
showClientOnlyFilter on ContentManagerContext)
- Apply client-only indicators in both ContentPageLayout and ModpackContentModal
Misc:
- Add CLAUDE.md note about using prepr commands for lint checks
- Export ConfirmLeaveModal from instances barrel
* fix: piping
* fix: switch content disable for linked server instances
* feat: client only filter
* fix: prepr
* feat: hasUpdate shape update
* feat: bulk update endpoint impl for content in panel
* feat: websocket state impl again with new phases
* fix: ws
* fix: use timeout fn for sync admon + fix content card layout scroll for browsers with overflow anchor bug
* fix: qa bugs
* fix: lint, a11y and i18n
* refactor: set up layouts folder properly
* fix: linked data cache stuff + lint
* feat: move installationsettings to shared layout
* fix: lint
* fix: issues
* feat: temp fuck staging up
* fix: lockfile
* fix: data sync issues on loader.vue
* fix: lint
* Hide shader configuration files from content list (#5499)
* feat: workaround search problem + split out reset
* fix: qa
* fix: changelog not showing on first open
* fix: qa + optimistic updating improvements
* fix: prepr+lint
* fix: qa
* feat: qa
* fix: lint
* fix: lint
* fix: build
* fix: build
* fix: type errors
* fix: fade and JAVA_HOME passthrough
* feat: qa
* feat: impl diff shit
* fix: qa
* fix: app qa
* feat: update diff modal
* fix: endpoint
* fix: qa
* fix: qa
* fix: use bulk in modpack modal
* feat: abort signal impl + fix issues
* fix: diff modal trunc
* feat: qa
* fix: qa
* feat: tooltip content tab
* fix: prepr
* fix: dismiss on settings btn
* feat: qa
* feat: dont clear handlers on disconnect
* fix: lint
* fix: wrangler + introduce staging-archon env file
---------
Signed-off-by: Calum H. <calum@modrinth.com>
Co-authored-by: tdgao <mr.trumgao@gmail.com>
Co-authored-by: Artyom Ezri <61311568+Artezon@users.noreply.github.com>
2026-03-12 20:24:32 +00:00
├── layouts/ # Self-contained page layouts (see below)
2026-02-27 17:21:35 +00:00
├── providers/ # Dependency injection contexts (createContext pattern)
├── utils/ # Utility functions and constants
├── pages/ # Cross platform page components (used in both app-frontend and frontend)
├── locales/ # 34 language locale files (FormatJS)
├── styles/ # Tailwind CSS utilities
└── stories/ # Storybook story files
```
Each subdirectory under `components/` has an `index.ts` barrel file. All public API is re-exported from the root `index.ts` .
feat: content tab rewrite for worlds (#5136)
* feat: base content card component
* fix: tooltips + colors
* feat: fix orgs
* feat: base content tab internals rewrite
* feat: fix invalidmodal
* feat: add ContentModpackCard
* fix: extract types
* draft: layout
* feat: unlink modal
* feat: impl content tab
* fix: lint
* fix: toggling
* temp: disable updating stuff
* feat: selection v-model
* feat: bulk selection
* feat: mods tab rough draft
* feat: use fuse.js
* feat: add project combobox
* clean up project combobox
* feat: start install to play modal
* fix: events
* feat: use v-on
* feat: bulk actions + fix floating action bar width
* feat: figma alignments
* feat: migrate toggle to tailwind
* fix: row borders
* feat: disabled state
* feat: virtual list impl for card table based on window scroll
* fix: lint
* feat: virtualization + smaller contentcard items
* feat: use ContentCardTable + ContentCardItems
* feat: fix gap + border issues on last elm
* feat: cleanup + use proper searching
* fix: use TeleportOverflowMenu
* fix: fallback to svg if src is invalid on avatar component
* fix: storybook
* feat: start on updater modal
* feat: finish content updater modal
* feat: i18n pass
* feat: impl modal
* feat(app): backend changes for content tab refactor (#5237)
* feat: include_changelog=false for updater modal
* fix: hash overrides
* feat: update checking for modpack
* feat: qa
* feat: modpack content modal
* fix: padding in table to match modals + tightness
* fix: lint
* feat: delete modal
* feat: fix toggle bugs
* fix: prepr
* fix: duplicate messages
* qa: full width search
* qa: use bg-surface-1.5
* qa: animation for filter pills
* qa: standardize hover colors
* fix: border-[1px] is border
* qa: mass de-select actually mass selecting
* qa: match figma designs for floating action bar
* qa: modal fixes
* q: modal fixes x2
* fix: table border
* qa: confirm modals
* qa: modal alignment
* qa: re-add stuck heading + dedupe logic
* qa: dedupe virtual scrolling + remove dead components
* qa: responsiveness for content table + link fixes
* qa: version column link, tooltips + lint fixes
* qa: instance busy protections
* fix: installation freeze bug
* chore: remove old mods page
* refactor: deduplicate layout
* chore: delete old content page(s)
* qa
* qa
* qa
* feat: sort btn - to iterate
* fix: ml
* feat: date added
* fix: lint
* fix: formatting.ts removal
* feat: get_dependencies_as_content_items
* qa: final QA changes
* refactor: deduplicate + polish content.rs
* feat: hook up content.vue with v1
* feat: hide v1 content api behind frontend feature flag
* fix: query keys + copy on empty state
* chore: i18n pass
* feat: reimpl unlink + upload endpoint
* feat: use bulk endpoints v1
* fix: lint
* fix: flags
* fix: responsiveness via container queries
* fix: lint
* qa: 1
* qa: fixes
* qa: fix ssr issues with browse content
* qa: header page divider
* qa: modals
* fix: prepr
* fix: issues
* fix: lint
* fix: toggle v1 ff
* qa: 5
* qa: delete modal copy
* feat: creation flow modals (#5383)
* refactor: delete content v0 usages + impl
* feat: qa + fixes
* feat: installing banner using state event
* feat: fix modpack card bugs + filtering issues
* refactor: delete backups v0 api module
* feat: v1 servers GET endpoint
* fix: backups
* feat: swap to kyros upload v1 addon
* fix: use tanstack for loader.vue
* feat: finish install from discovery modal
* qa: bug fixes
* feat: set up installation settings
* fix: lint
* fix: typos
* fix: bugs
* fix: disable inline content
* feat: content tab improvements — upload UX, installation settings, and client-only indicators
Upload cancellation and navigation guard:
- Add ConfirmLeaveModal that prompts when navigating away during upload
- Cancel in-flight XHR uploads when user confirms leaving the page
- Add beforeunload handler to warn on browser/tab close during upload
- Track uploadedBytes/totalBytes in UploadState for progress display
- Replace Collapsible with Transition for upload progress admonition
- Show byte progress and percentage in upload banner
- Clamp upload progress to prevent exceeding 100%
Installation settings (server.properties):
- Add KnownPropertiesFields and PropertiesFields types to Archon types
- Add buildProperties() to creation flow context to collect gamemode,
difficulty, seed, world type, structures, and generator settings
- Pass properties through installContent on onboarding, discovery, and
ServerSetupModal flows
Server setup and discovery flow improvements:
- Migrate ServerSetupModal from servers_v0.reinstall to content_v1.installContent
- Replace loaderApiNames lookup with toApiLoader() helper
- Remove eraseDataOnInstall toggle — always use soft_override: false
- Simplify modpack install on discovery page to use first available version
and route through creation flow modal for both onboarding and non-onboarding
- Differentiate post-install navigation: content page for onboarding,
loader options for existing servers
Modpack update flow:
- Replace updateModpack() call with installContent() using soft_override: true
to support version selection in the content updater modal
Client-only mod indicators:
- Add environment field to AddonVersion (reuses Labrinth.Projects.v3.Environment)
- Add environment to ContentItem and isClientOnly to ContentCardTableItem
- Show orange TriangleAlertIcon with tooltip on client-only mods in content table
- Add "Client-only" filter pill to content filtering (controlled via
showClientOnlyFilter on ContentManagerContext)
- Apply client-only indicators in both ContentPageLayout and ModpackContentModal
Misc:
- Add CLAUDE.md note about using prepr commands for lint checks
- Export ConfirmLeaveModal from instances barrel
* fix: piping
* fix: switch content disable for linked server instances
* feat: client only filter
* fix: prepr
* feat: hasUpdate shape update
* feat: bulk update endpoint impl for content in panel
* feat: websocket state impl again with new phases
* fix: ws
* fix: use timeout fn for sync admon + fix content card layout scroll for browsers with overflow anchor bug
* fix: qa bugs
* fix: lint, a11y and i18n
* refactor: set up layouts folder properly
* fix: linked data cache stuff + lint
* feat: move installationsettings to shared layout
* fix: lint
* fix: issues
* feat: temp fuck staging up
* fix: lockfile
* fix: data sync issues on loader.vue
* fix: lint
* Hide shader configuration files from content list (#5499)
* feat: workaround search problem + split out reset
* fix: qa
* fix: changelog not showing on first open
* fix: qa + optimistic updating improvements
* fix: prepr+lint
* fix: qa
* feat: qa
* fix: lint
* fix: lint
* fix: build
* fix: build
* fix: type errors
* fix: fade and JAVA_HOME passthrough
* feat: qa
* feat: impl diff shit
* fix: qa
* fix: app qa
* feat: update diff modal
* fix: endpoint
* fix: qa
* fix: qa
* fix: use bulk in modpack modal
* feat: abort signal impl + fix issues
* fix: diff modal trunc
* feat: qa
* fix: qa
* feat: tooltip content tab
* fix: prepr
* fix: dismiss on settings btn
* feat: qa
* feat: dont clear handlers on disconnect
* fix: lint
* fix: wrangler + introduce staging-archon env file
---------
Signed-off-by: Calum H. <calum@modrinth.com>
Co-authored-by: tdgao <mr.trumgao@gmail.com>
Co-authored-by: Artyom Ezri <61311568+Artezon@users.noreply.github.com>
2026-03-12 20:24:32 +00:00
### `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 (e.g. `wrapped/hosting/manage/` ). These are full page implementations consumed by both `apps/frontend` and `apps/app-frontend` .
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` .
2026-02-27 17:21:35 +00:00
# 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.).
2026-03-26 18:55:15 +00:00
## Storybook
When modifying a component in `src/components/` , you must also update its corresponding Storybook story in `src/stories/` to reflect the changes. If a story file doesn't exist yet, create one. Stories should cover the component's key states and variants.
2026-02-27 17:21:35 +00:00
## 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
2026-04-12 15:38:08 -06:00
## 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')"
```