SolidJS llms.txt

The actual file

Source Markdown

The saved llms.txt text, displayed as source. The file belongs to its publisher; the live endpoint may change.

Showing the first 18000 characters. Load the complete file to read the remainder.

# SolidJS Documentation

Documentation for SolidJS, the signals-powered UI framework

- [Install and configure](/solid-meta/getting-started/installation-and-setup.md): Install and configure @solidjs/meta for head tag management. Set up dynamic titles, meta tags, and SEO optimization in Solid apps.
- [Client setup](/solid-meta/getting-started/client-setup.md): Manage document head tags in Solid apps. Add titles, meta tags, and links dynamically for better SEO and social media sharing.
- [Server setup](/solid-meta/getting-started/server-setup.md): Configure server-side rendering for Solid Meta tags with MetaProvider. Learn to properly inject head tags in SSR for optimal SEO and performance.
- [Overview](/solid-meta.md): Solid Meta provides asynchronous SSR-ready document head management. Define meta tags at any component level for flexible SEO and metadata control.
- [Base](/solid-meta/reference/meta/base.md): Base renders a base element through Solid Meta.
- [Link](/solid-meta/reference/meta/link.md): Link renders a link element through Solid Meta.
- [Meta](/solid-meta/reference/meta/meta.md): Meta renders a meta element through Solid Meta.
- [MetaProvider](/solid-meta/reference/meta/metaprovider.md): MetaProvider provides the context used by Solid Meta head tags.
- [Style](/solid-meta/reference/meta/style.md): Style renders a style element through Solid Meta.
- [Title](/solid-meta/reference/meta/title.md): Title renders a title element through Solid Meta.
- [useHead](/solid-meta/reference/meta/use-head.md): useHead adds a custom head tag through Solid Meta.
- [Overview](/solid-meta/v1.md): Solid Meta 1.0 provides document head management for Solid 2.0 — declare head tags anywhere with streaming-correct SSR and flicker-free hydration.
- [Getting started](/solid-meta/v1/getting-started.md): Install Solid Meta 1.0 and manage document head tags from anywhere in your Solid 2.0 application.
- [Migrating from 0.x](/solid-meta/v1/migrating-from-v0.md): Migrate your application from @solidjs/meta 0.x to 1.0.
- [Base](/solid-meta/v1/reference/meta/base.md): Base sets the document base URL through Solid Meta during server rendering.
- [Head](/solid-meta/v1/reference/meta/head.md): Head groups its child head tags into one replacement set through Solid Meta.
- [Link](/solid-meta/v1/reference/meta/link.md): Link adds a link element to the document head through Solid Meta.
- [Meta](/solid-meta/v1/reference/meta/meta.md): Meta adds a meta element to the document head through Solid Meta.
- [Script](/solid-meta/v1/reference/meta/script.md): Script adds a script element to the document head through Solid Meta.
- [Style](/solid-meta/v1/reference/meta/style.md): Style adds an inline style element to the document head through Solid Meta.
- [Stylesheet](/solid-meta/v1/reference/meta/stylesheet.md): Stylesheet adds a stylesheet link element to the document head through Solid Meta.
- [Title](/solid-meta/v1/reference/meta/title.md): Title sets the document title through Solid Meta.
- [Installation and setup](/solid-router/getting-started/installation-and-setup.md): Learn how to install and configure Solid Router for client and server-side routing in your single-page applications with step-by-step setup guide.
- [Component routing](/solid-router/getting-started/component.md): Define routes using JSX components in SolidJS Router for intuitive, template-based routing in your applications.
- [Config-based routing](/solid-router/getting-started/config.md): Configure SolidJS routes with config objects for centralized routing, lazy loading, and optimized performance.
- [Linking routes](/solid-router/getting-started/linking-routes.md): Create navigation links between routes using anchor tags and the A component with active state styling and automatic base path handling.
- [Overview](/solid-router.md): Solid Router is the universal routing solution for Solid applications, enabling client and server-side navigation in single-page applications.
- [Navigation](/solid-router/concepts/navigation.md): Navigate between routes in SolidJS using links, programmatic navigation, and redirects for seamless user experiences.
- [Path parameters](/solid-router/concepts/path-parameters.md): Capture and validate dynamic URL parameters in SolidJS routes for flexible content display and data-driven pages.
- [Search parameters](/solid-router/concepts/search-parameters.md): Manage query strings and search parameters in SolidJS for filtering, pagination, and maintaining state in the URL.
- [Catch-all routes](/solid-router/concepts/catch-all.md): Create catch-all routes in SolidJS to handle 404 errors and redirect users from invalid URLs to proper fallback pages.
- [Dynamic routes](/solid-router/concepts/dynamic-routes.md): Build dynamic routes with parameters in SolidJS for user profiles, products, and content that changes based on URL values.
- [Nesting routes](/solid-router/concepts/nesting.md): Build nested route hierarchies in SolidJS for complex applications with parent-child relationships and shared layouts.
- [Layouts](/solid-router/concepts/layouts.md): Create consistent page layouts in SolidJS with shared headers, footers, and nested structures for better UI organization.
- [Alternative routers](/solid-router/concepts/alternative-routers.md): Learn to use hash-based and memory routers in SolidJS for client-side navigation and testing without server interaction.
- [Actions](/solid-router/concepts/actions.md): Handle form submissions and server mutations with Solid Router actions. Build isomorphic data flows with progressive enhancement support.
- [Single page applications](/solid-router/rendering-modes/spa.md): Configure single-page applications for proper CDN and hosting deployment. Handle client-side routing without server-side rendering.
- [Server side rendering](/solid-router/rendering-modes/ssr.md): Enable server-side rendering with Solid Router for SEO and performance. Support suspense, resources, and render-as-you-fetch patterns.
- [Queries](/solid-router/data-fetching/queries.md)
- [Streaming](/solid-router/data-fetching/streaming.md)
- [Revalidation](/solid-router/data-fetching/revalidation.md)
- [Preload data](/solid-router/data-fetching/how-to/preload-data.md)
- [Handle pending and error states](/solid-router/data-fetching/how-to/handle-error-and-loading-states.md)
- [Preloading](/solid-router/advanced-concepts/preloading.md)
- [Lazy loading](/solid-router/advanced-concepts/lazy-loading.md): Implement lazy loading in Solid Router to reduce initial bundle size. Load components on-demand for better performance in large applications.
- [Migration from v0.9.x](/solid-router/guides/migration.md): Migrate your Solid Router application to v0.10 with this comprehensive guide covering removed APIs, new patterns, and Islands support changes.
- [A](/solid-router/reference/components/a.md): A wraps a native anchor element for Solid Router navigation.
- [HashRouter](/solid-router/reference/components/hash-router.md): HashRouter stores route paths in the URL hash.
- [MemoryRouter](/solid-router/reference/components/memory-router.md): MemoryRouter stores route paths in a memory history object.
- [Navigate](/solid-router/reference/components/navigate.md): Navigate performs router navigation when it renders.
- [Route](/solid-router/reference/components/route.md): Route defines a matchable route segment.
- [Router](/solid-router/reference/components/router.md): Router provides browser-based routing context for Solid Router.
- [action](/solid-router/reference/data-apis/action.md): action wraps an async function as a router action.
- [cache](/solid-router/reference/data-apis/cache.md): cache is a deprecated alias for query.
- [createAsyncStore](/solid-router/reference/data-apis/create-async-store.md): createAsyncStore creates an accessor for promise-backed store data.
- [createAsync](/solid-router/reference/data-apis/create-async.md): createAsync creates an accessor for promise-backed data.
- [query](/solid-router/reference/data-apis/query.md): query wraps a function with router cache metadata.
- [revalidate](/solid-router/reference/data-apis/revalidate.md): revalidate retriggers router query cache entries.
- [useAction](/solid-router/reference/data-apis/use-action.md): useAction returns a router-bound action caller.
- [useSubmission](/solid-router/reference/data-apis/use-submission.md): useSubmission returns the latest tracked submission for an action.
- [useSubmissions](/solid-router/reference/data-apis/use-submissions.md): useSubmissions returns tracked submissions for an action.
- [preload](/solid-router/reference/preload-functions/preload.md): preload is a route definition property for route data setup.
- [useBeforeLeave](/solid-router/reference/primitives/use-before-leave.md): useBeforeLeave registers a handler that runs before navigation leaves the current location.
- [useCurrentMatches](/solid-router/reference/primitives/use-current-matches.md): useCurrentMatches returns the current route matches accessor.
- [useIsRouting](/solid-router/reference/primitives/use-is-routing.md): useIsRouting detects when a route transition is in progress.
- [useLocation](/solid-router/reference/primitives/use-location.md): useLocation returns the current location.
- [useMatch](/solid-router/reference/primitives/use-match.md): useMatch returns a memoized match for a path pattern.
- [useNavigate](/solid-router/reference/primitives/use-navigate.md): useNavigate returns the navigation function.
- [useParams](/solid-router/reference/primitives/use-params.md): useParams returns the current route parameters.
- [usePreloadRoute](/solid-router/reference/primitives/use-preload-route.md): usePreloadRoute returns a function for preloading a route.
- [useResolvedPath](/solid-router/reference/primitives/use-resolved-path.md): useResolvedPath returns an accessor for a path resolved against the current route.
- [useSearchParams](/solid-router/reference/primitives/use-search-params.md): useSearchParams returns current query parameters and a query update function.
- [json](/solid-router/reference/response-helpers/json.md): json returns a custom JSON response.
- [redirect](/solid-router/reference/response-helpers/redirect.md): redirect returns a custom redirect response.
- [reload](/solid-router/reference/response-helpers/reload.md): Reload and revalidate specific queries after mutations. Efficiently update cached data without full page refreshes for better UX.
- [Routing](/solid-start/v1/building-your-application/routing.md): Build your SolidStart app with file-based routing. Create pages, nested layouts, and dynamic routes with simple file structure.
- [API routes](/solid-start/v1/building-your-application/api-routes.md): Create API routes in SolidStart for REST, GraphQL, or tRPC endpoints. Handle HTTP methods, sessions, and external integrations.
- [CSS and styling](/solid-start/v1/building-your-application/css-and-styling.md): Style your SolidStart components with CSS, CSS modules, and other styling solutions. Implement scoped styles and design systems.
- [Data fetching](/solid-start/v1/building-your-application/data-fetching.md)
- [Data mutation](/solid-start/v1/building-your-application/data-mutation.md)
- [Head and metadata](/solid-start/v1/building-your-application/head-and-metadata.md): Manage SEO and metadata in SolidStart with dynamic titles, meta tags, and Open Graph tags for better search visibility.
- [Route Pre-rendering](/solid-start/v1/building-your-application/route-prerendering.md): Pre-render SolidStart routes to static HTML for faster loads and better SEO. Perfect for blogs, docs, and marketing sites.
- [Static assets](/solid-start/v1/building-your-application/static-assets.md): Manage static assets in SolidStart using the public directory or imports. Serve images, fonts, documents, and media files.
- [Overview](/solid-start/v1.md): SolidStart meta-framework overview: Build modern web apps with fine-grained reactivity, isomorphic routing, and flexible rendering.
- [Middleware](/solid-start/v1/advanced/middleware.md): Intercept HTTP requests with middleware for authentication, logging, and header management. Share request-scoped data across your app.
- [Sessions](/solid-start/v1/advanced/session.md): Manage user sessions with encrypted cookies in SolidStart. Maintain authentication state and user preferences between requests.
- [Request events](/solid-start/v1/advanced/request-events.md): Access request events and local context in SolidStart server functions. Type-safe locals and native event handling for server code.
- [Returning responses](/solid-start/v1/advanced/return-responses.md): Return typed Response objects from server functions. Handle redirects, reloads, and JSON responses with proper TypeScript support.
- [Serialization](/solid-start/v1/advanced/serialization.md): Understand how SolidStart serializes server function payloads, supported types, and CSP tradeoffs.
- [Auth](/solid-start/v1/advanced/auth.md): Implement authentication and protected routes in SolidStart. Secure sensitive resources and handle user authorization properly.
- [WebSocket endpoint](/solid-start/v1/advanced/websocket.md): Set up WebSocket endpoints in SolidStart for real-time bidirectional communication. Handle connections, messages, and events.
- [Getting started](/solid-start/v1/getting-started.md): Start your first SolidStart project with templates and step-by-step setup. Create, configure, and run your Solid application.
- [Security](/solid-start/v1/guides/security.md): Secure your SolidStart apps against XSS, CSRF attacks. Configure CSP headers, CORS policies, and implement security best practices.
- [Data fetching](/solid-start/v1/guides/data-fetching.md): Master data fetching in SolidStart with practical examples. Handle loading states, errors, preloading, and database queries.
- [Data mutation](/solid-start/v1/guides/data-mutation.md): Learn how to handle form submissions, validate data, and perform mutations with SolidStart actions. Complete guide with examples.
- [Service workers](/solid-start/v1/guides/service-workers.md): Register and configure service workers in SolidStart for offline support, caching strategies, and progressive web app features.
- [Background tasks](/solid-start/v1/guides/background-tasks.md): Schedule background tasks in SolidStart using Nitro's Tasks API for periodic jobs and automated server-side operations.
- [clientOnly](/solid-start/v1/reference/client/client-only.md): clientOnly creates a component that renders only on the client.
- [mount](/solid-start/v1/reference/client/mount.md): mount hydrates the client entry.
- [StartClient](/solid-start/v1/reference/client/start-client.md): StartClient renders the app on the client.
- [defineConfig](/solid-start/v1/reference/config/define-config.md): Configure SolidStart apps with defineConfig. Set up Vite plugins, Nitro presets, and deployment targets for any platform.
- [app.config.ts](/solid-start/v1/reference/entrypoints/app-config.md): app.config.ts exports the app configuration.
- [app.tsx](/solid-start/v1/reference/entrypoints/app.md): app.tsx is the app root module.
- [entry-client.tsx](/solid-start/v1/reference/entrypoints/entry-client.md): entry-client.tsx mounts StartClient in the browser.
- [entry-server.tsx](/solid-start/v1/reference/entrypoints/entry-server.md): entry-server.tsx exports the server handler.
- [FileRoutes](/solid-start/v1/reference/routing/file-routes.md): FileRoutes returns route definitions generated from filesystem routes.
- [createHandler](/solid-start/v1/reference/server/create-handler.md): createHandler creates the server handler.
- [createMiddleware](/solid-start/v1/reference/server/create-middleware.md): createMiddleware creates middleware definitions.
- [getServerFunctionMeta](/solid-start/v1/reference/server/get-server-function-meta.md): getServerFunctionMeta returns metadata for the current server function request.
- [GET](/solid-start/v1/reference/server/get.md): GET returns the GET handler attached to a server function.
- [HttpHeader](/solid-start/v1/reference/server/http-header.md): HttpHeader sets or appends a response header during server rendering.
- [HttpStatusCode](/solid-start/v1/reference/server/http-status-code.md): HttpStatusCode sets the response status during server rendering.
- [StartServer](/solid-start/v1/reference/server/start-server.md): StartServer renders the app inside a document component.
- ["use server"](/solid-start/v1/reference/server/use-server.md): "use server" marks server functions for the server function compiler.
- [Routing](/solid-start/v2/building-your-application/routing.md): SolidStart v2 routing uses the filesystem router to map files in src/routes to UI routes and API routes.
- [API routes](/solid-start/v2/building-your-application/api-routes.md): SolidStart v2 API routes are filesystem routes that export HTTP method handlers and receive typed APIEvent objects from @solidjs/start/server.
- [CSS and styling](/solid-start/v2/building-your-application/css-and-styling.md): Style your SolidStart components with CSS, CSS modules, and other styling solutions. Implement scoped styles and design systems.
- [Data fetching](/solid-start/v2/building-your-application/data-fetching.md): Fetch data in SolidStart v2 with Solid Router queries, createAsync, and server-backed functions compiled from the use server directive.
- [Data mutation](/solid-start/v2/building-your-application/data-mutation.md): Mutate data in SolidStart v2 with Solid Router actions and server-only action bodies compiled from the use server directive.
- [Head and metadata](/solid-start/v2/building-your-application/head-and-metadata.md): Manage SEO and metadata in SolidStart with dynamic titles, meta tags, and Open Graph tags.
- [Route pre-rendering](/solid-start/v2/building-your-application/route-prerendering.md): Pre-render SolidStart routes to static HTML with Nitro v3.
- [Static assets](/solid-start/v2/building-your-applica