Edit on GitHub

JSlop docs

Welcome. These docs cover the currently implemented surface of JSlop. Aspirational features (server functions, schema forms, local-first collections, devtools) are tracked in PLAN.md and TODO.md — they aren’t documented here yet because they don’t exist yet.

Warning

Status: pre-1.0. No semver guarantees, no release cadence. Everything below works end-to-end for the example apps in examples/.

Start here

  1. Introduction — what JSlop is and the mental model in 60 seconds.
  2. Getting started — install, run the examples, write your first component.
  3. Project structurepackage.json, vite.config.mjs, where files go.

Authoring .jslop files

  1. Componentscomponent, prop, state, let, function, view.
  2. Template syntax — tags, attributes, text interpolation, <children/>.
  3. Logic blocks{#if}, {#each}, keyed reconciliation.
  4. Eventson* handlers, inline mutations, component callbacks.
  5. Bindingsbind:value, bind:checked.
  6. Stylingclass={...}, global CSS, Tailwind v4.

Apps

  1. Routing — file-system routes, dynamic [param] segments, layouts, 404.
  2. SSR & resumability — how state survives the network without re-rendering.
  3. Building & deploying — the two-pass production build and @jslop/node-adapter.

Reference

  • Reactivitycell, derived, effect, batch, untrack, scopes.
  • Cheatsheet — every construct in one page.
  • FAQ — comparisons with Svelte / React / Solid / Qwik, common gotchas.
  • Roadmap — what’s done, what’s next, what’s out of scope.

For contributors

  • Internals/ — architecture, package layout, request flow. Not required to ship apps.

In a hurry? The whole DSL fits on one screen — see the cheatsheet. For everything else, the FAQ is probably faster than skimming the guide.

Last updated: May 15, 2026