# SolidJS Documentation

> Documentation for the Solid 2.0 release candidate, including reactivity, web rendering, routing, metadata, and Vite integration.

For a single-file corpus, use [llms-full.txt](https://deploy-preview-1657--solid-docs-v2.netlify.app/llms-full.txt).
For a short primer with one line per solid-js export, use [llms-small.txt](https://deploy-preview-1657--solid-docs-v2.netlify.app/llms-small.txt).

## Overview

- [Overview](https://deploy-preview-1657--solid-docs-v2.netlify.app/index.md): What Solid is, what these docs cover, and where to start reading.

## Getting Started

- [Quick start](https://deploy-preview-1657--solid-docs-v2.netlify.app/getting-started/quick-start.md): Go from an empty directory to a running Solid app with a change of your own in it, and meet the ideas the rest of the docs build on.
- [Project shapes](https://deploy-preview-1657--solid-docs-v2.netlify.app/getting-started/project-shapes.md): Pick between the bare, basic, and fullstack templates by what your app needs on day one, knowing that moving up later changes configuration, not your code.

## Concepts

- [Reactivity](https://deploy-preview-1657--solid-docs-v2.netlify.app/concepts/reactivity.md): Signals, memos, and effects: how Solid tracks reads, why a component runs once, and how to tell when a value will update.
- [Components and JSX](https://deploy-preview-1657--solid-docs-v2.netlify.app/concepts/components-and-jsx.md): Components as functions that run once: props, children, control flow, refs, and the JSX rules that follow from that.
- [Stores](https://deploy-preview-1657--solid-docs-v2.netlify.app/concepts/stores.md): Hold a cart, a form, or any nested object in a store: update one property through a draft, derive filtered views with a projection, and load server data into the same proxy.
- [Async reactivity](https://deploy-preview-1657--solid-docs-v2.netlify.app/concepts/async-reactivity.md): Read a promise like a value: how async memos hold updates, when Loading shows a fallback, and how mutations settle.
- [Boundaries](https://deploy-preview-1657--solid-docs-v2.netlify.app/concepts/boundaries.md): Decide which part of the page shows a spinner, which part shows an error, and in what order regions appear, by placing Loading, Errored, and Reveal around the right subtree.
- [Mutations](https://deploy-preview-1657--solid-docs-v2.netlify.app/concepts/mutations.md): Move the cart's add, remove, and set-quantity writes to a server without changing the UI: actions, optimistic stores, refresh, and how a failed request undoes itself.
- [Rendering and SSR](https://deploy-preview-1657--solid-docs-v2.netlify.app/concepts/rendering-and-ssr.md): Run the same components in the browser and on the server: keep browser-only code off the server, get matching HTML for hydration, and choose between string and streaming rendering.

## Building Apps

- [App structure](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/app-structure.md): Know which two files in a start-mode project you edit, what the plugin generates around them, and when to replace a generated entry or hook a router into the server render.
- [Styling and assets](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/styling-and-assets.md): Style a component with global CSS, a CSS module, Tailwind, or an inline style object, toggle classes without string building, and reference images so the built URL is hashed.
- [Head and metadata](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/head-and-metadata.md): Give each page its own title and meta tags from the component that owns them, let a layout's defaults return when the page unmounts, and read a title from data that is still loading.

### Server Functions

- [Server functions](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/server-functions.md): Move a database query or a secret out of the browser by marking a function with "use server", and recognize what that call becomes on the wire.
- [Reads, streams, and live data](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/server-functions/reads-and-live-data.md): Declare a product read that HTTP caches can store, stream order events from a server function, and keep a stock level connected when another shopper changes it.
- [Arguments and security](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/server-functions/arguments-and-security.md): Send arguments a server function can decode, and validate and authorize every call as if it came from a terminal, because it can.
- [Mutations and responses](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/server-functions/mutations-and-responses.md): Return a value, a redirect, a reload, or a 400 from a cart or account mutation, and control what a thrown error reveals in production.
- [Metadata and transport](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/server-functions/metadata-and-transport.md): Read a server-function request in the network tab, attach a header to every call, move the endpoint, and cancel one call in flight.
- [Progressive enhancement](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/server-functions/progressive-enhancement.md): Make the Add to cart form post to a server function before JavaScript loads, and know which part of that exchange core owns and which the router adds.
- [Streaming AI responses](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/server-functions/streaming-ai-responses.md): Forward a model's token stream through a server function into a store one chunk at a time, stop it from the browser or by asking a new question, and render the Markdown without re-rendering what has already landed.
- [Durable generation](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/server-functions/durable-generation.md): Run an AI reply as a job that outlives the request that started it, store the reply as it grows, and deliver it through a live source so a closed tab loses nothing and two tabs read the same reply.
- [Sessions and auth](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/sessions-and-auth.md): Build a signed cookie session on the request event, sign customers in and out from server functions, and authorize every server entry point against that session.
- [Environment](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/environment.md): Declare environment variables once, read secrets on the server and public values in the browser through typed modules, and let the build fail when a secret would leak.
- [Middleware and API routes](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/middleware-and-api-routes.md): Run code in front of every request with fetch-style middleware, share state with pages and server functions through the request event, and answer HTTP requests from route modules.
- [Deployment](https://deploy-preview-1657--solid-docs-v2.netlify.app/building-apps/deployment.md): Put a start-mode build on a host: serve dist/client as static files, route everything else to the built request handler, supply the server environment at boot, and pick a Node server or a provider adapter.

## Routing

- [Routing overview](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/overview.md): Choose between Solid Router and TanStack Router for a Solid app, mount the router in App, and decide whether routes come from an array or from files under src/routes.

### Solid Router

- [Solid Router](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/solid-router.md): Build a small routed store with Solid Router: a product page that reads its id from the URL, a header that stays mounted, typed links, and route data that starts loading before the page renders.
- [Setup](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/solid-router/setup.md): Add Solid Router to a project that does not have it, mount one router at the application root, and set the options for a base path, hash history, or preloading.
- [Route definitions](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/solid-router/route-definitions.md): Write the route objects Solid Router matches against: path patterns with required, optional, and wildcard segments, typed parameters, match filters, metadata, lazy subtrees, and the file-system manifest.
- [Nested routes and layouts](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/solid-router/nested-routes.md): Wrap a group of pages in a shared layout, keep it mounted while pages change, share parameters down the tree, and load data at every level without a waterfall.
- [Navigation and typed paths](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/solid-router/navigation.md): Link between pages with plain anchors, build URLs the compiler checks, navigate from code, read the location and search parameters, show active and pending links, and guard against leaving a page.
- [Data loading and mutations](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/solid-router/data.md): Start route data early with preloads, cache and share reads with query, submit mutations with actions, show optimistic state, and control what revalidates.
- [Server rendering and hydration](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/solid-router/server-rendering.md): Render Solid Router on the server: read the URL from the request, hydrate query results without a second fetch, return fresh data from a mutation in one round trip, and keep forms working without JavaScript.

### Tanstack

- [TanStack Router](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/tanstack.md): Use TanStack Router and TanStack Query with Solid's server functions, streaming SSR, and single-flight mutations, as the fullstack-tanstack project shape does.
- [Integrate a router](https://deploy-preview-1657--solid-docs-v2.netlify.app/routing/integrate-a-router.md): Wire a router that Solid does not ship into start mode: give it the request URL and a per-request instance, and connect it to the single-flight mutation transport.

## Guides

- [Thinking in Solid](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/thinking-in-solid.md): Build the storefront's product search end to end, and at each step see what a React or Vue developer would reach for and what Solid does instead.
- [Avoid unnecessary effects](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/avoid-unnecessary-effects.md): Recognize the effect that copies one reactive value into another, replace it with a direct, memoized, async, or writable derivation, and keep createEffect for the imperative boundary.
- [Custom primitives](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/custom-primitives.md): Move repeated reactive setup into a createX function that runs inside an owner, accepts accessors, returns accessors, cleans up what it starts, and stays correct during server rendering.
- [State management](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/state-management.md): Decide where each piece of storefront state lives: a component, a context provider, the URL, or the server, and keep it out of module scope in code that also runs on the server.
- [Forms](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/forms.md): Build a form with a server function and a Solid Router action: it works before JavaScript loads, validates on the server, and after hydration shows pending state, inline errors, and the saved result before the server confirms.
- [Lists](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/lists.md): Render, edit, filter, sort, select in, and window lists without rebuilding rows, and read the diagnostics that tell you when you are.
- [Data fetching patterns](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/data-fetching-patterns.md): Load data for search, detail pages, pagination, shared state, and dashboards without loading flags, request counters, or abort controllers, and decide where each request and each boundary goes.
- [Protected routes](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/protected-routes.md): Require a signed-in customer for the account area at the data, route, and request layers, redirect a signed-out visitor to sign-in on the server and in the browser, and send them back where they were going.
- [SSR-safe code](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/ssr-safe-code.md): Keep browser APIs, per-run values, and client-only data out of the server render, and read each hydration warning to find the line that made the server and the browser disagree.
- [Choose a rendering mode](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/choose-a-rendering-mode.md): Decide between a static shell, streaming server rendering, and build-time prerendering for a start-mode project, and what each one costs.
- [Debugging reactivity](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/debugging-reactivity.md): Find out why a value does not update, why it updates too often, and how to read Solid's development diagnostics.
- [Performance](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/performance.md): Measure a slow catalog page with the browser profiler and Solid's attribution tables, then fix the cause each measurement points at: hot derivations, wide writes, rebuilt rows, waterfalls, unsplit code, and a blocked streaming shell.
- [TypeScript](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/typescript.md): Replace the any annotations in a storefront with the types Solid exports for props, children, accessors, store drafts, event handlers, refs, server function results, and typed routes.
- [Integrate non-Solid code](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/integrate-non-solid-code.md): Drive a charting library, a map, a web component, or an analytics script from Solid state: get the DOM node at the right time, create the instance once, update it in an effect, and keep browser-only imports off the server.
- [Testing](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/testing.md): Write a component test that clicks a button and asserts the label, run it in jsdom or a real browser, and test fullstack server code in a separate Node project.
- [Observability](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/observability.md): Report the errors your boundaries catch in production, follow a request from the server into the browser, and see what each user interaction cost, without wrapping a component.
- [Build an observability adapter](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/observability-adapters.md): Connect an error monitor or a tracing SDK to a Solid app through the runtime's hooks and channels, with nothing wrapped, patched, or rewritten.
- [Solid for AI tools](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/ai-tools.md): Point a coding assistant at the cheatsheet, skills, diagnostics, lint configs, and Markdown docs that ship with Solid 2.0, and paste a rules block into its instructions file.
- [Chat state for the AI SDK](https://deploy-preview-1657--solid-docs-v2.netlify.app/guides/ai-sdk-chat.md): Drive the AI SDK's chat class from a Solid store with a short ChatState adapter, so messages, status, and errors update the exact nodes that read them.

## Migration

- [From Solid 1.x](https://deploy-preview-1657--solid-docs-v2.netlify.app/migration/from-solid-1.md): Migrate a Solid 1.x application to Solid 2, including package imports, reactivity, effects, stores, async data, rendering, and tests.
- [Data fetching from Solid 1](https://deploy-preview-1657--solid-docs-v2.netlify.app/migration/data-fetching-from-solid-1.md): Move Solid 1 data loading patterns to async computations one fetch at a time, and decide per fetch whether an update should wait, dim, or show a placeholder.
- [From SolidStart](https://deploy-preview-1657--solid-docs-v2.netlify.app/migration/from-solid-start.md): Move a SolidStart 1 or released SolidStart 2 application to Solid 2 through @solidjs/vite-plugin start mode.
- [From Solid Router 0.x/1.x](https://deploy-preview-1657--solid-docs-v2.netlify.app/migration/from-solid-router.md): Migrate JSX routes and the Solid Router 0.x/1.x data APIs to a Solid Router 2 createRouter instance.
- [From Solid Meta 0.x](https://deploy-preview-1657--solid-docs-v2.netlify.app/migration/from-solid-meta.md): Migrate your application from @solidjs/meta 0.x to 1.0.
- [From React](https://deploy-preview-1657--solid-docs-v2.netlify.app/migration/from-react.md): Map familiar React concepts to their closest Solid concepts, with equivalent examples and the semantic differences that matter during migration.

## Glossary

- [Glossary](https://deploy-preview-1657--solid-docs-v2.netlify.app/glossary.md): Solid's own words, each defined in a few sentences and linked to the page that teaches it.

## Reference

- [Reference](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference.md): API reference for Solid: the reactive core, the web renderer, Solid Router, Solid Meta, the Vite plugin, and filesystem routing.

### solid-js

- [solid-js](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js.md): Reference for the solid-js package: reactive primitives, stores, actions, context, flow components, and the public types.

#### Reactivity

- [createEffect](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/reactivity/create-effect.md): Creates a reactive effect with separate compute and effect phases.
- [createMemo](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/reactivity/create-memo.md): Creates a readonly derived reactive memoized signal.
- [createOptimistic](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/reactivity/create-optimistic.md): Creates an optimistic signal — a `Signal<T>` whose writes are tentative inside an `action`: they show up immediately, then auto-revert (or reconcile to the action's resolved value) once the pending work settles.
- [createSignal](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/reactivity/create-signal.md): Creates a simple reactive state with a getter and setter.
- [flush](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/reactivity/flush.md): Synchronously processes the pending reactive queue, or runs `fn` in a synchronous flush scope before draining the queue.
- [isPending](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/reactivity/is-pending.md): Returns whether the reactive reads inside `fn` depend on an in-flight value change that has not been revealed.
- [latest](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/reactivity/latest.md): Reads the freshest in-flight value available inside `fn`, falling back to the current settled value.
- [untrack](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/reactivity/untrack.md): Runs `fn` outside of any reactive tracking — reads inside `fn` will not subscribe the current scope. Returns whatever `fn` returns.

#### Stores

- [createOptimisticStore](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/stores/create-optimistic-store.md): The store equivalent of `createOptimistic`.
- [createProjection](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/stores/create-projection.md): Creates a derived (projected) store — `createMemo` for stores. The derive function receives a mutable draft and either mutates it in place (canonical) or returns a new value.
- [createStore](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/stores/create-store.md): Creates a deeply-reactive store backed by a Proxy. Reads track each property accessed; only the parts that change trigger updates.
- [merge](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/stores/merge.md): Merges multiple props-like objects into a single proxy that preserves reactivity.
- [omit](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/stores/omit.md): Returns a reactive proxy of `props` with the listed keys hidden. Tracking on the remaining keys is preserved.
- [reconcile](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/stores/reconcile.md): Creates a store setter callback that merges new data into the existing store by key.

#### Lifecycle Actions

- [action](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/lifecycle-actions/action.md): The primitive for mutations: imperative async workflows whose writes span an async gap — optimistic write, server round-trip, reconciling write — where intermediate state must not leak and failure must revert cleanly (pair with `createOptimistic` / `createOptimisticStore`).
- [affects](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/lifecycle-actions/affects.md): Marks a reactive source or store location as pending while work that will change it is in flight.
- [onSettled](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/lifecycle-actions/on-settled.md): Schedules `callback` to run once after the reactive graph has fully settled — i.e. once every pending async read inside the current owner has resolved and the queue has flushed.
- [refresh](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/lifecycle-actions/refresh.md): Invalidates one reactive source, forcing it to re-execute even if its inputs haven't changed, and returns a promise for the target's next settled state — the re-ask (and anything that supersedes it) has settled.
- [until](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/lifecycle-actions/until.md): Awaits a reactive predicate and resolves the first time it becomes truthy, with the narrowed value.

#### Components Context

- [children](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-context/children.md): Resolves a `children` accessor and exposes the result as an accessor with a `.toArray()` helper.
- [createContext](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-context/create-context.md): Creates a Context for sharing state with descendants of a Provider in the component tree.
- [createUniqueId](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-context/create-unique-id.md): Returns a stable id string that matches between server-rendered and client-hydrated trees. Use it for `<label for>`, `aria-labelledby`, and other attributes that need consistent ids across SSR.
- [lazy / lazyModule](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-context/lazy.md): Defines a code-split component. The returned component triggers its dynamic import on first render and suspends through any enclosing `<Loading>` boundary while the chunk is in flight.
- [useContext](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-context/use-context.md): Reads the current value of a context.

#### Components Jsx

- [Errored](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-jsx/errored.md): Catches uncaught errors inside its subtree and renders fallback content instead.
- [For](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-jsx/for.md): Creates a list of elements from a list.
- [Loading](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-jsx/loading.md): Renders a `fallback` while pending async reads inside the subtree settle.
- [Repeat](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-jsx/repeat.md): Creates a list of elements from a count.
- [Reveal](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-jsx/reveal.md): Coordinates the reveal timing of sibling `<Loading>` boundaries.
- [Show](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-jsx/show.md): Conditionally renders its children when `when` is truthy, otherwise renders the optional `fallback`.
- [Switch / Match](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/components-jsx/switch-and-match.md): Switches between content based on mutually exclusive conditions. Renders the first `<Match>` whose `when` is truthy; falls back to `fallback` when none match.

#### Advanced

##### Owner Introspection

- [createRoot](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/owner-introspection/create-root.md): Creates a reactive root — an owner scope with its own `dispose()`.
- [getObserver](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/owner-introspection/get-observer.md): Returns the currently-tracking observer (the computation that subscribes to reactive reads at this point), or `null` if reads here would be untracked.
- [getOwner](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/owner-introspection/get-owner.md): Returns the current reactive owner — the lifecycle node that the next `cleanup()` / `onCleanup()` / `createSignal()` etc. Will be attached to.
- [isDisposed](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/owner-introspection/is-disposed.md): Returns `true` when an owner has been disposed. Use it to ignore late work after the owner’s component or reactive scope has been removed.
- [runWithOwner](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/owner-introspection/run-with-owner.md): Executes `fn` with the given `owner` set as the current owner.

##### Specialized Reactivity

- [createReaction](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/specialized-reactivity/create-reaction.md): Creates a reactive computation that runs after the render phase with flexible tracking.
- [createRenderEffect](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/specialized-reactivity/create-render-effect.md): Creates a reactive computation that runs during the render phase as DOM elements are created and updated but not necessarily connected.
- [createTrackedEffect](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/specialized-reactivity/create-tracked-effect.md): Creates a tracked reactive effect where dependency tracking and side effects happen in the same scope.
- [onCleanup](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/specialized-reactivity/on-cleanup.md): Low-level reactive-cleanup primitive. Registers a callback that runs when the surrounding owner is disposed.

##### Store Advanced

- [deep](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/store-advanced/deep.md): Subscribes the surrounding scope to every reachable level of a store value, then returns its plain view.
- [isWrappable](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/store-advanced/is-wrappable.md): Returns whether a value would be wrapped in a store proxy.
- [markRaw](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/store-advanced/mark-raw.md): Mark a value so no store ever wraps it (sticky; it reads as a leaf).
- [snapshot](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/store-advanced/snapshot.md): Returns the plain, unwrapped view of a store value without tracking, for serialization or for passing to code that must not observe the store.
- [storePath](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/store-advanced/store-path.md): x setter paths. Prefer draft-mutating store setters in new code.

##### Jsx Component Primitives

- [mapArray](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/jsx-component-primitives/map-array.md): Reactively maps an array, reusing the previously-mapped value for unchanged items.
- [repeat](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/jsx-component-primitives/repeat.md): Reactively renders a callback `count` times, reusing previously-rendered entries when only the count changes. Underlying helper for `<Repeat>`.

##### Manual Hydration

- [Hydration](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/manual-hydration/hydration.md): Re-enables hydration within a `<NoHydration>` zone (passthrough on the client). Use it to opt a subtree back into hydration when the surrounding region was opted out.
- [isHydratable](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/manual-hydration/is-hydratable.md): Whether the calling owner sits where hydration applies — not under `<NoHydration>`, or back under a nested `<Hydration>` — so a value keyed to this position reaches a hydrating client.
- [isHydrating](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/manual-hydration/is-hydrating.md): Whether the code running now is claiming server-rendered DOM: the root pass of `hydrate()`, or code under a streamed `<Loading>` boundary while that boundary resumes.
- [NoHydration](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/manual-hydration/no-hydration.md): Disables hydration for its children on the client. During hydration, skips the subtree entirely (returns undefined so DOM is left untouched).
- [onHydrationEnd](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/manual-hydration/on-hydration-end.md): Runs `callback` once, when the hydration phase ends: the root pass of `hydrate()` is over and every streamed `<Loading>` boundary (and every hold an integration registers, such as server-component content waiting for its data) has resumed or been cancelled.

##### Interop Async

- [enableExternalSource](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/interop-async/enable-external-source.md): Registers an adapter that lets Solid track reads from a non-Solid reactive system, such as MobX or Vue reactivity, inside its computations.
- [flatten](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/interop-async/flatten.md): Resolves nested accessors and arrays in a children tree to their rendered values. See the `children()` helper in solid-js for the memoized form.
- [NotReadyError](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/interop-async/not-ready-error.md): Represents a read from an async reactive source before its first value is ready. Application code should normally let `Loading` and `Errored` boundaries handle this control flow.
- [resolve](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/interop-async/resolve.md): Awaits a reactive expression and returns its first fully-settled value as a `Promise`.

##### Diagnostics Dev Hooks

- [attribution / costs / feedback / formatOrigin / formatRerun / graphSize / subscriptions / why](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/diagnostics-dev-hooks/attribution.md): The attribution engine from `solid-js/attribution`: take a hold with `enable()`, read its interaction, navigation, hold, and re-run records on `OBSERVE.records.subscribe(type, …)` or from `history(type)`, and fold them with `costs()`, `feedback()`, `why()`, and `subscriptions()`.
- [configureClientErrors](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/diagnostics-dev-hooks/configure-client-errors.md): Registers the ambient client error hook: called once per error object when an error boundary renders its fallback, with where the error was thrown and where it was met.
- [DEV](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/diagnostics-dev-hooks/dev.md): Dev tier (devtools hooks, graph traversal, console reporting): dev builds only.
- [dispatchAsInteraction](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/diagnostics-dev-hooks/dispatch-as-interaction.md): Runs `fn` as a handler of the DOM event `e`, inside the interaction frame the runtime opens for `e` — the one its own listeners for `e` run in.
- [OBSERVE](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/advanced/diagnostics-dev-hooks/observe.md): The observe tier's wiring: the records channel the runtimes and the attribution engine deliver on, the diagnostics channel, the attribution slot, `ownerPath()`, and on the server the trace-provider slot.

#### Types

- [Component / ComponentProps / FlowComponent / FlowProps / ParentComponent / ParentProps / Ref / ValidComponent / VoidComponent / VoidProps](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/types/component-types.md): A general `Component` has no implicit `children` prop. If desired, specify one explicitly, e.g. `Component<{ name: string; children: Element }>`.
- [Context / ContextProviderComponent](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/types/context-types.md): Context API reference.
- [JSX](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/types/jsx-types.md): Selected public types from the `JSX` namespace. Element-specific attributes are available through `JSX.IntrinsicElements`.
- [Owner](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/types/owner.md): Represents the owner of a reactive scope. Treat its structure as opaque and use the public owner APIs to inspect or run code in that scope.
- [Accessor / Setter / Signal / SourceAccessor](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/types/reactive-types.md): A zero-arg getter for a reactive value. Calling it inside a tracking scope (memo, effect compute, JSX expression) subscribes the scope to changes.
- [Store / SolidStore](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-js/types/store-types.md): A reactive view of a store's value. Update it through the paired `StoreSetter`.

### @solidjs/web

- [@solidjs/web](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web.md): Reference for @solidjs/web: DOM and HTML rendering, hydration, the head registry, DOM components, JSX properties, server functions, the request event, and the Performance panel tracks.

#### Rendering Ssr

- [clientOnly](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/client-only.md): Creates a component that renders only in the browser. The server renders the fallback, and the client keeps that fallback through hydration before mounting the imported component.
- [getHydrationWriter](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/get-hydration-writer.md): The keyed server-to-client value channel of the render the caller belongs to — found through the caller's owner, else (no owner) through the request scope when exactly one render is open for that request.
- [httpHeader](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/http-header.md): Declares an HTTP response header (or with `append`, appends to one) for the lifetime of the current reactive scope during SSR — call it bare in a component or reactive-scope body.
- [httpStatus](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/http-status.md): Declares the HTTP response status (and optional status text) for the lifetime of the current reactive scope during SSR — call it bare in a component or reactive-scope body where the status is decided (a 404 route, an error fallback).
- [hydrate](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/hydrate.md): Attaches a Solid component tree to server-rendered DOM and returns a function that disposes the hydrated tree.
- [isDev](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/is-dev.md): Build-time constant that is `true` in development output and `false` in production output.
- [isServer](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/is-server.md): Build-time constant that is `true` in server output and `false` in browser output.
- [renderToStream](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/render-to-stream.md): Streams an HTML response, flushing the synchronous shell first and then progressively emitting async-resolved fragments as their `<Loading>` boundaries settle.
- [renderToString](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/render-to-string.md): Renders a component tree synchronously to an HTML string. Async reads inside `<Loading>` boundaries emit their `fallback` content; for full-graph resolution await `renderToStream` instead.
- [render](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/render.md): Renders a component tree into a DOM element. Returns a dispose function that tears the tree down and cleans up reactive scopes when called.
- [takeHydrationValue](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/rendering-ssr/take-hydration-value.md): Removes and returns the value the server render wrote under `key` with `getHydrationWriter().write(key, value)`, or `undefined` when the page carries none (or it was already taken).

#### Head

- [useHead](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/head/use-head.md): Registers one or more head tag descriptors with Solid's ambient head registry.
- [HeadTag](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/head/head-tag.md): Describes a tag registered with Solid's ambient head registry.

#### Components

- [dynamic / dynamicComponent](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/components/dynamic.md): Creates a stable component whose rendered component comes from a reactive source. The source can return a component, an intrinsic element name, a promise, or no component.
- [Portal](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/components/portal.md): Renders its children into a different part of the DOM (modal roots, tooltips, layers that need to escape an `overflow: hidden` ancestor).

#### JSX properties

- [ref](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/jsx-properties/ref.md): Receives a DOM element or composes several callbacks that apply behavior to it.
- [class](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/jsx-properties/class.md): Sets static and conditional class names from strings, objects, or nested arrays.
- [style](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/jsx-properties/style.md): Sets an element's inline styles from a CSS string or an object of declarations.
- [textContent](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/jsx-properties/text-content.md): Writes plain text as an element's complete contents through an optimized text-only path.
- [innerHTML](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/jsx-properties/inner-html.md): Parses an HTML string as an element's complete contents.

#### Server Functions

- [Server functions](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions.md): Reference for Solid's server-function declarations, transport, and host integration.
- [parseServerFunctionActionUrl / serverFunctionActionUrl / serverFunctionUrl](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/addressing.md): Reads the function id back out of a server-rendered action url.
- [configureServerFunctionsClient](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/configure-client.md): Configures the browser server-function endpoint, codec, request preparation, and response integration.
- [GET](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/get.md): Declares that a server-function read can use HTTP GET. Calls use a cacheable URL when the encoded arguments fit and fall back to a read-only POST when they do not.
- [configureServerFunctionsServer / handleServerFunctionRequest](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/host-configuration.md): Configures request scoping, invocation policy, result transforms, no-JavaScript handling, origin checks, and codecs for server functions.
- [getServerFunctionInvocation](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/invocation-context.md): Returns the identity of the server function that is currently executing.
- [invoke](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/invoke.md): Calls a server function with invocation-scoped `signal`, `keepalive`, or `priority` options.
- [live](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/live.md): Declares a server function whose async iterable represents one value that changes over time.
- [withMeta / getServerFunctionMetadata / isServerFunction](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/metadata.md): Attaches declaration metadata to a server-function reference and returns the reference.
- [createNoJSHandler](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/progressive-enhancement.md): Creates the default response handler for browser form submissions made without the client runtime.
- [enableRichArguments](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/rich-arguments.md): Enables codec encoding for server-function arguments that JSON cannot preserve.
- [decodeResponse / registerFlightDataSource / subscribeFlightData](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/server-functions/single-flight.md): Decodes a server-function response, including response envelopes and single-flight payloads.

#### Request Response

- [Request and response](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response.md): Reference for request context, response metadata, cookies, redirects, and errors.
- [configureServerErrors / reportRequestFailure](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/configure-server-errors.md): Registers the ambient server error hook: called once per error object for every failure the server runtime handles or fails on, with the site that met it; the return value, when given, replaces what the client receives.
- [parseCookieHeader / serializeCookie](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/cookies.md): Parses a `Cookie` request header into a name → value map.
- [getRequestEvent](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/get-request-event.md): Returns the request event for the current server render, middleware chain, or server-function call.
- [getTraceContext](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/get-trace-context.md): The trace the current request belongs to — continued from the incoming W3C `traceparent` when there was one, originated by the runtime otherwise; in observe/dev builds, merged with the installed provider's answer (`OBSERVE.server.trace`).
- [provideRequestEvent](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/provide-request-event.md): Runs a callback in a server request-event scope backed by `AsyncLocalStorage`.
- [redirect / isHref](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/redirect.md): Creates a redirect `Response` (status 302 by default). Pass `revalidate` to name the cache keys the mutation invalidated so the client refetches them after following the redirect.
- [reload](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/reload.md): Creates an empty `Response` that asks the client to revalidate the named cache keys without navigating.
- [respond / isResponseEnvelope](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/respond.md): A value paired with response metadata (status, headers, `revalidate`) — for the things a naked return can't express.
- [markSafeError / isSafeError](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/request-response/safe-errors.md): Marks `error` as safe to serialize to the client verbatim, opting it out of production error sanitization (see `handleServerFunctionRequest`).

#### Performance Tracks

- [enablePerformanceTracks](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-web/performance-tracks/enable-performance-tracks.md): Paint the attribution engine's records — and the web runtime's server-function `call` and `frame` records, with the server's own timing for each response under them (its `Server-Timing` metrics, placed by the browser's resource timing; the document's at enable) — as tracks in the Chrome Performance panel, from now until the returned function is called.

### @solidjs/router

- [@solidjs/router](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router.md): API reference for Solid Router 2, including router creation, navigation, data, history, file routes, and server integration.
- [Router factory](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router/router-factory.md): Reference for createRouter, defineRoute, defineRoutes, router configuration, and router instances.
- [Routes and typed paths](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router/routes-and-paths.md): Reference for route definitions, path patterns, typed path nodes, match filters, and router matching.
- [Navigation primitives](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router/navigation.md): Reference for Solid Router location, navigation, matching, search, preloading, link state, and leave guards.
- [Data APIs](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router/data.md): Reference for Solid Router query caching, live queries, revalidation, actions, action invocation, and settled submissions.
- [History adapters](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router/history.md): Reference for Solid Router browser, hash, and memory history adapters.
- [File-system adapter](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router/filesystem.md): Reference for converting a file-routes manifest and typing Solid Router route-module configuration.
- [Server integration](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router/server.md): Reference for the Solid Router server-function flight-data collector.
- [Types](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-router/types.md): Inventory of application-facing types exported by Solid Router 2.

### @solidjs/meta

- [@solidjs/meta](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta.md): Reference for @solidjs/meta: components that set the document title, meta tags, links, scripts, and styles from anywhere in the tree.
- [Base](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta/base.md): Base sets the document base URL through Solid Meta during server rendering.
- [Head](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta/head.md): Head groups its child head tags into one replacement set through Solid Meta.
- [Link](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta/link.md): Link adds a link element to the document head through Solid Meta.
- [Meta](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta/meta.md): Meta adds a meta element to the document head through Solid Meta.
- [Script](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta/script.md): Script adds a script element to the document head through Solid Meta.
- [Style](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta/style.md): Style adds an inline style element to the document head through Solid Meta.
- [Stylesheet](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta/stylesheet.md): Stylesheet adds a stylesheet link element to the document head through Solid Meta.
- [Title](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/solid-meta/title.md): Title sets the document title through Solid Meta.

### @solidjs/vite-plugin

- [@solidjs/vite-plugin](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/vite-plugin-solid.md): Public exports and generated modules provided by @solidjs/vite-plugin 3.0 for Solid 2.0.
- [solidPlugin](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/vite-plugin-solid/options.md): Configures Solid JSX compilation and the optional serving and server-function modes.
- [StartOptions](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/vite-plugin-solid/start.md): Configures @solidjs/vite-plugin client or SSR start mode.
- [serverFunctions](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/vite-plugin-solid/server-functions.md): Compiles use-server directives and emits server-function manifest and handler modules.
- [Modules and manifest](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/vite-plugin-solid/modules.md): Reference for @solidjs/vite-plugin manifest types, virtual modules, and boundary marker modules.

### filesystem-routing

- [filesystem-routing](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/filesystem-routing.md): Public exports for filesystem-routing scanning, conventions, Vite delivery, and API dispatch.
- [filesystem-routing core](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/filesystem-routing/core.md): Reference for the bundler-neutral scanner, manifest types, and module analysis exports.
- [Route conventions](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/filesystem-routing/conventions.md): Reference for nested and flat route filename conventions.
- [filesystem-routing/tree](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/filesystem-routing/tree.md): Builds nested route trees and removes route-group segments.
- [filesystem-routing/vite](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/filesystem-routing/vite.md): Configures Vite delivery of a file-system route manifest.
- [filesystem-routing/api](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/filesystem-routing/api.md): Matches manifest HTTP handlers and dispatches them as fetch-style middleware.
- [Manifest module](https://deploy-preview-1657--solid-docs-v2.netlify.app/reference/filesystem-routing/manifest.md): Reference for virtual:file-routes runtime output and TypeScript declarations.