Skip to main content

solidjs/solid — a trending TypeScript project

A declarative, efficient, and flexible JavaScript library for building user interfaces.

README of solidjs/solid on GitHub3 min read13 views
solidjs/solid — a trending TypeScript project

solidjs/solid — TypeScript · 36,307 stars · 1,151 forks · +37 today

A declarative, efficient, and flexible JavaScript library for building user interfaces.


SolidJS

Build Status Coverage Status

NPM Version Discord Subreddit subscribers

Website • Docs • Tutorial • Playground • Discord

Solid is a declarative JavaScript library for building user interfaces. Instead of a Virtual DOM, it compiles templates to real DOM nodes and updates them with fine-grained reactivity. Declare your state and use it throughout your app — when a piece of state changes, only the code that depends on it re-runs.

At a glance

#
import { createSignal } from "solid-js";
import { render } from "@solidjs/web";

function Counter() {
  const [count, setCount] = createSignal(0);
  const doubled = () => count() * 2;

  // The component body runs once. Only `{doubled()}` updates when count changes.
  return <button onClick={() => setCount(c => c + 1)}>{doubled()}</button>;
}

render(() => <Counter />, document.getElementById("app")!);

Try it in our Playground.

Explain this!

Solid compiles your JSX to real DOM operations at build time. The component function runs once on mount; reactivity is per-expression, not per-render. The {doubled()} expression compiles to a tracked update that only touches that one DOM position when count() changes.

import { template, delegateEvents, insert } from "@solidjs/web";
import { createSignal } from "solid-js";

const _tmpl$ = /*#__PURE__*/ template(`<button>`);

function Counter() {
  const [count, setCount] = createSignal(0);
  const doubled = () => count() * 2;

  return (() => {
    const _el$ = _tmpl$();
    _el$._$$click = () => setCount(c => c + 1);
    insert(_el$, doubled);
    return _el$;
  })();
}
delegateEvents(["click"]);

Reads update on the next microtask (or call flush() for synchronous interop). Effects are split into a tracking compute phase and a side-effecting apply phase — see the docs for the full model.

Key features

#
  • Fine-grained updates to the real DOM — no virtual DOM diff.
  • Declarative reactive primitives (createSignal, createMemo, createStore).
  • Render-once components — your component function is plain JavaScript that runs once.
  • Automatic dependency tracking — reading reactive state subscribes to it.
  • Microtask-batched updates with flush() for synchronous interop.
  • First-class async: any computation can return a Promise/AsyncIterable; <Loading> is the boundary.
  • Optimistic UI primitives (createOptimistic, createOptimisticStore) and structured action(...) mutations.
  • Streaming SSR and progressive hydration.
  • TypeScript-first, JSX-first, web-component friendly.
  • Universal: write custom renderers via @solidjs/universal to target non-DOM platforms.

Quick start

#

Start from a template:

npx degit solidjs/templates/solid-v2/basic my-app
cd my-app
npm install
npm run dev

Or add Solid to an existing Vite project:

npm i solid-js @solidjs/web
npm i -D vite @solidjs/vite-plugin
// vite.config.ts
import { defineConfig } from "vite";
import solid from "@solidjs/vite-plugin";

export default defineConfig({
  plugins: [solid()]
});

and point TypeScript at the web JSX types:

{
  "compilerOptions": {
    "jsx": "preserve",
    "jsxImportSource": "@solidjs/web"
  }
}

solid-js owns renderer-neutral component types, while renderer packages such as @solidjs/web and @solidjs/h own their JSX namespaces and jsx-runtime type entries.

Coming from Solid 1.x?

#

Read the migration guide. Solid 1.x is maintained on the 1.x branch, installs with npm i solid-js@v1-latest, and its docs are at v1.solidjs.com.

For LLMs / AI assistants

#

The public API differs from any Solid examples that predate 2.0. Before generating Solid 2.0 code, read:

The primer and the cheatsheet ship inside the solid-js npm package (node_modules/solid-js/skills/solid-2.0/SKILL.md, node_modules/solid-js/CHEATSHEET.md; the build also emits the cheatsheet as the solid-2.0-cheatsheet skill). The packages carry the tanstack-intent keyword, so skill registries that scan node_modules find them.

Repository

#

This is a PNPM workspaces monorepo. The core runtime (solid-js, @solidjs/signals, @solidjs/web, @solidjs/universal, @solidjs/diagnostics) always shares one version. The two compilers share a version when they release together, and @solidjs/h, @solidjs/html and @solidjs/element version on their own.

Package Path Purpose
solid-js packages/solid Core runtime — components, flow controls, context, hydration.
@solidjs/signals packages/signals Reactive primitives — signals, memos, effects, stores.
@solidjs/web packages/web Web platform runtime — render, hydrate, SSR, Portal, dynamic.
@solidjs/h packages/h Hyperscript / JSX factory.
@solidjs/html packages/html Build-less tagged template literals.
@solidjs/universal packages/universal Universal runtime for custom renderers.
@solidjs/element packages/element Web Components wrapper.
@solidjs/compiler packages/compiler Native Oxc JSX compiler.
@solidjs/babel-plugin packages/babel-plugin Babel plugin for JSX compilation.
@solidjs/diagnostics packages/diagnostics Dev-only diagnostics and attribution harness for tests and agents.

Runtime DOM operations live in @solidjs/web (and @solidjs/universal / @solidjs/h / @solidjs/html). The JSX compilers and the DOM runtime live in this repo, so file their issues here, not on DOM Expressions. The API reference in one page is packages/solid/CHEATSHEET.md, and the design notes are under documentation/solid-2.0/.

Why Solid?

#

Performant

#

Engineered for performance with years of research behind it — Solid's runtime cost is close to optimized vanilla JavaScript on the JS Framework Benchmark. Small, fully tree-shakable, fast on the server too. (Read more about Solid's performance.)

Powerful

#

Performant state management is built in (Context, Stores, Projections). Async is a first-class capability of computations, with <Loading> / <Errored> boundaries and isPending for revalidation indicators. Full SSR, streaming, and progressive hydration when you're ready to move to the server.

Pragmatic

#

Components are plain functions. Rendering is determined by how state is used — no rendering system to learn. Read-write segregation is encouraged but not enforced.

Productive

#

Built on JSX and TypeScript, integrates with the Vite ecosystem. Bare-metal abstractions give you direct access to the DOM. Growing ecosystem of primitives, component libraries, and build-time utilities.

More

#

Browser support

#

SolidJS Core supports the last 2 years of modern Firefox, Safari, Chrome, and Edge (desktop and mobile). IE and similar sunset browsers are not supported. For server environments, Node LTS, the latest Deno, and Cloudflare Worker runtimes are supported.

Community

#

Come chat on Discord. Solid's maintainers are active there, and we're always looking for contributions.

Contributors

#

Open Collective

#

Support us with a donation and help us continue our activities. [Contribute]

Sponsors

#

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]


Content above is the README of solidjs/solid, reproduced from GitHub’s trending list. All rights remain with the original authors.

Share this article

Newsletter

New posts in your inbox. Confirm by email, unsubscribe any time.

Comments

Posting as a guest

View all
Web Development

toeverything/AFFiNE — a trending TypeScript project

There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.

via GitHub · 6 min