spa-routes

SPA Routes and Features Guide

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "spa-routes" with this command: npx skills add lobehub/lobehub/lobehub-lobehub-spa-routes

SPA Routes and Features Guide

SPA structure:

  • src/spa/ – Entry points (entry.web.tsx , entry.mobile.tsx , entry.desktop.tsx ) and router config (router/ ). Router lives here to avoid confusion with src/routes/ .

  • src/routes/ – Page segments only (roots).

  • src/features/ – Business logic and UI by domain.

This project uses a roots vs features split: src/routes/ only holds page segments; business logic and UI live in src/features/ by domain.

When to Use This Skill

  • Adding a new SPA route or route segment

  • Defining or refactoring layout/page files under src/routes/

  • Moving route-specific components or logic into src/features/

  • Deciding where to put a new component (route folder vs feature folder)

  1. What Belongs in src/routes/ (roots)

Each route directory should contain only:

File / folder Purpose

_layout/index.tsx or layout.tsx

Layout for this segment: wrap with <Outlet /> , optional shell (e.g. sidebar + main). Should be thin: prefer re-exporting or composing from @/features/* .

index.tsx or page.tsx

Page entry for this segment. Only import from features and render; no business logic.

[param]/index.tsx (e.g. [id] , [cronId] ) Dynamic segment page. Same rule: thin, delegate to features.

Rule: Route files should only import and compose. No new features/ folders or heavy components inside src/routes/ .

  1. What Belongs in src/features/

Put domain-oriented UI and logic here:

  • Layout building blocks: sidebars, headers, body panels, drawers

  • Hooks and store usage for that domain

  • Domain-specific forms, lists, modals, etc.

Organize by domain (e.g. Pages , Home , Agent , PageEditor ), not by route path. One route can use several features; one feature can be used by several routes.

Each feature should:

  • Live under src/features/<FeatureName>/

  • Export a clear public API via index.ts or index.tsx

  • Use @/features/<FeatureName>/... for internal imports when needed

  1. How to Add a New SPA Route

Choose the route group

  • (main)/ – desktop main app

  • (mobile)/ – mobile

  • (desktop)/ – Electron-specific

  • onboarding/ , share/ – special flows

Create only segment files under src/routes/

  • e.g. src/routes/(main)/my-feature/_layout/index.tsx and src/routes/(main)/my-feature/index.tsx (and optional [id]/index.tsx ).

Implement layout and page content in src/features/

  • Create or reuse a domain (e.g. src/features/MyFeature/ ).

  • Put layout (sidebar, header, body) and page UI there; export from the feature’s index .

Keep route files thin

  • Layout: export { default } from '@/features/MyFeature/MyLayout' or compose a few feature components + <Outlet /> .

  • Page: import from @/features/MyFeature (or a specific subpath) and render; no business logic in the route file.

Register the route

  • Add the segment to src/spa/router/desktopRouter.config.tsx (or the right router config) with dynamicElement / dynamicLayout pointing at the new route paths (e.g. @/routes/(main)/my-feature ).
  1. How to Divide Files (route vs feature)

Question Put in src/routes/

Put in src/features/

Is it the route’s layout wrapper or page entry? Yes – _layout/index.tsx , index.tsx , [id]/index.tsx

No

Does it contain business logic or non-trivial UI? No Yes – under the right domain

Is it a reusable layout piece (sidebar, header, body)? No Yes

Is it a hook, store usage, or domain logic? No Yes

Is it only re-exporting or composing feature components? Yes No

Examples

  • Route (thin):

src/routes/(main)/page/_layout/index.tsx → export { default } from '@/features/Pages/PageLayout'

  • Feature (real implementation):

src/features/Pages/PageLayout/ → Sidebar, DataSync, Body, Header, styles, etc.

  • Route (thin):

src/routes/(main)/page/index.tsx → Import PageTitle , PageExplorerPlaceholder from @/features/Pages and @/features/PageExplorer ; render with <PageTitle /> and placeholder.

  • Feature:

Page list, actions, drawers, and hooks live under src/features/Pages/ .

  1. Progressive Migration (existing code)

We are migrating existing routes to this structure step by step:

  • Phase 1 (done): /page route – segment files in src/routes/(main)/page/ , implementation in src/features/Pages/ .

  • Later phases: home, settings, agent/group, community/resource/memory, mobile/share/onboarding.

When touching an old route that still has logic or features/ inside src/routes/ :

  • Prefer adding new code in src/features/<Domain>/ and importing from routes.

  • For larger refactors, move existing route-only logic into the right feature and then thin out the route files (re-export or compose from features).

  • Use git mv when moving files so history is preserved.

  1. Reference Structure (after Phase 1)

Route (thin):

src/routes/(main)/page/ ├── _layout/index.tsx → re-export or compose from @/features/Pages/PageLayout ├── index.tsx → import from @/features/Pages, @/features/PageExplorer └── [id]/index.tsx → import from @/features/Pages, @/features/PageExplorer

Feature (implementation):

src/features/Pages/ ├── index.ts → export PageLayout, PageTitle ├── PageTitle.tsx └── PageLayout/ ├── index.tsx → Sidebar + Outlet + DataSync ├── DataSync.tsx ├── Sidebar.tsx ├── style.ts ├── Body/ → list, actions, drawer, etc. └── Header/ → breadcrumb, add button, etc.

Router config continues to point at route paths (e.g. @/routes/(main)/page , @/routes/(main)/page/_layout ); route files then delegate to features.

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

react

No summary provided by upstream source.

Repository SourceNeeds Review
-1.3K
lobehub
General

zustand

No summary provided by upstream source.

Repository SourceNeeds Review
General

project-overview

No summary provided by upstream source.

Repository SourceNeeds Review