MATES / Docs

Ecosystem

First-party packages around the core framework — UI kit, virtualization, icons, charts, storage, SSG, and the fullstack stack.

How the packages fit

mates is the client framework (this site). mates-raw is the standalone mount-once component engine behind xRaw — usable without mates. UI, icons, virtualization, charts, and IndexedDB ship as optional packages. Static prerendering is mates-ssg. Server RPC, auth, security middleware, and document SSR live in mates-fullstack — documented on mates-fullstack-home. There is no separate mates-ssr package.

Core & UI

Package
What it gives you
Docs / install
mates Framework: atoms, templates, router, actions, hooks, fetch, portals, dates, CSS-in-JS, WebSocket This site · npm install mates
mates-raw Standalone mount-once class components on lit-html 3.2.1 — the engine behind xRaw. Use without mates (vanilla / React islands), or import xRaw from mates RawComponents · npm install mates-raw
mates-ui Material-inspired component library — Buttons, TextFields, DataTables, Dialogs, CommandPalette, and more ui.mates-js.dev · npm install mates-ui
mates-icons Material Symbols as tree-shakeable typed template functions icons.mates-js.dev · npm install mates-icons
mates-ui-glass Glass theme tokens / surfaces for mates-ui Monorepo package — pair with mates-ui docs

Data & performance

Package
What it gives you
Docs / install
mates-virtual Virtualization directives: virtualList, virtualTable, virtualMasonry, masonryGrid npm install mates-virtual · Virtual lists · Performance
mates-charts Reactive Highcharts wrapper — charts update when their atoms do mates-charts-docs · npm install mates-charts
mates-db IndexedDB persistence — reactive tables (DBAtom), key-value storage, heavy-value atoms In the monorepo — npm release pending

Build & rendering

Package
What it gives you
Docs / install
mates-ssg Static site generator — prerenders an SPA to per-route HTML with sitemap, robots, and redirects npm install -D mates-ssg · Deployment
mates-fullstack Node.js fullstack server — RPC, REST, JWT auth, security middleware, SSE, WebSockets, document SSR (useSSR()) mates-fullstack-home · npm install mates-fullstack
mates-pdf Virtualized PDF viewer component (pdf.js based) In the monorepo — npm release pending

Fullstack addons

These plug into mates-fullstack servers. Auth, security, and SSR are in-core; the packages below are optional addons in the monorepo:

  • Auth (in mates-fullstack) — JWT cookie sessions, roles, route guards, Arctic OAuth
  • Security (in mates-fullstack) — opt-in middleware: security headers, CSP, CORS, CSRF, rate limiting, IP filtering
  • SSR (in mates-fullstack)useSSR() for anonymous document HTML + mates-fullstack/meta
  • mates-fs-ws — WebSocket server + browser client for fullstack apps
  • mates-fs-build — esbuild compiler with RPC stub generation and the server/client boundary
  • mates-fs-api-docs — interactive RPC/REST docs page served at /api/docs
  • mates-fs-sso — experimental cross-domain SSO (not ready for production)

Tooling

  • create-mates — project scaffolder (SPA / Fullstack SPA / Fullstack SSR) — CLI guide
  • Mates DevTools — in-app panel for component and state inspection — see DevTools
  • mates-ide — in-browser playground used by this docs site