diff --git a/src/routes/advanced-concepts/fine-grained-reactivity.mdx b/src/routes/advanced-concepts/fine-grained-reactivity.mdx index b89c687b0..873d2255b 100644 --- a/src/routes/advanced-concepts/fine-grained-reactivity.mdx +++ b/src/routes/advanced-concepts/fine-grained-reactivity.mdx @@ -1,16 +1,19 @@ --- title: Fine-grained reactivity use_cases: >- - understanding core reactivity, performance optimization, building reactive - systems from scratch, learning framework internals + optimizing performance, reducing re-renders, understanding solid fundamentals, + building efficient apps, custom reactive systems tags: - reactivity + - performance - signals - effects - - performance + - optimization - fundamentals - - reactive-primitives version: '1.0' +description: >- + Master Solid's fine-grained reactivity system for targeted UI updates, optimal + performance, and efficient state management patterns. --- Reactivity ensures automatic responses to data changes, eliminating the need for manual updates to the user interface (UI). diff --git a/src/routes/concepts/components/basics.mdx b/src/routes/concepts/components/basics.mdx index bf34b49f0..2466012ce 100644 --- a/src/routes/concepts/components/basics.mdx +++ b/src/routes/concepts/components/basics.mdx @@ -2,16 +2,19 @@ title: Basics order: 4 use_cases: >- - always, first component creation, learning component structure, understanding - lifecycle, component organization + starting new projects, creating components, understanding component structure, + building ui blocks, component organization tags: - components + - basics - jsx - lifecycle - - fundamentals - - always - - component-tree + - imports + - structure version: '1.0' +description: >- + Learn Solid component fundamentals: creating reusable UI blocks, component + trees, lifecycles, and proper import/export patterns. --- Components are the building blocks of Solid applications. diff --git a/src/routes/concepts/components/class-style.mdx b/src/routes/concepts/components/class-style.mdx index 58b411f64..487bd9ec4 100644 --- a/src/routes/concepts/components/class-style.mdx +++ b/src/routes/concepts/components/class-style.mdx @@ -2,16 +2,19 @@ title: Class and style order: 2 use_cases: >- - styling components, dynamic styling, theming, conditional css classes, inline - styles + styling components, dynamic theming, conditional styling, css integration, + responsive design, ui customization tags: - styling - css - classes - - dynamic-styling - - theming - - conditional-rendering + - themes + - dynamic + - ui version: '1.0' +description: >- + Style Solid components with CSS classes and inline styles. Learn dynamic + styling, classList usage, and theme implementation. --- Similar to HTML, Solid uses `class` and `style` attributes to style elements via [CSS (Cascading Style Sheets)](https://developer.mozilla.org/en-US/docs/Glossary/CSS). diff --git a/src/routes/concepts/components/event-handlers.mdx b/src/routes/concepts/components/event-handlers.mdx index 6b44bdbe9..14d881cf3 100644 --- a/src/routes/concepts/components/event-handlers.mdx +++ b/src/routes/concepts/components/event-handlers.mdx @@ -2,16 +2,19 @@ title: Event handlers order: 3 use_cases: >- - user interactions, click handlers, form events, custom events, event - delegation optimization + user interactions, click handling, form inputs, keyboard events, custom + events, touch gestures, event optimization tags: - events - - user-interaction - - forms - - event-delegation - - performance + - interactions - handlers + - delegation + - performance + - dom version: '1.0' +description: >- + Handle user interactions in Solid with event delegation and native events for + optimal performance and resource management. --- Event handlers are functions that are called in response to specific events occurring in the browser, such as when a user clicks or taps on an element. diff --git a/src/routes/concepts/components/props.mdx b/src/routes/concepts/components/props.mdx index 502a04c22..981f987c8 100644 --- a/src/routes/concepts/components/props.mdx +++ b/src/routes/concepts/components/props.mdx @@ -1,16 +1,19 @@ --- title: Props use_cases: >- - passing data between components, component communication, reusable components, - parent-child data flow + passing data between components, parent-child communication, component + configuration, default values, prop management tags: - props - - component-communication - - data-flow - - reusability - - merge-props - - split-props + - components + - data + - communication + - mergeprops + - splitprops version: '1.0' +description: >- + Pass and manage component props in Solid while maintaining reactivity. Learn + mergeProps, splitProps, and best practices. --- Props are a way to pass state from a parent component to a child component. diff --git a/src/routes/concepts/context.mdx b/src/routes/concepts/context.mdx index f2af69a80..2e5121985 100644 --- a/src/routes/concepts/context.mdx +++ b/src/routes/concepts/context.mdx @@ -2,16 +2,19 @@ title: Context order: 5 use_cases: >- - avoiding prop drilling, global state, theme management, authentication state, - deeply nested components + global state management, avoiding prop drilling, theme providers, + authentication state, shared data across components tags: - context - - global-state - - prop-drilling - - state-management - - provider-pattern - - theming + - state + - global + - providers + - sharing + - management version: '1.0' +description: >- + Share data across component trees with Solid's Context API. Avoid prop + drilling and manage global application state effectively. --- Context provides a way to pass data through the component tree without having to pass props down manually at every level. diff --git a/src/routes/concepts/control-flow/conditional-rendering.mdx b/src/routes/concepts/control-flow/conditional-rendering.mdx index d3e02c479..a3e1e906b 100644 --- a/src/routes/concepts/control-flow/conditional-rendering.mdx +++ b/src/routes/concepts/control-flow/conditional-rendering.mdx @@ -2,16 +2,19 @@ title: Conditional rendering order: 1 use_cases: >- - showing hiding content, loading states, error states, user permissions, - dynamic ui + showing/hiding content, loading states, error displays, user permissions, + dynamic ui, feature toggles tags: - - conditional-rendering - - loading-states - - error-handling - - dynamic-ui + - conditional + - rendering - show - - switch-match + - switch + - match + - ui version: '1.0' +description: >- + Conditionally render UI elements in Solid using Show, Switch, and Match + components for clean, readable conditional logic. --- Conditional rendering is the process of displaying different UI elements based on certain conditions. diff --git a/src/routes/concepts/control-flow/dynamic.mdx b/src/routes/concepts/control-flow/dynamic.mdx index f1e336102..fb3a68530 100644 --- a/src/routes/concepts/control-flow/dynamic.mdx +++ b/src/routes/concepts/control-flow/dynamic.mdx @@ -2,15 +2,19 @@ title: Dynamic order: 2 use_cases: >- - dynamic component rendering, component switching, plugin systems, cms content, - configurable ui + dynamic component selection, polymorphic components, runtime component + switching, flexible ui rendering, component factories tags: - - dynamic-components - - component-switching - - configurable-ui - - cms - - plugin-systems + - dynamic + - components + - rendering + - polymorphic + - runtime + - flexible version: '1.0' +description: >- + Render components dynamically at runtime with Solid's Dynamic component. Build + flexible UIs with runtime component selection. --- `` is a Solid component that allows you to render components dynamically based on data. diff --git a/src/routes/concepts/control-flow/error-boundary.mdx b/src/routes/concepts/control-flow/error-boundary.mdx index 6677fc342..6951d57e2 100644 --- a/src/routes/concepts/control-flow/error-boundary.mdx +++ b/src/routes/concepts/control-flow/error-boundary.mdx @@ -2,15 +2,19 @@ title: Error boundary order: 5 use_cases: >- - error handling, preventing app crashes, user experience, graceful degradation, - error recovery + error handling, crash prevention, user-friendly errors, app stability, error + recovery, debugging production issues tags: - - error-handling - - error-boundary - - crash-prevention - - user-experience - - error-recovery + - errors + - boundary + - handling + - recovery + - stability + - debugging version: '1.0' +description: >- + Catch and handle rendering errors gracefully with ErrorBoundary. Prevent app + crashes and provide user-friendly error recovery. --- By default, if part of an application throws an error during rendering, the entire application can crash, resulting in Solid removing its UI from the screen. diff --git a/src/routes/concepts/control-flow/list-rendering.mdx b/src/routes/concepts/control-flow/list-rendering.mdx index e6039bf87..e6324b01a 100644 --- a/src/routes/concepts/control-flow/list-rendering.mdx +++ b/src/routes/concepts/control-flow/list-rendering.mdx @@ -2,17 +2,20 @@ title: List rendering order: 3 use_cases: >- - displaying arrays, dynamic lists, table data, todo lists, data visualization, - performance optimization + rendering arrays, dynamic lists, data iteration, tables, repeating elements, + collection display, performance optimization tags: - lists - arrays + - for + - index - iteration + - rendering - performance - - for-component - - index-component - - dynamic-data version: '1.0' +description: >- + Efficiently render dynamic lists in Solid using For and Index components. + Optimize performance for different data scenarios. --- List rendering allows you to generate multiple elements from a collection of data, such as an array or object, where each element corresponds to an item in the collection. diff --git a/src/routes/concepts/control-flow/portal.mdx b/src/routes/concepts/control-flow/portal.mdx index ca591d8b2..5058db311 100644 --- a/src/routes/concepts/control-flow/portal.mdx +++ b/src/routes/concepts/control-flow/portal.mdx @@ -2,18 +2,19 @@ title: Portal order: 3 use_cases: >- - modals, tooltips, dropdowns, popups, overlays, z-index issues, clipped - content, accessibility improvements + modals, popups, tooltips, dropdowns, z-index issues, overflow clipping, + rendering outside parent container tags: - - modals - - tooltips - - dropdowns - - popups - - overlays - - accessibility + - portal + - modal + - popup - dom - - positioning + - z-index + - overflow version: '1.0' +description: >- + Learn how Portal renders elements outside the normal DOM flow to solve z-index + and overflow issues for modals and popups. --- When an element requires rendering outside of the usual document flow, challenges related to stacking contents and z-index can interfere with the desired intention or look of an application. diff --git a/src/routes/concepts/derived-values/derived-signals.mdx b/src/routes/concepts/derived-values/derived-signals.mdx index 47398e60d..03716adbd 100644 --- a/src/routes/concepts/derived-values/derived-signals.mdx +++ b/src/routes/concepts/derived-values/derived-signals.mdx @@ -2,16 +2,18 @@ title: Derived signals order: 1 use_cases: >- - computed values, reactive calculations, dependent state, always, any solid - project, data transformations + computed values, reactive calculations, dependent state, dynamic values from + signals tags: + - signals - reactivity - - computed - derived - - calculations - - dependencies - - always + - computed + - state version: '1.0' +description: >- + Create reactive derived values that automatically update when their + dependencies change using Solid's derived signals. --- Derived signals are functions that rely on one or more [signals](/concepts/signals) to produce a value. diff --git a/src/routes/concepts/derived-values/memos.mdx b/src/routes/concepts/derived-values/memos.mdx index 39244bae3..78213deb6 100644 --- a/src/routes/concepts/derived-values/memos.mdx +++ b/src/routes/concepts/derived-values/memos.mdx @@ -2,16 +2,19 @@ title: Memos order: 2 use_cases: >- - expensive computations, caching, performance optimization, derived state, - preventing unnecessary recalculations + expensive computations, caching results, optimizing performance, derived + state, avoiding re-calculations tags: + - memo - performance - - optimization - caching - - expensive-computations - - derived + - optimization - reactivity + - computed version: '1.0' +description: >- + Optimize expensive computations with memos that cache results and only + recalculate when dependencies actually change. --- Memos are a type of reactive value that can be used to memoize derived state or expensive computations. diff --git a/src/routes/concepts/effects.mdx b/src/routes/concepts/effects.mdx index 31278c217..fbe55d14e 100644 --- a/src/routes/concepts/effects.mdx +++ b/src/routes/concepts/effects.mdx @@ -2,16 +2,18 @@ title: Effects order: 4 use_cases: >- - side effects, dom manipulation, data fetching, subscriptions, cleanup, - lifecycle management, logging + side effects, dom manipulation, api calls, subscriptions, logging, reacting to + state changes tags: + - effects - side-effects + - reactivity - lifecycle - - data-fetching - - dom-manipulation - - cleanup - subscriptions version: '1.0' +description: >- + Manage side effects like DOM updates, API calls, and subscriptions that + respond automatically to reactive state changes. --- Effects are functions that are triggered when the signals they depend on change. diff --git a/src/routes/concepts/intro-to-reactivity.mdx b/src/routes/concepts/intro-to-reactivity.mdx index bd69bd547..49685357f 100644 --- a/src/routes/concepts/intro-to-reactivity.mdx +++ b/src/routes/concepts/intro-to-reactivity.mdx @@ -2,16 +2,19 @@ title: Intro to reactivity order: 1 use_cases: >- - always, learning solid, understanding reactivity, new developers, core - concepts + learning reactivity, understanding signals, reactive principles, state + management basics, getting started tags: - - always - - learning - - fundamentals - reactivity - - beginner - - core-concepts + - signals + - fundamentals + - state + - subscribers + - basics version: '1.0' +description: >- + Master Solid's reactive system fundamentals: signals, subscribers, and + automatic UI updates for responsive applications. --- **Note**: While this guide is useful for understanding reactive systems, it does use some Solid-specific terminology. diff --git a/src/routes/concepts/refs.mdx b/src/routes/concepts/refs.mdx index 876fd91ec..b6d0cc019 100644 --- a/src/routes/concepts/refs.mdx +++ b/src/routes/concepts/refs.mdx @@ -1,15 +1,19 @@ --- title: Refs use_cases: >- - dom access, element manipulation, focus management, animations, third party - libraries, imperative operations + dom access, element references, focus management, third-party libraries, + canvas manipulation, forwarding refs tags: - - dom-access - - animations - - focus-management - - third-party-integration - - imperative + - refs + - dom + - elements + - directives + - access + - forward version: '1.0' +description: >- + Access and manipulate DOM elements directly using refs, forward refs between + components, and create custom directives. --- Refs, or references, are a special attribute that can be attached to any element, and are used to reference a DOM element or a component instance. diff --git a/src/routes/concepts/signals.mdx b/src/routes/concepts/signals.mdx index 419ab3ea4..ec43c0b37 100644 --- a/src/routes/concepts/signals.mdx +++ b/src/routes/concepts/signals.mdx @@ -1,14 +1,20 @@ --- title: Signals order: 2 -use_cases: 'always, any solid project, state management, reactive data, core functionality' +use_cases: >- + state management, reactive values, component state, updating ui, tracking + changes, basic reactivity tags: - - always - - state-management + - signals + - state - reactivity + - getter + - setter - fundamentals - - core version: '1.0' +description: >- + Create reactive state with signals - the foundation of Solid's reactivity + system for automatic UI updates and tracking. --- Signals are the primary means of [managing state](/concepts/intro-to-reactivity#state-management) in your Solid application. diff --git a/src/routes/concepts/stores.mdx b/src/routes/concepts/stores.mdx index 5909282d6..33d7b727a 100644 --- a/src/routes/concepts/stores.mdx +++ b/src/routes/concepts/stores.mdx @@ -2,16 +2,20 @@ title: Stores order: 6 use_cases: >- - complex state, nested data, objects, arrays, shared state, performance - optimization, large applications + complex state, nested objects, arrays, shared state, fine-grained updates, + state trees, global state tags: - - complex-state - - nested-data + - stores + - state - objects - arrays - - performance - - large-applications + - nested + - produce + - reconcile version: '1.0' +description: >- + Manage complex nested state efficiently with stores that provide fine-grained + reactivity for objects and arrays in Solid. --- Stores are a state management primitive that provide a centralized way to handle shared data and reduce redundancy. diff --git a/src/routes/concepts/understanding-jsx.mdx b/src/routes/concepts/understanding-jsx.mdx index 2b45b90b4..f6d16dfd2 100644 --- a/src/routes/concepts/understanding-jsx.mdx +++ b/src/routes/concepts/understanding-jsx.mdx @@ -2,17 +2,19 @@ title: Understanding JSX order: 2 use_cases: >- - always, learning solid, templating, ui rendering, new developers, component - creation + writing components, html in javascript, dynamic content, templating, props + passing, event handling tags: - - always - jsx - - templating - - ui - components - - fundamentals - - beginner + - templates + - props + - html + - syntax version: '1.0' +description: >- + Write HTML-like syntax in JavaScript with JSX to create reactive components + with dynamic expressions and event handlers. --- JSX is an extension for JavaScript. diff --git a/src/routes/configuration/environment-variables.mdx b/src/routes/configuration/environment-variables.mdx index 903d2d871..bb6c65021 100644 --- a/src/routes/configuration/environment-variables.mdx +++ b/src/routes/configuration/environment-variables.mdx @@ -1,16 +1,19 @@ --- title: Environment variables use_cases: >- - configuration, api keys, deployment, environment-specific settings, build - configuration + api keys, configuration, secrets management, build-time config, + environment-specific settings tags: - - configuration - - deployment - - api-keys - - build - environment - - settings + - variables + - config + - vite + - secrets + - deployment version: '1.0' +description: >- + Configure public and private environment variables in Solid apps using Vite's + built-in support for secure configuration. --- Solid is built on top of [Vite](https://vitejs.dev/), which offers a convenient way to handle environment variables. diff --git a/src/routes/configuration/typescript.mdx b/src/routes/configuration/typescript.mdx index 950ac3561..d35d2515a 100644 --- a/src/routes/configuration/typescript.mdx +++ b/src/routes/configuration/typescript.mdx @@ -1,19 +1,20 @@ --- title: TypeScript use_cases: >- - type safety, large projects, team development, code documentation, catching - errors at compile time + type safety, code reliability, large projects, team collaboration, api + documentation, migrating from javascript tags: - typescript - types + - migration - configuration - jsx - - components - - events - - signals - - context - - refs + - development + - tooling version: '1.0' +description: >- + Learn to configure TypeScript with SolidJS for enhanced type safety, better + IDE support, and reliable component development. --- [TypeScript](https://www.typescriptlang.org/) is a superset of JavaScript that enhances code reliability and predictability through the introduction of [static types](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html). diff --git a/src/routes/guides/complex-state-management.mdx b/src/routes/guides/complex-state-management.mdx index bab1c5793..05f2af8f6 100644 --- a/src/routes/guides/complex-state-management.mdx +++ b/src/routes/guides/complex-state-management.mdx @@ -2,17 +2,19 @@ title: Complex state management order: 5 use_cases: >- - large applications, multiple components, complex user interactions, avoiding - prop drilling, shared state + scaling applications, multiple components, backend communication, state + synchronization, prop drilling, shared state tags: - stores - - state management - - complex apps + - state - context - - produce - - shared state - - scalability + - scaling + - components + - management version: '1.0' +description: >- + Master complex state management in Solid using stores and context to build + scalable, maintainable applications efficiently. --- As applications grow and start to involve many components, more intricate user interactions, and possibly communication with backend services, you may find that staying organized with more [basic state management methods](/guides/state-management) can become difficult to maintain. diff --git a/src/routes/guides/deploying-your-app.mdx b/src/routes/guides/deploying-your-app.mdx index 8af78ea17..1bd269567 100644 --- a/src/routes/guides/deploying-your-app.mdx +++ b/src/routes/guides/deploying-your-app.mdx @@ -1,16 +1,17 @@ --- title: Deploy your app order: 9 -use_cases: >- - production deployment, going live, hosting selection, deployment platform - comparison +use_cases: 'production deployment, hosting, going live, app publishing, cloud deployment' tags: - deployment - hosting - production - - platforms - - links + - cloud + - publishing version: '1.0' +description: >- + Deploy your Solid application to popular hosting platforms including + Cloudflare, Vercel, Netlify, AWS, and more with guides. --- Are you ready to deploy your Solid application? Follow our guides for different deployment services. diff --git a/src/routes/guides/deployment-options/aws-via-flightcontrol.mdx b/src/routes/guides/deployment-options/aws-via-flightcontrol.mdx index 3318ac422..4d312f967 100644 --- a/src/routes/guides/deployment-options/aws-via-flightcontrol.mdx +++ b/src/routes/guides/deployment-options/aws-via-flightcontrol.mdx @@ -3,17 +3,19 @@ title: AWS via Flightcontrol order: 1 mainNavExclude: true use_cases: >- - aws deployment, automated deployments, github integration, enterprise hosting, - cloud infrastructure + aws deployment, automated deployments, continuous integration, github + integration, cloud hosting tags: - - deployment - aws + - deployment - flightcontrol - - github - automation - - cloud - - configuration + - github + - hosting version: '1.0' +description: >- + Deploy Solid apps to AWS with Flightcontrol's automated platform featuring + GitHub integration and continuous deployment. --- [Flightcontrol](https://www.flightcontrol.dev/) is a platform that fully automates deployments to Amazon Web Services (AWS). diff --git a/src/routes/guides/deployment-options/aws-via-sst.mdx b/src/routes/guides/deployment-options/aws-via-sst.mdx index d9722c09a..a06d3a432 100644 --- a/src/routes/guides/deployment-options/aws-via-sst.mdx +++ b/src/routes/guides/deployment-options/aws-via-sst.mdx @@ -3,17 +3,19 @@ title: AWS via SST order: 1 mainNavExclude: true use_cases: >- - aws lambda deployment, serverless hosting, cloud infrastructure, container - deployment + serverless deployment, aws lambda, container deployment, cloud infrastructure, + production deployment tags: - - deployment - aws - - lambda + - sst - serverless + - lambda + - deployment - containers - - sst - - cloud version: '1.0' +description: >- + Deploy SolidStart apps to AWS Lambda or containers using SST framework with + streamlined configuration and deployment. --- [SST](https://sst.dev/) is a framework for deploying applications to any cloud provider. It has a built-in way to deploy SolidStart apps to AWS Lambda. For additional details, you can [visit their docs](https://sst.dev/docs/). diff --git a/src/routes/guides/deployment-options/cloudflare.mdx b/src/routes/guides/deployment-options/cloudflare.mdx index e744df06c..8128f5b3f 100644 --- a/src/routes/guides/deployment-options/cloudflare.mdx +++ b/src/routes/guides/deployment-options/cloudflare.mdx @@ -3,17 +3,19 @@ title: Cloudflare order: 2 mainNavExclude: true use_cases: >- - jamstack deployment, cloudflare pages hosting, cdn deployment, edge computing, - web interface deployment + static site hosting, jamstack deployment, edge deployment, cdn hosting, web + publishing tags: - - deployment - cloudflare - pages - - jamstack - - cli + - deployment - wrangler - - cdn + - hosting + - jamstack version: '1.0' +description: >- + Deploy Solid apps to Cloudflare Pages for fast, global edge hosting with + built-in CDN and simple Git integration setup. --- [Cloudflare Pages](https://pages.cloudflare.com/) is a JAMstack platform for frontend developers, where JAMstack stands for JavaScript, APIs, and Markup. diff --git a/src/routes/guides/deployment-options/firebase.mdx b/src/routes/guides/deployment-options/firebase.mdx index 2a4b3a5d5..30626e666 100644 --- a/src/routes/guides/deployment-options/firebase.mdx +++ b/src/routes/guides/deployment-options/firebase.mdx @@ -3,16 +3,19 @@ title: Firebase order: 3 mainNavExclude: true use_cases: >- - google cloud deployment, firebase hosting, backend services integration, rapid - prototyping + google cloud hosting, static hosting, firebase integration, web app + deployment, production hosting tags: - - deployment - firebase - google + - deployment - hosting - cli - - backend + - static version: '1.0' +description: >- + Host your Solid application on Firebase with Google's infrastructure for + reliable static site hosting and easy deployment. --- [Firebase](https://firebase.google.com/) is an all-in-one app development platform by Google, offering a range of services from real-time databases to user authentication. diff --git a/src/routes/guides/deployment-options/netlify.mdx b/src/routes/guides/deployment-options/netlify.mdx index 6455e1fdc..86cd1719b 100644 --- a/src/routes/guides/deployment-options/netlify.mdx +++ b/src/routes/guides/deployment-options/netlify.mdx @@ -3,16 +3,19 @@ title: Netlify order: 4 mainNavExclude: true use_cases: >- - jamstack deployment, netlify hosting, continuous deployment, git integration, - static site hosting + static site hosting, continuous deployment, git integration, web publishing, + jamstack hosting tags: - - deployment - netlify - - jamstack + - deployment + - hosting - git - cli - - continuous deployment + - static version: '1.0' +description: >- + Deploy Solid apps to Netlify with automatic builds from Git, instant + rollbacks, and powerful deployment features included. --- [Netlify](https://www.netlify.com/) is a widely-used hosting platform suitable for various types of projects. diff --git a/src/routes/guides/deployment-options/railway.mdx b/src/routes/guides/deployment-options/railway.mdx index a0b71db51..0d263cb7a 100644 --- a/src/routes/guides/deployment-options/railway.mdx +++ b/src/routes/guides/deployment-options/railway.mdx @@ -3,16 +3,19 @@ title: Railway order: 5 mainNavExclude: true use_cases: >- - railway deployment, cloud hosting, github integration, domain management, - container deployment + web app deployment, cloud hosting, github deployment, production hosting, + quick deployment tags: - - deployment - railway + - deployment + - hosting - cloud - github - cli - - domains version: '1.0' +description: >- + Deploy Solid projects to Railway platform with GitHub integration, custom + domains, and straightforward deployment process. --- [Railway](https://railway.app/) is a well-known platform for deploying a variety of web and cloud-based projects. diff --git a/src/routes/guides/deployment-options/stormkit.mdx b/src/routes/guides/deployment-options/stormkit.mdx index 264cc1ce3..204a655f5 100644 --- a/src/routes/guides/deployment-options/stormkit.mdx +++ b/src/routes/guides/deployment-options/stormkit.mdx @@ -3,16 +3,19 @@ title: Stormkit order: 7 mainNavExclude: true use_cases: >- - static site deployment, spa hosting, serverless functions, git provider - integration + spa deployment, serverless functions, static hosting, git deployment, + production hosting tags: - - deployment - stormkit - - static - - spa + - deployment + - hosting - serverless - - git + - spa + - static version: '1.0' +description: >- + Deploy Solid apps as static sites or SPAs on Stormkit with serverless + functions support and Git provider integration. --- [Stormkit](https://www.stormkit.io) is a deployment platform for static websites, single-page applications (SPAs), and serverless functions. diff --git a/src/routes/guides/deployment-options/vercel.mdx b/src/routes/guides/deployment-options/vercel.mdx index 9025727fa..56a3b3210 100644 --- a/src/routes/guides/deployment-options/vercel.mdx +++ b/src/routes/guides/deployment-options/vercel.mdx @@ -3,17 +3,19 @@ title: Vercel order: 6 mainNavExclude: true use_cases: >- - deploying to production, hosting frontend projects, continuous deployment, web - interface deployment, cli deployment + deploying to production, hosting solid apps, ci/cd setup, automatic + deployments, serverless functions tags: - deployment - hosting - - production - vercel - - cli - - frontend - - git + - production + - ci/cd + - serverless version: '1.0' +description: >- + Deploy SolidStart apps to Vercel with automatic builds, serverless functions, + and GitHub integration for seamless production hosting. --- [Vercel](https://vercel.com/) is a widely-used platform specialized in hosting frontend projects. diff --git a/src/routes/guides/deployment-options/zerops.mdx b/src/routes/guides/deployment-options/zerops.mdx index 60f8c30bf..e952bf18b 100644 --- a/src/routes/guides/deployment-options/zerops.mdx +++ b/src/routes/guides/deployment-options/zerops.mdx @@ -3,17 +3,20 @@ title: Zerops order: 7 mainNavExclude: true use_cases: >- - deploying to cloud platform, ssr deployment, static deployment, dev-first - hosting, node.js deployment + deploying solid apps, static site hosting, ssr deployment, node.js hosting, + production deployment tags: - deployment - hosting - - cloud - - ssr + - zerops - static - - nodejs + - ssr + - node.js - production version: '1.0' +description: >- + Deploy SolidStart apps to Zerops cloud platform with support for both static + sites and SSR Node.js applications in production. --- [Zerops](https://zerops.io) is a dev-first cloud platform that can be used to deploy both Static and SSR Solid Node.js Apps. diff --git a/src/routes/guides/fetching-data.mdx b/src/routes/guides/fetching-data.mdx index 493e1b87c..d191fcbf1 100644 --- a/src/routes/guides/fetching-data.mdx +++ b/src/routes/guides/fetching-data.mdx @@ -2,17 +2,20 @@ title: Fetching data order: 3 use_cases: >- - data fetching, api calls, async operations, loading states, error handling, - real-time data, optimistic updates + api calls, async data loading, server communication, external data fetching, + loading states, error handling tags: - data + - fetching - async - api + - createresource + - suspense - loading - - error - - fetching - - resource version: '1.0' +description: >- + Master data fetching in Solid with createResource for async operations, + loading states, error handling, and Suspense boundaries. --- For most modern web applications, data fetching is a common task. diff --git a/src/routes/guides/routing-and-navigation.mdx b/src/routes/guides/routing-and-navigation.mdx index eb2d5f179..9e3d8ad0d 100644 --- a/src/routes/guides/routing-and-navigation.mdx +++ b/src/routes/guides/routing-and-navigation.mdx @@ -2,17 +2,20 @@ title: Routing & navigation order: 4 use_cases: >- - navigation between pages, url routing, dynamic routes, nested routes, route - parameters, spa routing, preloading data + page navigation, url routing, spa routing, dynamic routes, nested layouts, + route parameters, lazy loading pages tags: - routing - navigation + - routes - spa - - pages - - dynamic - - nested - - preload + - lazy-loading + - parameters + - layouts version: '1.0' +description: >- + Implement client-side routing in Solid apps with dynamic routes, nested + layouts, route parameters, and lazy-loaded components. --- [Solid Router](/solid-router) simplifies routing in Solid applications to help developers manage navigation and rendering by defining routes using JSX or objects passed via props. diff --git a/src/routes/guides/state-management.mdx b/src/routes/guides/state-management.mdx index 14cf07e56..1b6af9385 100644 --- a/src/routes/guides/state-management.mdx +++ b/src/routes/guides/state-management.mdx @@ -2,17 +2,20 @@ title: State management order: 2 use_cases: >- - managing component state, reactivity, derived values, sharing state, lifting - state, complex applications, interactive ui + managing app state, component communication, data flow, reactive updates, + shared state, derived values tags: - state - - reactivity - signals - - derived - - effects + - reactivity + - data-flow - memos - - components + - effects + - management version: '1.0' +description: >- + Learn Solid's state management with signals, derived values, memos, and + effects for reactive data flow and component updates. --- State management is the process of handling and manipulating data that affects the behavior and presentation of a web application. diff --git a/src/routes/guides/styling-components/css-modules.mdx b/src/routes/guides/styling-components/css-modules.mdx index 2b40d131f..5d48a0fe6 100644 --- a/src/routes/guides/styling-components/css-modules.mdx +++ b/src/routes/guides/styling-components/css-modules.mdx @@ -3,16 +3,19 @@ title: CSS modules order: 3 mainNavExclude: true use_cases: >- - scoped styling, avoiding css conflicts, component-specific styles, modular - css, style encapsulation + component styling, scoped styles, style encapsulation, preventing css + conflicts, modular css tags: + - styling - css - modules - - styling - scoped - components - encapsulation version: '1.0' +description: >- + Use CSS Modules in Solid for locally scoped styles, preventing global + conflicts and ensuring component style encapsulation. --- CSS Modules are CSS files where class names, animations, and media queries are scoped locally by default. diff --git a/src/routes/guides/styling-components/less.mdx b/src/routes/guides/styling-components/less.mdx index 2e66b9690..ce55726fe 100644 --- a/src/routes/guides/styling-components/less.mdx +++ b/src/routes/guides/styling-components/less.mdx @@ -3,16 +3,19 @@ title: LESS order: 2 mainNavExclude: true use_cases: >- - advanced css features, css preprocessing, variables in styles, mixins, - programmatic styling + css preprocessing, style variables, mixins, nested styles, programmatic + styling tags: - - css - - preprocessing + - styling - less + - preprocessor - variables - mixins - - styling + - css version: '1.0' +description: >- + Integrate LESS preprocessor in Solid apps for variables, mixins, and + programmatic CSS features to write cleaner stylesheets. --- [LESS](https://lesscss.org/) is a preprocessor based on JavaScript. diff --git a/src/routes/guides/styling-components/macaron.mdx b/src/routes/guides/styling-components/macaron.mdx index c5f3eb35e..24af235bf 100644 --- a/src/routes/guides/styling-components/macaron.mdx +++ b/src/routes/guides/styling-components/macaron.mdx @@ -3,16 +3,19 @@ title: Macaron order: 4 mainNavExclude: true use_cases: >- - type-safe styling, compile-time css, css-in-js, styled components, variant - styling, design systems + css-in-js styling, type-safe styles, styled components, variant-based styling, + compile-time css tags: - - css-in-js - styling + - css-in-js + - macaron + - styled-components - typescript - variants - - compile-time - - styled version: '1.0' +description: >- + Style Solid components with Macaron's compile-time CSS-in-JS, offering + type-safe styled components and variant-based styling. --- [Macaron](https://macaron.js.org/) is compile-time CSS-in-JS library that offers type safety. diff --git a/src/routes/guides/styling-components/sass.mdx b/src/routes/guides/styling-components/sass.mdx index 79b35cd17..e03d3b374 100644 --- a/src/routes/guides/styling-components/sass.mdx +++ b/src/routes/guides/styling-components/sass.mdx @@ -3,16 +3,20 @@ title: SASS order: 1 mainNavExclude: true use_cases: >- - advanced css features, css preprocessing, nested styles, scss syntax, sass - syntax, modular styling + css preprocessing, nested styles, style variables, mixins, scss syntax, + modular styling tags: - - css - - preprocessing + - styling - sass - scss - - nested - - styling + - preprocessor + - variables + - css + - mixins version: '1.0' +description: >- + Configure SASS/SCSS in Solid projects for advanced CSS preprocessing with + variables, nesting, mixins, and modular stylesheets. --- [SASS](https://sass-lang.com/) is a popular CSS preprocessor that makes authoring CSS easier. diff --git a/src/routes/guides/styling-components/tailwind-v3.mdx b/src/routes/guides/styling-components/tailwind-v3.mdx index 53da04234..75daec018 100644 --- a/src/routes/guides/styling-components/tailwind-v3.mdx +++ b/src/routes/guides/styling-components/tailwind-v3.mdx @@ -3,16 +3,19 @@ title: Tailwind CSS v3 order: 7 mainNavExclude: true use_cases: >- - utility-first styling, rapid ui development, responsive design, design - systems, utility classes + utility-first css, rapid prototyping, responsive design, consistent styling, + atomic css classes tags: - - css - - utility + - styling - tailwind + - utility-css - responsive - - design - - classes + - postcss + - atomic-css version: '1.0' +description: >- + Set up Tailwind CSS v3 in Solid apps for utility-first styling, rapid + development, and consistent responsive design patterns. --- [Tailwind CSS v3](https://v3.tailwindcss.com/) is an on-demand utility CSS library that integrates seamlessly with Solid as a built-in PostCSS plugin. diff --git a/src/routes/guides/styling-components/tailwind.mdx b/src/routes/guides/styling-components/tailwind.mdx index 6aed3d1cf..851334037 100644 --- a/src/routes/guides/styling-components/tailwind.mdx +++ b/src/routes/guides/styling-components/tailwind.mdx @@ -2,15 +2,20 @@ title: Tailwind CSS order: 5 mainNavExclude: true -use_cases: 'styling projects, utility-first css, responsive design, component styling' +use_cases: >- + styling components, utility classes, rapid ui development, responsive design, + production builds tags: - - tailwind - - css - styling - - utilities + - css + - tailwind - postcss + - utilities - design version: '1.0' +description: >- + Set up Tailwind CSS v4 in your Solid app for utility-first styling. Configure + PostCSS, import styles, and build responsive UIs efficiently. --- :::note diff --git a/src/routes/guides/styling-components/uno.mdx b/src/routes/guides/styling-components/uno.mdx index 1f83633e0..71db755fd 100644 --- a/src/routes/guides/styling-components/uno.mdx +++ b/src/routes/guides/styling-components/uno.mdx @@ -2,15 +2,19 @@ title: UnoCSS order: 6 mainNavExclude: true -use_cases: 'styling projects, utility-first css, atomic css, on-demand css generation' +use_cases: >- + styling components, utility css, on-demand styles, vite integration, atomic + css tags: - - unocss - - css - styling - - utilities - - atomic + - css + - unocss - vite + - utilities version: '1.0' +description: >- + Integrate UnoCSS with Solid for on-demand utility CSS. Configure Vite plugin, + import styles, and create efficient atomic CSS designs quickly. --- [UnoCSS](https://unocss.dev/) is an on-demand utility CSS library that integrates seamlessly with Solid as a Vite plugin. diff --git a/src/routes/guides/styling-your-components.mdx b/src/routes/guides/styling-your-components.mdx index 4026ea8e7..4858702bc 100644 --- a/src/routes/guides/styling-your-components.mdx +++ b/src/routes/guides/styling-your-components.mdx @@ -2,16 +2,18 @@ title: Styling your components order: 1 use_cases: >- - component styling, css architecture, styling approach selection, design - systems + styling components, choosing css solutions, css frameworks, preprocessors, + css-in-js tags: - styling - css - - design - - components - preprocessors - css-in-js + - frameworks version: '1.0' +description: >- + Explore Solid's flexible styling options: CSS preprocessors, CSS Modules, + CSS-in-JS, and utility frameworks for component styling needs. --- Solid provides flexible and versatile ways to style your components. diff --git a/src/routes/guides/testing.mdx b/src/routes/guides/testing.mdx index e00bc4d82..c649b1ca0 100644 --- a/src/routes/guides/testing.mdx +++ b/src/routes/guides/testing.mdx @@ -2,16 +2,18 @@ title: Testing order: 6 use_cases: >- - testing components, test-driven development, quality assurance, regression - prevention, component validation + testing components, unit tests, integration tests, user interactions, test + coverage, quality assurance tags: - testing - vitest - components + - unit-tests - quality - - tdd - - validation version: '1.0' +description: >- + Test Solid apps with Vitest and Testing Library. Write component tests, + simulate user interactions, and ensure code quality effectively. --- Testing your Solid applications is important to inspiring confidence in your codebase through preventing regressions. diff --git a/src/routes/index.mdx b/src/routes/index.mdx index 54c333c0d..d288af165 100644 --- a/src/routes/index.mdx +++ b/src/routes/index.mdx @@ -2,15 +2,18 @@ title: Overview mainNavExclude: true use_cases: >- - learning solid fundamentals, getting started, understanding reactivity, - framework introduction + getting started, learning solid, understanding framework, first project, + introduction tags: - introduction - - fundamentals - - reactivity - overview - getting-started + - basics + - framework version: '1.0' +description: >- + Solid is a reactive JavaScript framework for building fast, efficient UIs. + Learn about fine-grained reactivity and modern web development. --- # Overview diff --git a/src/routes/pt-br/index.mdx b/src/routes/pt-br/index.mdx index 5cac3f8b6..b8f18df57 100644 --- a/src/routes/pt-br/index.mdx +++ b/src/routes/pt-br/index.mdx @@ -2,15 +2,18 @@ title: Sumário mainNavExclude: true use_cases: >- - learning solid fundamentals, getting started, understanding reactivity, - framework introduction + getting started, learning solid, understanding framework, first project, + introduction tags: - introduction - - fundamentals - - reactivity - overview - getting-started + - basics + - framework version: '1.0' +description: >- + Solid is a reactive JavaScript framework for building fast, efficient UIs. + Learn about fine-grained reactivity and modern web development. --- # Sumário diff --git a/src/routes/pt-br/quick-start.mdx b/src/routes/pt-br/quick-start.mdx index 712bb43ca..2ea5251b7 100644 --- a/src/routes/pt-br/quick-start.mdx +++ b/src/routes/pt-br/quick-start.mdx @@ -1,13 +1,18 @@ --- title: Começo rápido -use_cases: 'starting new projects, project setup, development environment, prototyping' +use_cases: >- + starting new project, project setup, first app, development environment, + templates tags: - quickstart - setup - templates + - getting-started - playground - - new-project version: '1.0' +description: >- + Start building with Solid quickly. Try the playground, create projects with + templates, and get your first Solid app running in minutes. --- ## Solid playgrounds diff --git a/src/routes/pt-br/solid-router/index.mdx b/src/routes/pt-br/solid-router/index.mdx index 699e96308..b87c1bba6 100644 --- a/src/routes/pt-br/solid-router/index.mdx +++ b/src/routes/pt-br/solid-router/index.mdx @@ -2,15 +2,18 @@ title: Sumário mainNavExclude: true use_cases: >- - learning solid fundamentals, getting started, understanding reactivity, - framework introduction + getting started, learning solid, understanding framework, first project, + introduction tags: - introduction - - fundamentals - - reactivity - overview - getting-started + - basics + - framework version: '1.0' +description: >- + Solid is a reactive JavaScript framework for building fast, efficient UIs. + Learn about fine-grained reactivity and modern web development. --- # Roteador diff --git a/src/routes/pt-br/solid-router/quick-start.mdx b/src/routes/pt-br/solid-router/quick-start.mdx index 712bb43ca..2ea5251b7 100644 --- a/src/routes/pt-br/solid-router/quick-start.mdx +++ b/src/routes/pt-br/solid-router/quick-start.mdx @@ -1,13 +1,18 @@ --- title: Começo rápido -use_cases: 'starting new projects, project setup, development environment, prototyping' +use_cases: >- + starting new project, project setup, first app, development environment, + templates tags: - quickstart - setup - templates + - getting-started - playground - - new-project version: '1.0' +description: >- + Start building with Solid quickly. Try the playground, create projects with + templates, and get your first Solid app running in minutes. --- ## Solid playgrounds diff --git a/src/routes/quick-start.mdx b/src/routes/quick-start.mdx index 6f1eaec34..e29b3298a 100644 --- a/src/routes/quick-start.mdx +++ b/src/routes/quick-start.mdx @@ -1,13 +1,18 @@ --- title: Quick start -use_cases: 'starting new projects, project setup, development environment, prototyping' +use_cases: >- + starting new project, project setup, first app, development environment, + templates tags: - quickstart - setup - templates + - getting-started - playground - - new-project version: '1.0' +description: >- + Start building with Solid quickly. Try the playground, create projects with + templates, and get your first Solid app running in minutes. --- ## Try Solid online diff --git a/src/routes/reference/basic-reactivity/create-effect.mdx b/src/routes/reference/basic-reactivity/create-effect.mdx index 1d578f521..760632341 100644 --- a/src/routes/reference/basic-reactivity/create-effect.mdx +++ b/src/routes/reference/basic-reactivity/create-effect.mdx @@ -1,16 +1,19 @@ --- title: createEffect use_cases: >- - side effects, dom manipulation, event listeners, cleanup, library integration, - custom reactive behavior + dom manipulation, side effects, manual dom updates, vanilla js integration, + cleanup operations, logging changes tags: - - reactivity - - side-effects + - effects - dom + - side-effects + - reactivity - lifecycle - cleanup - - tracking version: '1.0' +description: >- + Learn how to use createEffect to run side effects when reactive dependencies + change. Perfect for DOM manipulation and external library integration. --- ```tsx diff --git a/src/routes/reference/basic-reactivity/create-memo.mdx b/src/routes/reference/basic-reactivity/create-memo.mdx index 864883151..b193040c4 100644 --- a/src/routes/reference/basic-reactivity/create-memo.mdx +++ b/src/routes/reference/basic-reactivity/create-memo.mdx @@ -1,16 +1,19 @@ --- title: createMemo use_cases: >- - expensive computations, derived values, performance optimization, preventing - duplicate calculations + expensive computations, derived values, performance optimization, caching + calculations, preventing duplicate work tags: - - reactivity - - performance - memoization - - computed + - performance - optimization + - derived-state - caching + - reactivity version: '1.0' +description: >- + Use createMemo to efficiently compute and cache derived values. Prevent + expensive recalculations and optimize your Solid.js application's performance. --- Memos let you efficiently use a derived value in many reactive computations. diff --git a/src/routes/reference/basic-reactivity/create-resource.mdx b/src/routes/reference/basic-reactivity/create-resource.mdx index 8944e9174..2ebcfb4de 100644 --- a/src/routes/reference/basic-reactivity/create-resource.mdx +++ b/src/routes/reference/basic-reactivity/create-resource.mdx @@ -2,16 +2,19 @@ title: createResource use_cases: >- data fetching, api calls, async operations, loading states, error handling, - server state management + server data, suspense boundaries tags: - async - - data-fetching + - fetching - api + - suspense - loading - error-handling - ssr - - suspense version: '1.0' +description: >- + Fetch async data with createResource. Handles loading states, errors, and + integrates with Suspense for seamless data fetching in Solid.js applications. --- `createResource` takes an asynchronous fetcher function and returns a signal that is updated with the resulting data when the fetcher completes. diff --git a/src/routes/reference/basic-reactivity/create-signal.mdx b/src/routes/reference/basic-reactivity/create-signal.mdx index 06fddadaa..f6de896ac 100644 --- a/src/routes/reference/basic-reactivity/create-signal.mdx +++ b/src/routes/reference/basic-reactivity/create-signal.mdx @@ -1,17 +1,18 @@ --- title: createSignal use_cases: >- - always, reactive state, component state, global state, any reactive value - tracking + state management, reactive values, component state, form inputs, counters, + toggles, any reactive data tags: - - reactivity - - state - signals + - state + - reactivity - core - - tracking - - getters - - setters + - primitives version: '1.0' +description: >- + Create reactive state with createSignal, Solid's fundamental primitive. Track + values that change over time and automatically update your UI when they do. --- Signals are the most basic reactive primitive. diff --git a/src/routes/reference/component-apis/children.mdx b/src/routes/reference/component-apis/children.mdx index 688d5f1cc..486aff74a 100644 --- a/src/routes/reference/component-apis/children.mdx +++ b/src/routes/reference/component-apis/children.mdx @@ -1,16 +1,19 @@ --- title: children use_cases: >- - custom component wrappers, manipulating children, reusing children, - conditional children rendering + complex children manipulation, reusing children, avoiding duplicate dom, + children transformation, conditional children rendering tags: - - components - children + - props + - components - jsx - - dom - - wrapper - - conditional + - composition + - helpers version: '1.0' +description: >- + Use the children helper for complex child manipulation in Solid.js. Resolve, + reuse, and transform component children without creating duplicate DOM. --- ```tsx diff --git a/src/routes/reference/component-apis/create-context.mdx b/src/routes/reference/component-apis/create-context.mdx index fc8d12383..e2e5d1a55 100644 --- a/src/routes/reference/component-apis/create-context.mdx +++ b/src/routes/reference/component-apis/create-context.mdx @@ -2,15 +2,18 @@ title: createContext order: 5 use_cases: >- - avoid prop drilling, global state, theme providers, user context, deep - component communication + prop drilling, global state, theme providers, user authentication, app-wide + settings, dependency injection tags: - context - - dependency-injection - - prop-drilling - - provider + - providers - global-state + - props + - dependency-injection version: '1.0' +description: >- + Create context providers with createContext to share data across components + without prop drilling. Perfect for themes, auth, and global app state. --- diff --git a/src/routes/reference/component-apis/create-unique-id.mdx b/src/routes/reference/component-apis/create-unique-id.mdx index b8d54c426..82c1c88e0 100644 --- a/src/routes/reference/component-apis/create-unique-id.mdx +++ b/src/routes/reference/component-apis/create-unique-id.mdx @@ -1,16 +1,18 @@ --- title: createUniqueId use_cases: >- - accessibility, form labels, unique identifiers, ssr compatibility, aria - attributes + form elements, accessibility, aria labels, ssr compatibility, html id + generation, unique identifiers tags: + - ids - accessibility - - forms - ssr - - identifiers - - aria - - labels + - forms + - utilities version: '1.0' +description: >- + Generate unique IDs that are stable across server and client with + createUniqueId. Essential for accessible forms and SSR-compatible components. --- ```ts diff --git a/src/routes/reference/component-apis/lazy.mdx b/src/routes/reference/component-apis/lazy.mdx index 4993522d1..0760a518b 100644 --- a/src/routes/reference/component-apis/lazy.mdx +++ b/src/routes/reference/component-apis/lazy.mdx @@ -1,16 +1,19 @@ --- title: lazy use_cases: >- - code splitting, performance optimization, bundle size reduction, dynamic - imports, route splitting + code splitting, performance optimization, reducing bundle size, dynamic + imports, route-based splitting, lazy loading tags: - - performance - - code-splitting - lazy-loading - - dynamic-imports + - code-splitting + - performance - suspense - optimization + - imports version: '1.0' +description: >- + Lazy load components with code splitting to reduce bundle size and improve + performance. Components load on-demand and integrate with Suspense. --- ```ts diff --git a/src/routes/reference/component-apis/use-context.mdx b/src/routes/reference/component-apis/use-context.mdx index a4c3c3b36..fdc7155cd 100644 --- a/src/routes/reference/component-apis/use-context.mdx +++ b/src/routes/reference/component-apis/use-context.mdx @@ -1,15 +1,18 @@ --- title: useContext use_cases: >- - consuming context, accessing provider data, avoiding prop drilling, shared - state access + consuming context, accessing global state, avoiding prop drilling, theme + access, auth state, shared data tags: - context - - provider - - prop-drilling - - shared-state - - dependency-injection + - providers + - global-state + - hooks + - consumption version: '1.0' +description: >- + Access context values with useContext to consume data from parent providers. + Avoid prop drilling and access shared state throughout your component tree. --- Used to grab context within a context provider scope to allow for deep passing of props without having to pass them through each Component function. diff --git a/src/routes/reference/components/dynamic.mdx b/src/routes/reference/components/dynamic.mdx index aedf652ce..ec766c8f1 100644 --- a/src/routes/reference/components/dynamic.mdx +++ b/src/routes/reference/components/dynamic.mdx @@ -2,16 +2,19 @@ title: order: 5 use_cases: >- - dynamic component rendering, runtime component selection, polymorphic - components, flexible layouts + dynamic components, conditional rendering, polymorphic components, runtime + component selection, flexible ui, component switching tags: - - components - dynamic + - components + - jsx - polymorphic - - runtime - - flexible + - rendering - conditional version: '1.0' +description: >- + Render components dynamically at runtime with the Dynamic component. Perfect + for polymorphic components and conditional component rendering. --- This component lets you insert an arbitrary Component or tag and passes the props through to it. diff --git a/src/routes/reference/components/error-boundary.mdx b/src/routes/reference/components/error-boundary.mdx index 8684a10a8..578bfcdb0 100644 --- a/src/routes/reference/components/error-boundary.mdx +++ b/src/routes/reference/components/error-boundary.mdx @@ -2,15 +2,19 @@ title: order: 5 use_cases: >- - error handling, production apps, graceful error recovery, debugging, - preventing crashes, user experience + error handling, production apps, preventing crashes, user experience, + debugging, fallback ui tags: - error-handling - - production + - components - debugging - - user-experience - - recovery + - fallback + - production + - stability version: '1.0' +description: >- + Catch and handle rendering errors in SolidJS components with ErrorBoundary. + Display fallback UI when errors occur in children components. --- The `` component catches errors that occur during the rendering or updating of its children and shows a fallback UI instead. diff --git a/src/routes/reference/components/for.mdx b/src/routes/reference/components/for.mdx index 74fb5c231..1d1794081 100644 --- a/src/routes/reference/components/for.mdx +++ b/src/routes/reference/components/for.mdx @@ -2,16 +2,19 @@ title: order: 5 use_cases: >- - rendering lists, dynamic content, arrays, iterating data, keyed updates, - performance optimization + rendering lists, dynamic arrays, data iteration, collections, tables, + repeating elements tags: - lists - - arrays - iteration - - dynamic-content + - components + - arrays + - rendering - performance - - keyed-updates version: '1.0' +description: >- + Efficiently render lists in SolidJS with the For component. Provides keyed + iteration with minimal DOM updates for dynamic array rendering. --- The `` component is used to render a list of items. It is similar to the `.map()` function in JavaScript. diff --git a/src/routes/reference/components/index-component.mdx b/src/routes/reference/components/index-component.mdx index 079cd3fa6..d511b9c8c 100644 --- a/src/routes/reference/components/index-component.mdx +++ b/src/routes/reference/components/index-component.mdx @@ -1,16 +1,19 @@ --- title: use_cases: >- - primitive arrays, non-keyed lists, index-based rendering, simple data, - position-based updates + primitive arrays, non-keyed lists, index-based rendering, static positions, + simple lists tags: - lists + - iteration + - components - arrays - primitives - - index-based - - non-keyed - - simple-data + - index version: '1.0' +description: >- + Render non-keyed lists in SolidJS with Index component. Perfect for primitive + arrays where index position matters more than item identity. --- Non-keyed list iteration (rendered nodes are keyed to an array index). This is useful when there is no conceptual key, like if the data consists of primitives and it is the index that is fixed rather than the value. diff --git a/src/routes/reference/components/no-hydration.mdx b/src/routes/reference/components/no-hydration.mdx index 1b55139b9..3c5c4fa50 100644 --- a/src/routes/reference/components/no-hydration.mdx +++ b/src/routes/reference/components/no-hydration.mdx @@ -1,15 +1,19 @@ --- title: use_cases: >- - ssr optimization, static content, performance, hydration control, server - rendering + static content, ssr optimization, performance, reducing bundle size, + server-only rendering tags: - ssr - hydration - - performance - - static-content - optimization + - performance + - static + - server-rendering version: '1.0' +description: >- + Prevent client-side hydration for static content in SolidJS. Optimize + performance by skipping hydration for server-rendered static elements. --- The `` component prevents the client-side hydration process from being applied to its children. diff --git a/src/routes/reference/components/portal.mdx b/src/routes/reference/components/portal.mdx index 1c9268ef1..e6b763560 100644 --- a/src/routes/reference/components/portal.mdx +++ b/src/routes/reference/components/portal.mdx @@ -1,14 +1,17 @@ --- title: -use_cases: 'modals, tooltips, dropdowns, overlays, z-index issues, dom hierarchy bypass' +use_cases: 'modals, tooltips, overlays, popups, dropdowns, ui layers, escape dom hierarchy' tags: + - portal - modals - - tooltips + - dom - overlays - - z-index - - dom-hierarchy - - ui-components + - tooltips + - components version: '1.0' +description: >- + Render SolidJS components outside parent DOM hierarchy with Portal. Perfect + for modals, tooltips, and overlays that need to escape layout. --- `` is a component that allows you to render children into a DOM node that exists outside the DOM hierarchy of the parent component. diff --git a/src/routes/reference/components/show.mdx b/src/routes/reference/components/show.mdx index 9505d4981..adcf4d2a1 100644 --- a/src/routes/reference/components/show.mdx +++ b/src/routes/reference/components/show.mdx @@ -2,15 +2,19 @@ title: order: 5 use_cases: >- - conditional rendering, toggle visibility, boolean states, show hide logic, - conditional ui + conditional rendering, toggling ui, feature flags, loading states, user + permissions, responsive design tags: - - conditional-rendering - - visibility - - boolean-logic - - ui-state + - conditional + - rendering + - components + - control-flow + - ui - toggle version: '1.0' +description: >- + Conditionally render UI elements in SolidJS with Show component. Display + content based on truthy conditions with optional fallback support. --- The `` component is used for conditionally rendering UI elements. diff --git a/src/routes/reference/components/suspense-list.mdx b/src/routes/reference/components/suspense-list.mdx index d98a57398..d370c1825 100644 --- a/src/routes/reference/components/suspense-list.mdx +++ b/src/routes/reference/components/suspense-list.mdx @@ -2,15 +2,19 @@ title: order: 5 use_cases: >- - coordinating multiple async operations, loading sequences, layout stability, - multiple suspense boundaries + coordinating loading, multiple async, loading sequences, layout stability, + parallel data fetching tags: - - async-coordination - - loading-sequences - - layout-stability + - suspense + - async + - loading + - coordination - experimental - - multiple-suspense + - components version: '1.0' +description: >- + Coordinate multiple Suspense components in SolidJS. Control reveal order and + manage loading states for parallel async operations smoothly. --- SuspenseList allows for coordinating multiple parallel Suspense and SuspenseList components. It controls the order in which content is revealed to reduce layout thrashing and has an option to collapse or hide fallback states. diff --git a/src/routes/reference/components/suspense.mdx b/src/routes/reference/components/suspense.mdx index fd6571d94..ddd676164 100644 --- a/src/routes/reference/components/suspense.mdx +++ b/src/routes/reference/components/suspense.mdx @@ -2,15 +2,19 @@ title: order: 5 use_cases: >- - async data loading, loading states, resource fetching, user experience, data - dependencies + async data, loading states, data fetching, api calls, lazy loading, user + experience tags: - - async-loading - - loading-states - - data-fetching + - suspense + - async + - loading - resources - - user-experience + - components + - data-fetching version: '1.0' +description: >- + Handle async operations elegantly in SolidJS with Suspense. Show loading + states while resources load without blocking UI rendering. --- A component that tracks all resources read under it and shows a fallback placeholder state until they are resolved. What makes `Suspense` different than `Show` is that it is non-blocking in the sense that both branches exist at the same time even if not currently in the DOM. This means that the fallback can be rendered while the children are loading. This is useful for loading states and other asynchronous operations. diff --git a/src/routes/reference/components/switch-and-match.mdx b/src/routes/reference/components/switch-and-match.mdx index 653344cde..643451aff 100644 --- a/src/routes/reference/components/switch-and-match.mdx +++ b/src/routes/reference/components/switch-and-match.mdx @@ -2,15 +2,19 @@ title: / order: 5 use_cases: >- - multiple conditions, routing, complex conditional logic, state machines, - exclusive choices + multiple conditions, routing, complex branching, state machines, multi-way + decisions, replacing if-else chains tags: - - multiple-conditions + - conditional - routing - - conditional-logic - - state-machines - - exclusive-choices + - control-flow + - components + - branching + - switch version: '1.0' +description: >- + Handle multiple exclusive conditions in SolidJS with Switch and Match. Clean + alternative to if-else chains for complex conditional rendering. --- Useful for when there are more than 2 mutual exclusive conditions. It is a more flexible version of the if-else-if-else-if-else-... chain. diff --git a/src/routes/reference/jsx-attributes/attr.mdx b/src/routes/reference/jsx-attributes/attr.mdx index a4cd2890d..3c8c625ae 100644 --- a/src/routes/reference/jsx-attributes/attr.mdx +++ b/src/routes/reference/jsx-attributes/attr.mdx @@ -1,15 +1,19 @@ --- title: 'attr:*' use_cases: >- - web components, custom elements, attribute setting, typescript integration, - dom attributes + web components, custom elements, forcing attributes, html attributes, dom + properties tags: - - web-components - - custom-elements - attributes + - web-components + - dom + - props - typescript - - dom-manipulation + - custom-elements version: '1.0' +description: >- + Force props as HTML attributes instead of properties in SolidJS. Essential for + Web Components and custom element attribute handling. --- Forces the prop to be treated as an attribute instead of a property. diff --git a/src/routes/reference/jsx-attributes/bool.mdx b/src/routes/reference/jsx-attributes/bool.mdx index 0b56b7098..a9fcae018 100644 --- a/src/routes/reference/jsx-attributes/bool.mdx +++ b/src/routes/reference/jsx-attributes/bool.mdx @@ -1,14 +1,18 @@ --- title: 'bool:*' use_cases: >- - web components, custom elements, boolean attributes, conditional element - attributes + web components, custom elements, conditional attributes, boolean attributes, + dynamic attribute presence tags: + - attributes - web-components - - custom-elements - - boolean-attributes - - conditional-rendering + - boolean + - conditional + - dynamic version: '1.0' +description: >- + Control attribute presence with bool:* directive in SolidJS. Add or remove + attributes dynamically based on truthy/falsy values for web components. --- `bool:*` controls the presence of an attribute in an element. diff --git a/src/routes/reference/jsx-attributes/classlist.mdx b/src/routes/reference/jsx-attributes/classlist.mdx index 550d18d2a..770702e99 100644 --- a/src/routes/reference/jsx-attributes/classlist.mdx +++ b/src/routes/reference/jsx-attributes/classlist.mdx @@ -1,14 +1,20 @@ --- title: classList order: 1 -use_cases: 'styling, conditional classes, dynamic css, ui state changes, theme switching' +use_cases: >- + styling components, dynamic classes, conditional styles, toggling classes, + reactive styling tags: - styling - - css-classes - - conditional-styling - - dynamic-classes - - ui-state + - css + - classes + - reactive + - conditional + - dom version: '1.0' +description: >- + Manage element classes dynamically in SolidJS with class and classList + attributes. Toggle multiple classes reactively based on application state. --- Solid offers two attributes to set the class of an element: `class` and `classList`. diff --git a/src/routes/reference/jsx-attributes/innerhtml.mdx b/src/routes/reference/jsx-attributes/innerhtml.mdx index bf5a54e4e..f0adac24a 100644 --- a/src/routes/reference/jsx-attributes/innerhtml.mdx +++ b/src/routes/reference/jsx-attributes/innerhtml.mdx @@ -1,15 +1,18 @@ --- title: innerHTML use_cases: >- - raw html rendering, html strings, rich content, wysiwyg editors, markdown - output + rendering html strings, dynamic html content, third-party html, legacy content + migration, sanitized markup tags: - - html-rendering - - raw-html - - content-injection + - html + - dom - security - - rich-content + - content + - markup version: '1.0' +description: >- + Set raw HTML content in SolidJS elements using innerHTML attribute and render + HTML strings dynamically. --- The `innerHTML` attribute is equivalent to the [`innerHTML` DOM property](https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML). diff --git a/src/routes/reference/jsx-attributes/on.mdx b/src/routes/reference/jsx-attributes/on.mdx index 73f42f584..1c3a96bbc 100644 --- a/src/routes/reference/jsx-attributes/on.mdx +++ b/src/routes/reference/jsx-attributes/on.mdx @@ -2,16 +2,19 @@ title: 'on:*' order: 4 use_cases: >- - custom events, event options, capture events, passive events, non-standard - events + custom events, non-bubbling events, capture phase handling, passive listeners, + special event options tags: - - event-handling - - custom-events - - event-options + - events + - listeners + - dom - capture - passive - - dom-events + - handlers version: '1.0' +description: >- + Attach non-delegated event handlers with on:* in SolidJS. Control capture, + passive, and once options for advanced event handling requirements. --- For events with capital letters, listener options, or if you need to attach event handlers directly to a DOM element instead of optimized delegating via the document, use `on:*` in place of `on*`. diff --git a/src/routes/reference/jsx-attributes/on_.mdx b/src/routes/reference/jsx-attributes/on_.mdx index 2cbcae58e..06a7fa0fe 100644 --- a/src/routes/reference/jsx-attributes/on_.mdx +++ b/src/routes/reference/jsx-attributes/on_.mdx @@ -1,15 +1,20 @@ --- title: on* order: 3 -use_cases: 'event handling, user interactions, clicks, form inputs, ui responses, always' +use_cases: >- + user interactions, click handlers, form events, keyboard input, mouse events, + touch handling tags: - - event-handling - - user-interaction - - clicks - - forms + - events + - handlers + - interactions + - click + - input - delegation - - performance version: '1.0' +description: >- + Handle user events efficiently in SolidJS with onClick and other event + handlers. Optimized delegation system for improved performance at scale. --- Event handlers in Solid typically take the form of `onclick` or `onClick` depending on style. diff --git a/src/routes/reference/jsx-attributes/once.mdx b/src/routes/reference/jsx-attributes/once.mdx index 8e06d5674..5d4c2faa1 100644 --- a/src/routes/reference/jsx-attributes/once.mdx +++ b/src/routes/reference/jsx-attributes/once.mdx @@ -2,15 +2,18 @@ title: '@once' order: 5 use_cases: >- - performance optimization, static values, reducing reactivity overhead, large - lists + performance optimization, static props, non-reactive values, compile-time + optimization, reducing overhead tags: - - performance - optimization - - static-values - - compiler-hints - - reactivity + - performance + - static + - compiler + - jsx version: '1.0' +description: >- + Optimize SolidJS components with @once decorator for static values. Prevent + unnecessary reactive wrapping and improve runtime performance. --- Solid's compiler uses a heuristic for reactive wrapping and lazy evaluation of JSX expressions. Does it contain a function call, a property access, or JSX? If yes we wrap it in a getter when passed to components or in an effect if passed to native elements. diff --git a/src/routes/reference/jsx-attributes/prop.mdx b/src/routes/reference/jsx-attributes/prop.mdx index 4a3c325de..fc651731f 100644 --- a/src/routes/reference/jsx-attributes/prop.mdx +++ b/src/routes/reference/jsx-attributes/prop.mdx @@ -2,14 +2,18 @@ title: 'prop:*' order: 6 use_cases: >- - dom properties, custom properties, element configuration, non-attribute - properties + dom properties, scrolltop manipulation, custom properties, property vs + attribute, direct property access tags: - - dom-properties - - custom-properties - - element-configuration - - typescript + - properties + - dom + - attributes + - manipulation + - custom version: '1.0' +description: >- + Force DOM property assignment with prop:* in SolidJS. Set properties directly + instead of attributes for specific DOM manipulation needs. --- Forces the prop to be treated as a property instead of an attribute. diff --git a/src/routes/reference/jsx-attributes/ref.mdx b/src/routes/reference/jsx-attributes/ref.mdx index b27f0c733..b4848ecea 100644 --- a/src/routes/reference/jsx-attributes/ref.mdx +++ b/src/routes/reference/jsx-attributes/ref.mdx @@ -2,16 +2,19 @@ title: ref order: 7 use_cases: >- - dom access, element references, imperative apis, focus management, - measurements + dom access, element manipulation, focus management, measurements, third-party + libraries, animations tags: - - dom-access - - element-refs - - imperative - - focus - - measurements - - lifecycle + - refs + - dom + - elements + - access + - manipulation + - components version: '1.0' +description: >- + Access DOM elements directly in SolidJS with refs. Get references to rendered + elements for imperative operations and third-party integrations. --- Refs are a way of getting access to underlying DOM elements in our JSX. While it is true one could just assign an element to a variable, it is more optimal to leave components in the flow of JSX. Refs are assigned at render time but before the elements are connected to the DOM. They come in 2 flavors. diff --git a/src/routes/reference/jsx-attributes/style.mdx b/src/routes/reference/jsx-attributes/style.mdx index 541f501c0..750ef6e50 100644 --- a/src/routes/reference/jsx-attributes/style.mdx +++ b/src/routes/reference/jsx-attributes/style.mdx @@ -1,14 +1,20 @@ --- title: style order: 7 -use_cases: 'styling, dynamic styles, css variables, inline styles, conditional styling' +use_cases: >- + inline styling, dynamic styles, css variables, responsive design, theme + customization, animated styles tags: - styling - css - - dynamic-styles - - css-variables - - inline-styles + - inline + - variables + - dynamic + - properties version: '1.0' +description: >- + Apply dynamic inline styles in SolidJS with string or object syntax. Set CSS + properties and variables reactively for responsive component styling. --- Solid's style attribute lets you provide either a CSS string or an object where keys are CSS property names: diff --git a/src/routes/reference/jsx-attributes/textcontent.mdx b/src/routes/reference/jsx-attributes/textcontent.mdx index 8aa26c634..03def76af 100644 --- a/src/routes/reference/jsx-attributes/textcontent.mdx +++ b/src/routes/reference/jsx-attributes/textcontent.mdx @@ -1,14 +1,18 @@ --- title: textContent use_cases: >- - text rendering, performance optimization, plain text content, text-only - elements + text-only content, performance optimization, plain text rendering, avoiding + html parsing, simple text updates tags: - - text-rendering + - text - performance - - text-content - - dom-properties + - content + - optimization + - dom version: '1.0' +description: >- + Optimize text rendering with textContent in SolidJS. Bypass diffing for + text-only content and improve performance for simple text updates. --- The `textContent` attribute is equivalent to the [`textContent` DOM property](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent). diff --git a/src/routes/reference/jsx-attributes/use.mdx b/src/routes/reference/jsx-attributes/use.mdx index 828d61a6b..f07d715e0 100644 --- a/src/routes/reference/jsx-attributes/use.mdx +++ b/src/routes/reference/jsx-attributes/use.mdx @@ -2,16 +2,19 @@ title: 'use:*' order: 5 use_cases: >- - complex dom interactions, reusable behaviors, tooltips, scrolling, form - handling, two-way data binding, custom element behavior + complex dom interactions, tooltips, form handling, two-way data binding, + reusable element behaviors, custom input components tags: - directives - - dom-manipulation - - reusable-behavior - - form-handling - - two-way-binding - - typescript-support + - dom + - forms + - bindings + - components + - typescript version: '1.0' +description: >- + Create custom directives in SolidJS to attach reusable behaviors to DOM + elements. Perfect for tooltips, form handling, and two-way data binding. --- Custom directives attach reusable behavior to DOM elements, acting as syntactic sugar over `ref`. They’re ideal for complex DOM interactions like scrolling, tooltips, or form handling, which are cumbersome to repeat in JSX. diff --git a/src/routes/reference/lifecycle/on-cleanup.mdx b/src/routes/reference/lifecycle/on-cleanup.mdx index 1f5b11e23..3cd9b5a24 100644 --- a/src/routes/reference/lifecycle/on-cleanup.mdx +++ b/src/routes/reference/lifecycle/on-cleanup.mdx @@ -2,16 +2,18 @@ title: onCleanup order: 5 use_cases: >- - component unmounting, memory leak prevention, event listener cleanup, resource - disposal, side effect cleanup, tracking scope disposal + component unmounting, memory leak prevention, event listener cleanup, side + effect cleanup, resource disposal tags: - - cleanup - - memory-management - lifecycle - - event-listeners - - resource-disposal - - side-effects + - cleanup + - memory + - events + - disposal version: '1.0' +description: >- + Register cleanup methods in SolidJS to prevent memory leaks. Executes when + components unmount or tracking scopes dispose. Essential for proper cleanup. --- `onCleanup` registers a cleanup method that executes on disposal and recalculation of the current tracking scope. diff --git a/src/routes/reference/lifecycle/on-mount.mdx b/src/routes/reference/lifecycle/on-mount.mdx index 5bab7be6e..75bd44c3d 100644 --- a/src/routes/reference/lifecycle/on-mount.mdx +++ b/src/routes/reference/lifecycle/on-mount.mdx @@ -2,16 +2,18 @@ title: onMount order: 5 use_cases: >- - component initialization, dom element refs, one-time setup, initial dom - manipulation, after render tasks + initial setup, dom refs access, one-time initialization, component mounting, + element manipulation after render tags: - lifecycle - mounting - - initialization - refs - - dom-access - - setup + - dom + - initialization version: '1.0' +description: >- + Run code after SolidJS components mount to the DOM. Perfect for accessing + refs, setting up third-party libraries, and one-time initializations. --- Registers a method that runs after initial rendering is done and the elements are mounted to the page. diff --git a/src/routes/reference/reactive-utilities/batch.mdx b/src/routes/reference/reactive-utilities/batch.mdx index 9a8c2bcd5..4a6c97705 100644 --- a/src/routes/reference/reactive-utilities/batch.mdx +++ b/src/routes/reference/reactive-utilities/batch.mdx @@ -1,16 +1,18 @@ --- title: batch use_cases: >- - performance optimization, avoiding unnecessary recalculations, batching - multiple signal updates, expensive dom updates, bulk data changes + performance optimization, multiple signal updates, reducing re-renders, bulk + state changes, avoiding unnecessary recalculations tags: - performance - - batching - optimization - - signal-updates - - dom-updates - - bulk-operations + - signals + - batching + - updates version: '1.0' +description: >- + Batch multiple signal updates in SolidJS to improve performance by reducing + recalculations. Essential for optimizing complex state changes. --- ```ts diff --git a/src/routes/reference/reactive-utilities/catch-error.mdx b/src/routes/reference/reactive-utilities/catch-error.mdx index dc724e39d..7b2222267 100644 --- a/src/routes/reference/reactive-utilities/catch-error.mdx +++ b/src/routes/reference/reactive-utilities/catch-error.mdx @@ -1,14 +1,17 @@ --- title: catchError use_cases: >- - error handling, error boundaries, graceful error recovery, catching - computation errors, error propagation control + error handling, error boundaries, exception management, debugging, graceful + error recovery tags: - - error-handling - - error-boundaries - - error-recovery - - exception-handling + - errors + - debugging + - exceptions + - handlers version: '1.0' +description: >- + Wrap SolidJS code with error handlers to catch and handle exceptions + gracefully. Create error boundaries for robust error management in components. --- :::note diff --git a/src/routes/reference/reactive-utilities/create-root.mdx b/src/routes/reference/reactive-utilities/create-root.mdx index c7e174f85..207b403fa 100644 --- a/src/routes/reference/reactive-utilities/create-root.mdx +++ b/src/routes/reference/reactive-utilities/create-root.mdx @@ -1,15 +1,18 @@ --- title: createRoot use_cases: >- - top-level app initialization, memory management, non-tracked scopes, manual - disposal control, nested tracking scopes + memory management, nested tracking scopes, non-auto-disposing scopes, manual + cleanup control, top-level code wrapping tags: - - root-scope - - memory-management - - initialization + - roots + - memory + - scopes - disposal - - tracking-scope + - tracking version: '1.0' +description: >- + Create non-tracked owner scopes in SolidJS for manual memory management. + Essential for nested tracking scopes and preventing auto-disposal. --- ```ts diff --git a/src/routes/reference/reactive-utilities/from.mdx b/src/routes/reference/reactive-utilities/from.mdx index 58f881395..33d889da6 100644 --- a/src/routes/reference/reactive-utilities/from.mdx +++ b/src/routes/reference/reactive-utilities/from.mdx @@ -1,16 +1,18 @@ --- title: from use_cases: >- - rxjs integration, external observables, svelte stores interop, third-party - reactive libraries, custom producers, subscription management + rxjs interop, svelte stores integration, external observables, third-party + state management, converting subscriptions to signals tags: - interop - - observables - rxjs - - subscriptions - - external-libraries - - reactive-integration + - observables + - signals + - integration version: '1.0' +description: >- + Convert RxJS observables and external producers into SolidJS signals. Seamless + integration with third-party reactive libraries and state managers. --- ```tsx diff --git a/src/routes/reference/reactive-utilities/get-owner.mdx b/src/routes/reference/reactive-utilities/get-owner.mdx index 3cb34c569..2528efe55 100644 --- a/src/routes/reference/reactive-utilities/get-owner.mdx +++ b/src/routes/reference/reactive-utilities/get-owner.mdx @@ -1,15 +1,18 @@ --- title: getOwner use_cases: >- - ownership tracking, cleanup management, advanced reactive patterns, passing - context outside scope, manual disposal control + advanced tracking control, custom cleanup logic, understanding component + hierarchy, debugging ownership chains, manual scope management tags: - ownership - - tracking-scope + - tracking + - scopes - cleanup - - advanced-patterns - - context-passing + - debugging version: '1.0' +description: >- + Access the current tracking scope owner in SolidJS for advanced control over + cleanup and disposal. Essential for custom reactive primitives. --- ```tsx diff --git a/src/routes/reference/reactive-utilities/index-array.mdx b/src/routes/reference/reactive-utilities/index-array.mdx index 45e3cc395..75143c192 100644 --- a/src/routes/reference/reactive-utilities/index-array.mdx +++ b/src/routes/reference/reactive-utilities/index-array.mdx @@ -1,16 +1,18 @@ --- title: indexArray use_cases: >- - list rendering by index, dynamic lists, index-based mapping, performance - optimization for arrays, control flow optimization + rendering lists by index, stable item references, index-based list operations, + optimized list rendering tags: - arrays - - list-rendering - - index-mapping - - control-flow - - performance - - mapping + - lists + - index + - rendering + - optimization version: '1.0' +description: >- + Map arrays by index in SolidJS where items are signals and indices are + constant. Optimized helper for index-based list rendering patterns. --- ```tsx diff --git a/src/routes/reference/reactive-utilities/map-array.mdx b/src/routes/reference/reactive-utilities/map-array.mdx index b15ab819c..576a06e73 100644 --- a/src/routes/reference/reactive-utilities/map-array.mdx +++ b/src/routes/reference/reactive-utilities/map-array.mdx @@ -1,16 +1,18 @@ --- title: mapArray use_cases: >- - list rendering by reference, dynamic lists, performance optimization for - arrays, reference-based mapping, control flow optimization + efficient list rendering, dynamic arrays, cached list transformations, + optimized updates, for loop alternatives tags: - arrays - - list-rendering - - reference-mapping - - control-flow - - performance - - mapping + - lists + - rendering + - caching + - optimization version: '1.0' +description: >- + Efficiently map reactive arrays in SolidJS with cached transformations. + Reduces unnecessary re-renders by tracking items by reference. --- ```ts diff --git a/src/routes/reference/reactive-utilities/merge-props.mdx b/src/routes/reference/reactive-utilities/merge-props.mdx index 3958274c1..0f2eb3ac6 100644 --- a/src/routes/reference/reactive-utilities/merge-props.mdx +++ b/src/routes/reference/reactive-utilities/merge-props.mdx @@ -1,13 +1,19 @@ --- title: mergeProps -use_cases: 'component libraries, default props, prop merging, reusable components' +use_cases: >- + component props, default values, prop cloning, prop merging, component + configuration tags: - props - components + - reactivity - defaults - - reactive + - cloning - merging version: '1.0' +description: >- + Learn how to merge reactive props in SolidJS for setting component defaults, + cloning props objects, and combining multiple prop sources dynamically. --- ```ts diff --git a/src/routes/reference/reactive-utilities/observable.mdx b/src/routes/reference/reactive-utilities/observable.mdx index f62b873bf..671cef0a8 100644 --- a/src/routes/reference/reactive-utilities/observable.mdx +++ b/src/routes/reference/reactive-utilities/observable.mdx @@ -1,13 +1,19 @@ --- title: observable -use_cases: 'rxjs integration, third-party observables, reactive streams, library interop' +use_cases: >- + rxjs integration, observable patterns, signal interop, third-party libraries, + reactive streams tags: - - rxjs - observables + - rxjs + - signals - integration + - reactive - streams - - interop version: '1.0' +description: >- + Convert SolidJS signals to Observables for seamless integration with RxJS and + other reactive libraries using the observable utility function. --- ```ts diff --git a/src/routes/reference/reactive-utilities/on-util.mdx b/src/routes/reference/reactive-utilities/on-util.mdx index 4994f7121..f364da0c8 100644 --- a/src/routes/reference/reactive-utilities/on-util.mdx +++ b/src/routes/reference/reactive-utilities/on-util.mdx @@ -1,15 +1,19 @@ --- title: 'on' use_cases: >- - explicit dependencies, performance optimization, conditional tracking, - fine-grained reactivity + explicit dependencies, effect control, conditional tracking, deferred + execution, store tracking tags: - effects - dependencies - - performance - tracking - - optimization + - stores + - reactive + - defer version: '1.0' +description: >- + Control effect dependencies explicitly with SolidJS's on utility. Define when + effects run and manage tracking behavior for precise reactivity. --- ```ts diff --git a/src/routes/reference/reactive-utilities/run-with-owner.mdx b/src/routes/reference/reactive-utilities/run-with-owner.mdx index 3a4760324..91d50b88f 100644 --- a/src/routes/reference/reactive-utilities/run-with-owner.mdx +++ b/src/routes/reference/reactive-utilities/run-with-owner.mdx @@ -1,14 +1,20 @@ --- title: runWithOwner order: 5 -use_cases: 'async operations, timeouts, callbacks, context access, memory management' +use_cases: >- + async operations, manual cleanup, context access, ownership control, + setTimeout callbacks, lifecycle management tags: - async - ownership - context - cleanup - - memory + - lifecycle + - effects version: '1.0' +description: >- + Execute code under a specific owner in SolidJS for proper cleanup and context + access, especially in async operations and setTimeout callbacks. --- ```ts diff --git a/src/routes/reference/reactive-utilities/split-props.mdx b/src/routes/reference/reactive-utilities/split-props.mdx index 78d1f72a3..91310091e 100644 --- a/src/routes/reference/reactive-utilities/split-props.mdx +++ b/src/routes/reference/reactive-utilities/split-props.mdx @@ -1,13 +1,18 @@ --- title: splitProps -use_cases: 'component composition, prop forwarding, component libraries, prop organization' +use_cases: >- + prop forwarding, component composition, prop separation, child components, + prop destructuring tags: - props - - composition - - forwarding - - organization - components + - composition + - destructuring + - reactive version: '1.0' +description: >- + Split reactive props objects by keys in SolidJS. Perfect for consuming + specific props while forwarding others to child components efficiently. --- ```ts diff --git a/src/routes/reference/reactive-utilities/start-transition.mdx b/src/routes/reference/reactive-utilities/start-transition.mdx index d35307152..731e550e2 100644 --- a/src/routes/reference/reactive-utilities/start-transition.mdx +++ b/src/routes/reference/reactive-utilities/start-transition.mdx @@ -1,13 +1,18 @@ --- title: startTransition -use_cases: 'async updates, performance optimization, ui transitions, batching' +use_cases: >- + async updates, performance optimization, non-blocking updates, transition + control tags: - transitions - async - performance + - updates - batching - - ui version: '1.0' +description: >- + Start transitions in SolidJS without pending state tracking. Batch async + updates for improved performance and smoother user interactions. --- ```ts diff --git a/src/routes/reference/reactive-utilities/untrack.mdx b/src/routes/reference/reactive-utilities/untrack.mdx index 1afb400ce..73d77452e 100644 --- a/src/routes/reference/reactive-utilities/untrack.mdx +++ b/src/routes/reference/reactive-utilities/untrack.mdx @@ -1,13 +1,19 @@ --- title: untrack -use_cases: 'performance optimization, breaking reactivity, static values, initial values' +use_cases: >- + static values, initial values, default props, performance optimization, + non-reactive access tags: - - performance - tracking - - optimization - - static + - performance + - props - reactivity + - optimization + - defaults version: '1.0' +description: >- + Prevent dependency tracking for static values in SolidJS. Optimize performance + by excluding non-updating props from reactive tracking scope. --- Ignores tracking any of the dependencies in the executing code block and returns the value. This helper is useful when a certain `prop` will never update and thus it is ok to use it outside of the tracking scope. diff --git a/src/routes/reference/reactive-utilities/use-transition.mdx b/src/routes/reference/reactive-utilities/use-transition.mdx index b071f08b5..b19f4082d 100644 --- a/src/routes/reference/reactive-utilities/use-transition.mdx +++ b/src/routes/reference/reactive-utilities/use-transition.mdx @@ -1,13 +1,19 @@ --- title: useTransition -use_cases: 'suspense boundaries, async operations, loading states, resource management' +use_cases: >- + async batching, loading states, suspense integration, concurrent updates, ui + transitions tags: - - suspense + - transitions - async + - suspense - loading - - transitions - - resources + - batching + - concurrent version: '1.0' +description: >- + Batch async updates with transitions in SolidJS. Track pending states and + defer commits until all async processes complete for smooth UI updates. --- ```ts diff --git a/src/routes/reference/rendering/dev.mdx b/src/routes/reference/rendering/dev.mdx index 3fe5937af..3258fd5a9 100644 --- a/src/routes/reference/rendering/dev.mdx +++ b/src/routes/reference/rendering/dev.mdx @@ -1,15 +1,18 @@ --- title: DEV use_cases: >- - development debugging, conditional code, library development, development - checks + development debugging, build optimization, library development, conditional + code, dev-only features tags: - development - debugging + - builds + - optimization - conditional - - libraries - - dev-mode version: '1.0' +description: >- + Access development-only features in SolidJS with the DEV export. Enable + additional checks and debugging tools that are removed in production. --- ```ts diff --git a/src/routes/reference/rendering/hydrate.mdx b/src/routes/reference/rendering/hydrate.mdx index 79abfe59c..f6c87b4fb 100644 --- a/src/routes/reference/rendering/hydrate.mdx +++ b/src/routes/reference/rendering/hydrate.mdx @@ -1,15 +1,18 @@ --- title: hydrate use_cases: >- - ssr applications, client-side hydration, server rendering, browser - initialization + ssr hydration, client initialization, server-rendered apps, spa startup, dom + rehydration tags: - - ssr - hydration - - client + - ssr - rendering - - browser + - initialization + - dom version: '1.0' +description: >- + Hydrate server-rendered HTML with SolidJS client-side code. Essential for + initializing SSR applications and attaching interactivity to static HTML. --- ```ts diff --git a/src/routes/reference/rendering/hydration-script.mdx b/src/routes/reference/rendering/hydration-script.mdx index fe83fdd2a..e555a88db 100644 --- a/src/routes/reference/rendering/hydration-script.mdx +++ b/src/routes/reference/rendering/hydration-script.mdx @@ -1,16 +1,18 @@ --- title: hydrationScript use_cases: >- - server-side rendering, hydration setup, initial page bootstrap, event replay - during hydration + ssr hydration, server-side rendering, initial page load optimization, + capturing events before js loads tags: - ssr - hydration - - bootstrap + - performance - events - - server - - client + - bootstrap version: '1.0' +description: >- + Bootstrap client-side hydration in SSR apps with HydrationScript. Capture and + replay events before JavaScript loads for seamless user experience. --- ```ts diff --git a/src/routes/reference/rendering/is-server.mdx b/src/routes/reference/rendering/is-server.mdx index 825edaa48..d9acbc88f 100644 --- a/src/routes/reference/rendering/is-server.mdx +++ b/src/routes/reference/rendering/is-server.mdx @@ -1,15 +1,18 @@ --- title: isServer use_cases: >- - conditional rendering, environment detection, bundle optimization, tree - shaking, server vs client logic + conditional rendering, ssr vs client code, bundle optimization, + environment-specific logic, code splitting tags: + - ssr - environment - - conditional - bundling - - tree-shaking - optimization + - conditional version: '1.0' +description: >- + Detect server or browser environment with isServer. Optimize bundle sizes by + conditionally including code for specific runtime environments. --- ```ts diff --git a/src/routes/reference/rendering/render-to-stream.mdx b/src/routes/reference/rendering/render-to-stream.mdx index 76549ee76..bd4b9903a 100644 --- a/src/routes/reference/rendering/render-to-stream.mdx +++ b/src/routes/reference/rendering/render-to-stream.mdx @@ -1,16 +1,18 @@ --- title: renderToStream use_cases: >- - streaming ssr, progressive rendering, suspense boundaries, performance - optimization, large applications + streaming ssr, progressive rendering, async data loading, suspense boundaries, + large page optimization tags: - - streaming - ssr + - streaming + - async - suspense - performance - - async - - server version: '1.0' +description: >- + Stream HTML progressively with renderToStream. Render content synchronously + then stream async resources as they complete for faster loading. --- ```ts diff --git a/src/routes/reference/rendering/render-to-string-async.mdx b/src/routes/reference/rendering/render-to-string-async.mdx index 82cf48b16..2c7e02d79 100644 --- a/src/routes/reference/rendering/render-to-string-async.mdx +++ b/src/routes/reference/rendering/render-to-string-async.mdx @@ -1,16 +1,18 @@ --- title: renderToStringAsync use_cases: >- - ssr with async data, suspense resolution, data serialization, complete html - generation + ssr with async data, suspense resolution, complete page rendering, data + serialization, seo optimization tags: - ssr - async - suspense - serialization - - server - - data-fetching + - rendering version: '1.0' +description: >- + Render complete HTML with async data using renderToStringAsync. Waits for all + Suspense boundaries before returning serialized results. --- ```ts diff --git a/src/routes/reference/rendering/render-to-string.mdx b/src/routes/reference/rendering/render-to-string.mdx index 6a5f211b6..9af70f6f1 100644 --- a/src/routes/reference/rendering/render-to-string.mdx +++ b/src/routes/reference/rendering/render-to-string.mdx @@ -1,15 +1,18 @@ --- title: renderToString use_cases: >- - synchronous ssr, static site generation, simple server rendering, progressive - hydration setup + basic ssr, static site generation, synchronous rendering, progressive + hydration, seo pages tags: - ssr - - static - - synchronous + - rendering - hydration - - server + - synchronous + - static version: '1.0' +description: >- + Generate HTML strings synchronously with renderToString. Perfect for SSR with + progressive hydration and static site generation needs. --- ```ts diff --git a/src/routes/reference/rendering/render.mdx b/src/routes/reference/rendering/render.mdx index fc5cfdaeb..f4234bbd2 100644 --- a/src/routes/reference/rendering/render.mdx +++ b/src/routes/reference/rendering/render.mdx @@ -1,15 +1,19 @@ --- title: render use_cases: >- - client-side rendering, spa setup, browser entry point, component mounting, - always + app initialization, mounting components, spa entry point, client-side + rendering, dom manipulation tags: - - client - - spa - mounting - - browser - - entry-point + - initialization + - spa + - dom + - client + - entry version: '1.0' +description: >- + Mount your Solid app to the DOM with render. The essential browser entry point + for initializing and disposing client-side applications. --- ```ts diff --git a/src/routes/reference/secondary-primitives/create-computed.mdx b/src/routes/reference/secondary-primitives/create-computed.mdx index d6f24d9a7..90b602693 100644 --- a/src/routes/reference/secondary-primitives/create-computed.mdx +++ b/src/routes/reference/secondary-primitives/create-computed.mdx @@ -2,14 +2,17 @@ title: createComputed use_cases: >- immediate reactivity, building primitives, side effects with dependencies, - advanced reactive patterns + reactive updates, custom reactive patterns tags: - reactivity + - computation - primitives - - side-effects + - effects - tracking - - advanced version: '1.0' +description: >- + Create immediate reactive computations with createComputed. Build custom + primitives and handle side effects that respond to dependencies. --- ```ts diff --git a/src/routes/reference/secondary-primitives/create-deferred.mdx b/src/routes/reference/secondary-primitives/create-deferred.mdx index 472919f3e..b62280db0 100644 --- a/src/routes/reference/secondary-primitives/create-deferred.mdx +++ b/src/routes/reference/secondary-primitives/create-deferred.mdx @@ -1,15 +1,18 @@ --- title: createDeferred use_cases: >- - performance optimization, debounced updates, idle time processing, expensive - computations + performance optimization, idle updates, non-critical ui updates, debouncing + changes, reducing re-renders tags: - performance - - debounce - - idle - optimization - - expensive-operations + - deferred + - idle + - updates version: '1.0' +description: >- + Defer reactive updates until browser idle with createDeferred. Optimize + performance by batching non-critical changes with timeout control. --- ```ts diff --git a/src/routes/reference/secondary-primitives/create-reaction.mdx b/src/routes/reference/secondary-primitives/create-reaction.mdx index 88761a0bb..2317cfc01 100644 --- a/src/routes/reference/secondary-primitives/create-reaction.mdx +++ b/src/routes/reference/secondary-primitives/create-reaction.mdx @@ -1,15 +1,18 @@ --- title: createReaction use_cases: >- - separating tracking from execution, one-time reactions, custom reactive - patterns, advanced control + custom tracking logic, one-time reactions, separating tracking from execution, + advanced reactive patterns tags: + - reactivity - tracking - - one-time - - custom-patterns + - custom + - effects - advanced - - separation version: '1.0' +description: >- + Separate tracking from execution with createReaction. Create one-time reactive + side effects that run on first dependency change only. --- ```ts diff --git a/src/routes/reference/secondary-primitives/create-render-effect.mdx b/src/routes/reference/secondary-primitives/create-render-effect.mdx index 85b257b4d..0c5083f14 100644 --- a/src/routes/reference/secondary-primitives/create-render-effect.mdx +++ b/src/routes/reference/secondary-primitives/create-render-effect.mdx @@ -1,15 +1,19 @@ --- title: createRenderEffect use_cases: >- - dom manipulation during rendering, immediate effects, ref setup, rendering - phase side effects + dom manipulation during render, immediate effects, rendering phase logic, + ref-independent effects, custom rendering tags: - - dom - rendering + - effects + - dom - immediate - refs - - side-effects + - lifecycle version: '1.0' +description: >- + Execute effects immediately during rendering with createRenderEffect. Run side + effects as DOM creates, before refs are set or connected. --- ```ts diff --git a/src/routes/reference/secondary-primitives/create-selector.mdx b/src/routes/reference/secondary-primitives/create-selector.mdx index 5ad1af02f..f258ab131 100644 --- a/src/routes/reference/secondary-primitives/create-selector.mdx +++ b/src/routes/reference/secondary-primitives/create-selector.mdx @@ -1,16 +1,18 @@ --- title: createSelector use_cases: >- - optimizing lists with selection state, active items in menus, tabs, toggles, - performance optimization for large lists + selection states, active items, dropdown menus, tab navigation, list + highlighting, performance optimization tags: - - selection - - optimization - - lists + - reactivity - performance + - selection - ui-state - - derived-signals + - optimization version: '1.0' +description: >- + Optimize selection state with createSelector. Reduce DOM updates from n to 2 + when tracking active items in lists, tabs, or dropdowns. --- ```ts diff --git a/src/routes/reference/server-utilities/get-request-event.mdx b/src/routes/reference/server-utilities/get-request-event.mdx index a7ceb023d..32af8e61c 100644 --- a/src/routes/reference/server-utilities/get-request-event.mdx +++ b/src/routes/reference/server-utilities/get-request-event.mdx @@ -1,17 +1,19 @@ --- title: getRequestEvent use_cases: >- - server-side rendering, accessing request headers, authentication, cookies, - response modification, server functions + server-side rendering, authentication, headers manipulation, cookies, server + functions, request context access tags: - - server-side - - requests + - server + - ssr + - request - headers - authentication - - ssr - - server-functions - - cookies + - context version: '1.0' +description: >- + Access server request context with getRequestEvent. Read headers, set cookies, + and manage response status in SSR and server functions. --- Solid uses Async Local Storage as a way of injecting the request context anywhere on the server. diff --git a/src/routes/reference/store-utilities/create-mutable.mdx b/src/routes/reference/store-utilities/create-mutable.mdx index 1dd111970..df4903b79 100644 --- a/src/routes/reference/store-utilities/create-mutable.mdx +++ b/src/routes/reference/store-utilities/create-mutable.mdx @@ -1,16 +1,18 @@ --- title: createMutable use_cases: >- - integrating external systems, framework compatibility with mobx or vue, legacy - code migration, third-party libraries + mobx migration, vue compatibility, external system integration, mutable state + patterns, proxy-based reactivity tags: - - external-integration + - store + - mutable + - proxy + - state - compatibility - - migration - - mutable-state - - third-party - - legacy version: '1.0' +description: >- + Create mutable proxy stores with automatic deep tracking. Ideal for MobX/Vue + compatibility or integrating external mutable systems. --- `createMutable` creates a new mutable Store proxy object that provides a way to selectively trigger updates only when values change. diff --git a/src/routes/reference/store-utilities/create-store.mdx b/src/routes/reference/store-utilities/create-store.mdx index 341c39007..a114bf9ab 100644 --- a/src/routes/reference/store-utilities/create-store.mdx +++ b/src/routes/reference/store-utilities/create-store.mdx @@ -1,16 +1,18 @@ --- title: createStore use_cases: >- - complex state management, nested data structures, objects and arrays, - application state, user data management + complex state management, nested data, arrays and objects, derived values, + application state tags: - - state-management - - nested-data + - store + - state + - data-structures - objects - arrays - - application-state - - user-data version: '1.0' +description: >- + Manage complex application state with createStore. Handle nested objects, + arrays, and derived values with fine-grained reactivity. --- Stores were intentionally designed to manage data structures like objects and arrays but are capable of handling other data types, such as strings and numbers. diff --git a/src/routes/reference/store-utilities/modify-mutable.mdx b/src/routes/reference/store-utilities/modify-mutable.mdx index fc54dc90e..fb3d982a2 100644 --- a/src/routes/reference/store-utilities/modify-mutable.mdx +++ b/src/routes/reference/store-utilities/modify-mutable.mdx @@ -1,15 +1,18 @@ --- title: modifyMutable use_cases: >- - batching multiple mutable store changes, performance optimization for multiple - updates, reducing ui re-renders + batch updates, mutable store modifications, performance optimization, multiple + field changes, reconciliation tags: - - batching + - store + - mutable + - batch - performance - - multiple-updates - - mutable-stores - - optimization + - updates version: '1.0' +description: >- + Batch multiple mutable store changes with modifyMutable. Update multiple + fields in one render cycle for better performance. --- `modifyMutable` streamlines the process of making multiple changes to a mutable Store, as obtained through the use of [`createMutable`](/reference/store-utilities/create-mutable). diff --git a/src/routes/reference/store-utilities/produce.mdx b/src/routes/reference/store-utilities/produce.mdx index 460399ad3..d7d080885 100644 --- a/src/routes/reference/store-utilities/produce.mdx +++ b/src/routes/reference/store-utilities/produce.mdx @@ -1,14 +1,18 @@ --- title: produce use_cases: >- - immutable-style mutations, complex store updates, nested object modifications, - immer-like patterns + immutable updates, immer-style mutations, store modifications, complex state + changes, nested updates tags: - - immutable-mutations - - nested-updates - - immer-pattern - - store-utilities + - store + - immutable + - updates + - immer + - mutations version: '1.0' +description: >- + Use Immer-inspired produce API to mutate Solid stores immutably. Simplify + complex nested updates with familiar mutation syntax. --- `produce` is an [Immer](https://immerjs.github.io/immer/) inspired API for Solid's Store objects that allows the store to be mutated inside the `produce` function. diff --git a/src/routes/reference/store-utilities/reconcile.mdx b/src/routes/reference/store-utilities/reconcile.mdx index c48f3fa18..345356f33 100644 --- a/src/routes/reference/store-utilities/reconcile.mdx +++ b/src/routes/reference/store-utilities/reconcile.mdx @@ -1,15 +1,18 @@ --- title: reconcile use_cases: >- - handling api responses, immutable data updates, large data changes, external - data synchronization, diffing data + api responses, data synchronization, immutable data diffing, observable + subscriptions, large data updates tags: - - api-responses - - data-diffing - - immutable-data + - store + - diffing + - api - synchronization - - large-updates + - immutable version: '1.0' +description: >- + Efficiently diff and merge data changes with reconcile. Perfect for syncing + API responses or handling immutable data updates. --- `reconcile` is designed for diffing data changes in situations where granular updates cannot be applied. diff --git a/src/routes/reference/store-utilities/unwrap.mdx b/src/routes/reference/store-utilities/unwrap.mdx index 5442c58e1..6e610bfee 100644 --- a/src/routes/reference/store-utilities/unwrap.mdx +++ b/src/routes/reference/store-utilities/unwrap.mdx @@ -1,15 +1,18 @@ --- title: unwrap use_cases: >- - accessing raw store data, debugging, serialization, third-party library - integration, data inspection + raw data access, proxy removal, debugging, third-party integration, data + serialization tags: + - store + - proxy + - data - debugging - - serialization - - raw-data - - inspection - - third-party + - utilities version: '1.0' +description: >- + Extract raw data from Solid stores without proxy wrapping. Essential for + debugging, serialization, or third-party integrations. --- `unwrap` returns the underlying data in the store without a proxy. diff --git a/src/routes/solid-meta/getting-started/client-setup.mdx b/src/routes/solid-meta/getting-started/client-setup.mdx index b51889340..03b628c4d 100644 --- a/src/routes/solid-meta/getting-started/client-setup.mdx +++ b/src/routes/solid-meta/getting-started/client-setup.mdx @@ -2,15 +2,18 @@ title: Client setup order: 2 use_cases: >- - client-side meta tags, spa head management, dynamic title and meta changes, - browser-only applications + seo, meta tags, document head management, social media tags, page titles, + canonical urls tags: - - meta-tags - - head-management - - client-side - - spa - - browser-apps + - meta + - seo + - head + - client + - tags version: '1.0' +description: >- + Manage document head tags in Solid apps. Add titles, meta tags, and links + dynamically for better SEO and social media sharing. --- You can inject a tag into the `` by rendering one of the head tag components when necessary. diff --git a/src/routes/solid-meta/getting-started/installation-and-setup.mdx b/src/routes/solid-meta/getting-started/installation-and-setup.mdx index 725c35ee6..304c6af61 100644 --- a/src/routes/solid-meta/getting-started/installation-and-setup.mdx +++ b/src/routes/solid-meta/getting-started/installation-and-setup.mdx @@ -2,16 +2,18 @@ title: Install and configure order: 1 use_cases: >- - setting up meta tags, initial project configuration, seo requirements, head - tag management setup + initial setup, meta tags configuration, seo setup, head management setup, ssr + meta tags tags: - setup - installation + - meta - configuration - - meta-tags - seo - - head-management version: '1.0' +description: >- + Install and configure @solidjs/meta for head tag management. Set up dynamic + titles, meta tags, and SEO optimization in Solid apps. --- :::note[Prerequisites] diff --git a/src/routes/solid-meta/getting-started/server-setup.mdx b/src/routes/solid-meta/getting-started/server-setup.mdx index c2d2e59e7..d03ee6ad6 100644 --- a/src/routes/solid-meta/getting-started/server-setup.mdx +++ b/src/routes/solid-meta/getting-started/server-setup.mdx @@ -1,14 +1,20 @@ --- title: Server setup order: 3 -use_cases: 'ssr applications, server rendering, head tag management, metaprovider setup' +use_cases: >- + ssr setup, server rendering, meta tags on server, seo optimization, initial + page load tags: - ssr - - server-rendering - - meta-tags - - head-management + - server + - meta + - seo - setup + - rendering version: '1.0' +description: >- + Configure server-side rendering for Solid Meta tags with MetaProvider. Learn + to properly inject head tags in SSR for optimal SEO and performance. --- For server setup, wrap your application with [`MetaProvider`](/solid-meta/reference/meta/metaprovider) on the server. diff --git a/src/routes/solid-meta/index.mdx b/src/routes/solid-meta/index.mdx index e4212ef06..61137e8d6 100644 --- a/src/routes/solid-meta/index.mdx +++ b/src/routes/solid-meta/index.mdx @@ -2,15 +2,18 @@ title: Overview mainNavExclude: true use_cases: >- - document head management, meta tag organization, ssr-ready applications, - asynchronous rendering + managing head tags, seo optimization, document metadata, dynamic meta tags, + ssr meta management tags: - - meta-tags - - head-management + - meta + - head + - seo - ssr - - document-head - overview version: '1.0' +description: >- + Solid Meta provides asynchronous SSR-ready document head management. Define + meta tags at any component level for flexible SEO and metadata control. --- # Overview diff --git a/src/routes/solid-meta/reference/meta/base.mdx b/src/routes/solid-meta/reference/meta/base.mdx index 42a74e2bf..01d9f561f 100644 --- a/src/routes/solid-meta/reference/meta/base.mdx +++ b/src/routes/solid-meta/reference/meta/base.mdx @@ -1,13 +1,19 @@ --- title: Base order: 5 -use_cases: 'setting base url for relative links, document base element configuration' +use_cases: >- + setting base url, relative urls, external resources, multi-page apps, cdn + assets tags: - - base-url - - relative-urls - - meta-tags - - document-head + - base + - url + - meta + - head + - routing version: '1.0' +description: >- + Set the base URL for all relative URLs in your Solid app with the Base + component. Essential for apps with complex routing or external resources. --- `Base` is a component that specifies the base URL for all relative URLs in the document. diff --git a/src/routes/solid-meta/reference/meta/link.mdx b/src/routes/solid-meta/reference/meta/link.mdx index 5de75f392..917059fd7 100644 --- a/src/routes/solid-meta/reference/meta/link.mdx +++ b/src/routes/solid-meta/reference/meta/link.mdx @@ -1,16 +1,18 @@ --- title: Link order: 2 -use_cases: >- - adding favicons, linking stylesheets, external resource connections, emoji - favicons +use_cases: 'adding favicon, stylesheets, external resources, preloading assets, web fonts' tags: + - link - favicon - - stylesheets - - external-resources - - meta-tags + - stylesheet - assets + - head + - resources version: '1.0' +description: >- + Add external resources like stylesheets and favicons to your Solid app. Learn + to use the Link component for optimal resource loading and icons. --- The Link component establishes a connection between the page and an external resource. diff --git a/src/routes/solid-meta/reference/meta/meta.mdx b/src/routes/solid-meta/reference/meta/meta.mdx index b1564bbac..3574132b9 100644 --- a/src/routes/solid-meta/reference/meta/meta.mdx +++ b/src/routes/solid-meta/reference/meta/meta.mdx @@ -2,16 +2,19 @@ title: Meta order: 3 use_cases: >- - seo metadata, page descriptions, viewport settings, charset configuration, - meta tag management + seo optimization, social media tags, viewport settings, charset configuration, + open graph tags: + - meta - seo - - metadata - viewport - - charset - - meta-tags - - page-description + - metadata + - head + - tags version: '1.0' +description: >- + Add SEO and viewport metadata to your Solid app with the Meta component. + Configure description, keywords, and social media tags for better reach. --- The `` component represents metadata that cannot be represented by other HTML elements. diff --git a/src/routes/solid-meta/reference/meta/metaprovider.mdx b/src/routes/solid-meta/reference/meta/metaprovider.mdx index 98f025fbf..dc86d8d8b 100644 --- a/src/routes/solid-meta/reference/meta/metaprovider.mdx +++ b/src/routes/solid-meta/reference/meta/metaprovider.mdx @@ -1,13 +1,20 @@ --- title: MetaProvider order: 6 -use_cases: 'always, any project using meta components, wrapping metadata components' +use_cases: >- + initializing meta tags, wrapping app, head management setup, meta context, + always in meta apps tags: - - meta-provider - - wrapper-component - - meta-tags + - provider + - meta - setup + - context + - wrapper + - head version: '1.0' +description: >- + MetaProvider wraps your Solid app to enable head tag management. Essential + parent component for all metadata components to function properly. --- `MetaProvider` is a parent component responsible for wrapping all the metadata components. diff --git a/src/routes/solid-meta/reference/meta/style.mdx b/src/routes/solid-meta/reference/meta/style.mdx index d08a6c6ba..d95ce239d 100644 --- a/src/routes/solid-meta/reference/meta/style.mdx +++ b/src/routes/solid-meta/reference/meta/style.mdx @@ -1,14 +1,17 @@ --- title: Style order: 4 -use_cases: 'inline css styles, global styling, dynamic styles in head' +use_cases: 'inline styles, critical css, theme styles, dynamic styling, css-in-js' tags: - - inline-styles + - style - css + - inline - styling - - meta-tags - - global-styles + - head version: '1.0' +description: >- + Add inline CSS styles to your Solid app's head with the Style component. + Useful for critical CSS and dynamic styling needs in your application. --- `Style` is a component that adds the [`style`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/style) element to your document's `head`. diff --git a/src/routes/solid-meta/reference/meta/title.mdx b/src/routes/solid-meta/reference/meta/title.mdx index 5f7524abe..19399de75 100644 --- a/src/routes/solid-meta/reference/meta/title.mdx +++ b/src/routes/solid-meta/reference/meta/title.mdx @@ -1,14 +1,19 @@ --- title: Title order: 1 -use_cases: 'page titles, browser tab names, seo titles, document title management' +use_cases: >- + page titles, seo optimization, browser tab text, dynamic titles, navigation + context tags: - - page-title - - browser-tab + - title - seo - - document-title - - meta-tags + - head + - meta + - browser version: '1.0' +description: >- + Set dynamic page titles in your Solid app with the Title component. Essential + for SEO and providing context in browser tabs and bookmarks. --- `Title` is a component that renders the [`title`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title) element. diff --git a/src/routes/solid-router/advanced-concepts/lazy-loading.mdx b/src/routes/solid-router/advanced-concepts/lazy-loading.mdx index 9f8872835..d2c9539ae 100644 --- a/src/routes/solid-router/advanced-concepts/lazy-loading.mdx +++ b/src/routes/solid-router/advanced-concepts/lazy-loading.mdx @@ -1,15 +1,19 @@ --- title: Lazy loading use_cases: >- - optimizing bundle size, code splitting, large applications, reducing initial - load time + optimizing bundle size, code splitting, reducing initial load, large apps, + performance optimization tags: - - lazy-loading - - code-splitting + - lazy - performance - - bundle-optimization - routing + - optimization + - splitting + - loading version: '1.0' +description: >- + Implement lazy loading in Solid Router to reduce initial bundle size. Load + components on-demand for better performance in large applications. --- Lazy loading allows you to load only the necessary resources when they are needed. diff --git a/src/routes/solid-router/concepts/actions.mdx b/src/routes/solid-router/concepts/actions.mdx index 26fba9b4b..25c09e7bc 100644 --- a/src/routes/solid-router/concepts/actions.mdx +++ b/src/routes/solid-router/concepts/actions.mdx @@ -1,16 +1,20 @@ --- title: Actions use_cases: >- - form submissions, data mutations, server communication, user interactions, - post requests + form submissions, data mutations, server communication, user input handling, + api calls, crud operations tags: + - actions - forms - - data-submission - - server-communication - - user-input + - data + - api + - server + - submission - mutations - - post-requests version: '1.0' +description: >- + Handle form submissions and server mutations with Solid Router actions. Build + isomorphic data flows with progressive enhancement support. --- When developing applications, it is common to need to communicate new information to the server based on user interactions. diff --git a/src/routes/solid-router/concepts/alternative-routers.mdx b/src/routes/solid-router/concepts/alternative-routers.mdx index fbbc4b75a..be5529d58 100644 --- a/src/routes/solid-router/concepts/alternative-routers.mdx +++ b/src/routes/solid-router/concepts/alternative-routers.mdx @@ -1,16 +1,19 @@ --- title: Alternative routers use_cases: >- - client-only routing, testing environments, legacy browser support, offline - applications, special url requirements + single-page apps without server routing, legacy hash-based urls, testing + router logic, client-only navigation tags: - - hash-routing - - memory-routing - - testing + - hash-mode + - memory-mode - client-side - - url-handling - - browser-compatibility + - testing + - spa + - routing version: '1.0' +description: >- + Learn to use hash-based and memory routers in SolidJS for client-side + navigation and testing without server interaction. --- While the default router uses the browser's `location.pathname` to determine the current route, you can use alternative routers to change this behavior. diff --git a/src/routes/solid-router/concepts/catch-all.mdx b/src/routes/solid-router/concepts/catch-all.mdx index d2fd82052..5747f2a80 100644 --- a/src/routes/solid-router/concepts/catch-all.mdx +++ b/src/routes/solid-router/concepts/catch-all.mdx @@ -1,15 +1,18 @@ --- title: Catch-all routes use_cases: >- - 404 pages, error handling, invalid urls, fallback routes, page not found - scenarios + 404 pages, handling invalid urls, fallback routes, error boundaries, redirect + unknown paths tags: - - 404-pages - - error-handling - - fallback-routes - - wildcard-routes - - url-matching + - '404' + - error-pages + - fallback + - routing + - wildcards version: '1.0' +description: >- + Create catch-all routes in SolidJS to handle 404 errors and redirect users + from invalid URLs to proper fallback pages. --- Catch-all routes are used to match any URL that does not match any other route in the application. diff --git a/src/routes/solid-router/concepts/dynamic-routes.mdx b/src/routes/solid-router/concepts/dynamic-routes.mdx index 81d9f8b7a..89db7b896 100644 --- a/src/routes/solid-router/concepts/dynamic-routes.mdx +++ b/src/routes/solid-router/concepts/dynamic-routes.mdx @@ -1,16 +1,18 @@ --- title: Dynamic routes use_cases: >- - user profiles, product pages, blog posts, detail views, parameterized urls, - variable content + user profiles, product pages, blog posts, id-based content, variable urls, + data-driven pages tags: - - dynamic-routing - - url-parameters - - user-profiles - - detail-pages + - dynamic + - parameters - validation - wildcards + - routing version: '1.0' +description: >- + Build dynamic routes with parameters in SolidJS for user profiles, products, + and content that changes based on URL values. --- When a path is unknown ahead of time, it can be treated as a flexible parameter that is passed on to the component: diff --git a/src/routes/solid-router/concepts/layouts.mdx b/src/routes/solid-router/concepts/layouts.mdx index ab4b6b142..7a5b94113 100644 --- a/src/routes/solid-router/concepts/layouts.mdx +++ b/src/routes/solid-router/concepts/layouts.mdx @@ -1,17 +1,18 @@ --- title: Layouts use_cases: >- - consistent navigation, shared headers/footers, page structure, common ui - elements, app-wide components + consistent headers/footers, shared navigation, admin panels, dashboard + layouts, nested ui structure tags: - layouts - - page-structure - - navigation - - headers - - footers - - ui-consistency - nesting + - ui-structure + - components + - routing version: '1.0' +description: >- + Create consistent page layouts in SolidJS with shared headers, footers, and + nested structures for better UI organization. --- To maintain consistency across an application's page you can use layouts. diff --git a/src/routes/solid-router/concepts/navigation.mdx b/src/routes/solid-router/concepts/navigation.mdx index 86dc3d4f7..f2ba17824 100644 --- a/src/routes/solid-router/concepts/navigation.mdx +++ b/src/routes/solid-router/concepts/navigation.mdx @@ -1,16 +1,18 @@ --- title: Navigation use_cases: >- - page transitions, user navigation, programmatic routing, form submissions, - login flows, redirects + page transitions, programmatic routing, user actions, form submissions, + authentication flows, redirects tags: - navigation - - page-transitions - - programmatic-routing - links - redirects - - user-flow + - routing + - programmatic version: '1.0' +description: >- + Navigate between routes in SolidJS using links, programmatic navigation, and + redirects for seamless user experiences. --- When using Solid Router, you can use the standard standard HTML [`` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a), which triggers [soft navigation](/solid-router/reference/components/a#soft-navigation). diff --git a/src/routes/solid-router/concepts/nesting.mdx b/src/routes/solid-router/concepts/nesting.mdx index 55c96c4ba..9e2c1b930 100644 --- a/src/routes/solid-router/concepts/nesting.mdx +++ b/src/routes/solid-router/concepts/nesting.mdx @@ -1,16 +1,18 @@ --- title: Nesting routes use_cases: >- - hierarchical pages, admin panels, dashboard sections, multi-level navigation, - organized routes + hierarchical pages, parent-child relationships, shared layouts, complex + routing structures, admin sections tags: - - nested-routes - - route-hierarchy - - admin-panels - - dashboards - - multi-level - - config-routing + - nesting + - hierarchy + - routing + - layouts + - config version: '1.0' +description: >- + Build nested route hierarchies in SolidJS for complex applications with + parent-child relationships and shared layouts. --- Nested routes are a way to create a hierarchy of routes in your application. diff --git a/src/routes/solid-router/concepts/path-parameters.mdx b/src/routes/solid-router/concepts/path-parameters.mdx index bb9a141f4..956e9379f 100644 --- a/src/routes/solid-router/concepts/path-parameters.mdx +++ b/src/routes/solid-router/concepts/path-parameters.mdx @@ -1,16 +1,18 @@ --- title: Path parameters use_cases: >- - dynamic content, user ids, product details, blog posts, flexible routing, - data-driven pages + dynamic content, user profiles, resource ids, filtering data, validation, + flexible routing tags: - - path-parameters - - dynamic-content - - url-params + - parameters - validation - - optional-params + - dynamic - wildcards + - routing version: '1.0' +description: >- + Capture and validate dynamic URL parameters in SolidJS routes for flexible + content display and data-driven pages. --- Parameters within a route are used to capture dynamic values from the URL. diff --git a/src/routes/solid-router/concepts/search-parameters.mdx b/src/routes/solid-router/concepts/search-parameters.mdx index addd03600..d3f964bf0 100644 --- a/src/routes/solid-router/concepts/search-parameters.mdx +++ b/src/routes/solid-router/concepts/search-parameters.mdx @@ -1,16 +1,18 @@ --- title: Search parameters use_cases: >- - filtering, pagination, search results, form state, query strings, url state - management + filtering, pagination, search queries, form state in url, shareable urls, + stateful navigation tags: - - search-parameters - - query-strings - - filtering - - pagination - - url-state - - form-data + - query-params + - search + - state + - url + - routing version: '1.0' +description: >- + Manage query strings and search parameters in SolidJS for filtering, + pagination, and maintaining state in the URL. --- Search parameters are used to pass data to a route using the query string. diff --git a/src/routes/solid-router/getting-started/component.mdx b/src/routes/solid-router/getting-started/component.mdx index a7b5bd0be..5207f3aa7 100644 --- a/src/routes/solid-router/getting-started/component.mdx +++ b/src/routes/solid-router/getting-started/component.mdx @@ -1,15 +1,18 @@ --- title: Component routing use_cases: >- - basic routing setup, simple applications, jsx routing, getting started, - straightforward route definitions + defining routes, jsx routing, template-based routing, initial setup, basic + navigation tags: - - jsx-routing - - basic-setup - - route-definition - - getting-started - - simple-routing + - jsx + - components + - routing + - setup + - templates version: '1.0' +description: >- + Define routes using JSX components in SolidJS Router for intuitive, + template-based routing in your applications. --- In Solid Router, routes can be defined directly in an application's template using JSX. diff --git a/src/routes/solid-router/getting-started/config.mdx b/src/routes/solid-router/getting-started/config.mdx index d85ba4f7c..1df61cdd8 100644 --- a/src/routes/solid-router/getting-started/config.mdx +++ b/src/routes/solid-router/getting-started/config.mdx @@ -1,16 +1,18 @@ --- title: Config-based routing use_cases: >- - complex routing, lazy loading, large applications, organized route - definitions, performance optimization + centralized routing, lazy loading, config-based setup, dynamic imports, + performance optimization tags: - - config-routing + - config - lazy-loading + - routing - performance - - route-organization - - large-apps - - code-splitting + - setup version: '1.0' +description: >- + Configure SolidJS routes with config objects for centralized routing, lazy + loading, and optimized performance. --- Solid Router supports config-based routing, which offers the same capabilities as [component routing](/solid-router/getting-started/component). diff --git a/src/routes/solid-router/getting-started/installation-and-setup.mdx b/src/routes/solid-router/getting-started/installation-and-setup.mdx index 0a0c6a5a7..687bddd13 100644 --- a/src/routes/solid-router/getting-started/installation-and-setup.mdx +++ b/src/routes/solid-router/getting-started/installation-and-setup.mdx @@ -1,16 +1,19 @@ --- title: Installation and setup use_cases: >- - starting new spa project, setting up client-side routing, single-page - applications, initial project configuration + starting new project, initial setup, configuring routing, spa applications, + client-side routing tags: - - installation - setup + - installation - configuration - spa + - routing - getting-started - - routing-setup version: '1.0' +description: >- + 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. --- Solid Router is the universal router for Solid which works for rendering on the client or the server. diff --git a/src/routes/solid-router/getting-started/linking-routes.mdx b/src/routes/solid-router/getting-started/linking-routes.mdx index 84111c1f6..4e794b237 100644 --- a/src/routes/solid-router/getting-started/linking-routes.mdx +++ b/src/routes/solid-router/getting-started/linking-routes.mdx @@ -1,16 +1,19 @@ --- title: Linking routes use_cases: >- - navigation between pages, creating menu systems, building nav bars, linking - components, page transitions + navigation between pages, creating menu bars, active link styling, internal + linking, user navigation tags: - navigation - - linking - - menu - - navbar - - page-transitions + - links + - anchors - active-states + - menu + - ui version: '1.0' +description: >- + Create navigation links between routes using anchor tags and the A component + with active state styling and automatic base path handling. --- Once routes have been created within an application, using anchor tags will help users navigate between different views or pages. diff --git a/src/routes/solid-router/guides/migration.mdx b/src/routes/solid-router/guides/migration.mdx index fd5bd1d16..1fda77564 100644 --- a/src/routes/solid-router/guides/migration.mdx +++ b/src/routes/solid-router/guides/migration.mdx @@ -1,16 +1,19 @@ --- title: Migration from v0.9.x use_cases: >- - upgrading from v0.9 to v0.10, breaking changes, legacy code migration, api - updates, refactoring existing router code + upgrading from v0.9, breaking changes, api migration, updating legacy code, + version upgrade tags: - migration - upgrade - breaking-changes - - legacy - - refactoring - v0.10 + - api-changes + - legacy version: '1.0' +description: >- + Migrate your Solid Router application to v0.10 with this comprehensive guide + covering removed APIs, new patterns, and Islands support changes. --- v0.10.0 brings some big changes to support the future of routing including Islands/Partial Hydration hybrid solutions. diff --git a/src/routes/solid-router/index.mdx b/src/routes/solid-router/index.mdx index b3bcc3289..a970c8223 100644 --- a/src/routes/solid-router/index.mdx +++ b/src/routes/solid-router/index.mdx @@ -1,16 +1,19 @@ --- title: Overview use_cases: >- - understanding router basics, spa fundamentals, getting started overview, - routing concepts introduction + understanding routing, learning basics, overview needed, getting started, spa + routing concepts tags: - overview - introduction - basics - spa - - routing-concepts - - getting-started + - routing + - concepts version: '1.0' +description: >- + Solid Router is the universal routing solution for Solid applications, + enabling client and server-side navigation in single-page applications. --- # Overview diff --git a/src/routes/solid-router/reference/components/a.mdx b/src/routes/solid-router/reference/components/a.mdx index 15bc83f53..87f03d7b5 100644 --- a/src/routes/solid-router/reference/components/a.mdx +++ b/src/routes/solid-router/reference/components/a.mdx @@ -1,16 +1,19 @@ --- title: A use_cases: >- - creating navigation links, active link styling, relative navigation, base path - support, soft navigation + creating navigation links, active link styling, soft navigation, relative + paths, menu items tags: - - links + - component - navigation + - links - active-states - - styling - - relative-paths + - anchors - soft-navigation version: '1.0' +description: >- + The A component provides enhanced anchor tags with automatic base path + support, active states, and soft navigation for better user experience. --- Solid Router exposes the `` component as a wrapper around the [native anchor tag ](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a). diff --git a/src/routes/solid-router/reference/components/hash-router.mdx b/src/routes/solid-router/reference/components/hash-router.mdx index ca16200ca..7dbd099cd 100644 --- a/src/routes/solid-router/reference/components/hash-router.mdx +++ b/src/routes/solid-router/reference/components/hash-router.mdx @@ -1,15 +1,19 @@ --- title: HashRouter use_cases: >- - static file hosting, github pages deployment, no server routing, single html - file apps, client-only routing + static file hosting, single html file apps, no server routing, github pages, + static deployment tags: - hash-routing - static-hosting - client-side - - github-pages - - single-file + - spa + - deployment + - component version: '1.0' +description: >- + HashRouter enables client-side routing using URL hash values, perfect for + static file hosting where server-side routing isn't available. --- The `HashRouter` is a top level component that manages the routing of your application. diff --git a/src/routes/solid-router/reference/components/memory-router.mdx b/src/routes/solid-router/reference/components/memory-router.mdx index becca4145..fd4dd6925 100644 --- a/src/routes/solid-router/reference/components/memory-router.mdx +++ b/src/routes/solid-router/reference/components/memory-router.mdx @@ -1,15 +1,19 @@ --- title: MemoryRouter use_cases: >- - testing routing logic, controlling navigation history, testing environments, - custom navigation flows + testing routing, controlled navigation, internal history, unit tests, + programmatic routing tags: - testing - - memory-routing - - history-control - - unit-tests - - custom-navigation + - memory + - history + - component + - navigation + - programmatic version: '1.0' +description: >- + MemoryRouter keeps routing history in memory for complete control, ideal for + testing scenarios and programmatic navigation management. --- The `MemoryRouter` can be used to route while keeping the entire routing history within internal memory. diff --git a/src/routes/solid-router/reference/components/navigate.mdx b/src/routes/solid-router/reference/components/navigate.mdx index 5a4ecbec0..4fe0ba2ab 100644 --- a/src/routes/solid-router/reference/components/navigate.mdx +++ b/src/routes/solid-router/reference/components/navigate.mdx @@ -1,14 +1,18 @@ --- title: Navigate use_cases: >- - programmatic navigation, redirects, conditional routing, automatic navigation, - route guards + automatic redirects, programmatic navigation, conditional routing, auth + redirects, dynamic routing tags: - - programmatic-navigation + - component - redirects - - conditional-routing - - automatic-navigation + - navigation + - programmatic + - dynamic version: '1.0' +description: >- + Navigate component provides immediate programmatic navigation and redirects, + perfect for authentication flows and conditional routing logic. --- Solid Router provides a `Navigate` component that works similarly to [``](/solid-router/reference/components/a), but it will _immediately_ navigate to the provided path as soon as the component is rendered. diff --git a/src/routes/solid-router/reference/components/route.mdx b/src/routes/solid-router/reference/components/route.mdx index f66bf5759..10ef6f631 100644 --- a/src/routes/solid-router/reference/components/route.mdx +++ b/src/routes/solid-router/reference/components/route.mdx @@ -1,15 +1,19 @@ --- title: Route use_cases: >- - defining application routes, route configuration, nested routing, multiple - path matching, route structure + defining routes, app structure, url mapping, component rendering, nested + routing tags: - - route-definition - - configuration - - nested-routes - - multiple-paths + - component + - routes - structure + - paths + - nested + - configuration version: '1.0' +description: >- + Route component defines your application's URL structure and maps paths to + components with support for multiple paths and nested routing. --- `Route` is the component used when defining the routes of an application. diff --git a/src/routes/solid-router/reference/components/router.mdx b/src/routes/solid-router/reference/components/router.mdx index b3e08241e..9ff916034 100644 --- a/src/routes/solid-router/reference/components/router.mdx +++ b/src/routes/solid-router/reference/components/router.mdx @@ -1,15 +1,19 @@ --- title: Router use_cases: >- - root router setup, application-wide routing, layout configuration, router - configuration, top-level routing + app initialization, root setup, layout wrapper, routing context, main + configuration tags: - - root-router + - component + - root + - initialization + - layout - configuration - - layouts - - application-setup - - top-level + - context version: '1.0' +description: >- + Router is the top-level component that manages your app's routing, providing + context and configuration for all child routes and navigation. --- The `Router` component is a top level component that manages the routing of your application. diff --git a/src/routes/solid-router/reference/data-apis/action.mdx b/src/routes/solid-router/reference/data-apis/action.mdx index d114ada4d..55a885027 100644 --- a/src/routes/solid-router/reference/data-apis/action.mdx +++ b/src/routes/solid-router/reference/data-apis/action.mdx @@ -1,17 +1,20 @@ --- title: action use_cases: >- - forms, data mutations, user input submission, crud operations, authentication, - server state changes + forms, user input, data mutations, optimistic updates, form submissions, + server actions, post requests tags: + - actions - forms - mutations - - data - - crud - - server - post - validation + - optimistic-updates + - server version: '1.0' +description: >- + Learn how to handle form submissions and data mutations in SolidJS with + actions, including optimistic updates and server-side processing. --- Actions are data mutations that can trigger invalidations and further routing. diff --git a/src/routes/solid-router/reference/data-apis/cache.mdx b/src/routes/solid-router/reference/data-apis/cache.mdx index fe2404663..e81d86ad0 100644 --- a/src/routes/solid-router/reference/data-apis/cache.mdx +++ b/src/routes/solid-router/reference/data-apis/cache.mdx @@ -2,15 +2,18 @@ title: cache isDeprecated: true use_cases: >- - legacy projects, upgrading from old router versions, deprecated api - maintenance + api calls, data fetching, deduplication, preloading routes, caching responses, + preventing waterfalls tags: + - cache - deprecated - - caching - - legacy - - migration - - upgrade + - data-fetching + - deduplication + - preload version: '1.0' +description: >- + Deprecated caching API for deduplicating requests and preloading data. Use + query instead for better performance and invalidation. --- :::caution[Deprecation Warning] diff --git a/src/routes/solid-router/reference/data-apis/create-async-store.mdx b/src/routes/solid-router/reference/data-apis/create-async-store.mdx index 577d534fe..42af45895 100644 --- a/src/routes/solid-router/reference/data-apis/create-async-store.mdx +++ b/src/routes/solid-router/reference/data-apis/create-async-store.mdx @@ -1,16 +1,18 @@ --- title: createAsyncStore use_cases: >- - large datasets, complex state, fine-grained reactivity, deep object updates, - model data + large datasets, reactive stores, model data, fine-grained updates, complex + state tags: - - store - - reactivity - async - - data - - large-datasets - - fine-grained + - stores + - reactive + - data-fetching + - state version: '1.0' +description: >- + Create deeply reactive stores from async data sources for fine-grained updates + on large datasets and complex model structures. --- Similar to [createAsync](/solid-router/reference/data-apis/create-async) except it uses a deeply reactive store. Perfect for applying fine-grained changes to large model data that updates. diff --git a/src/routes/solid-router/reference/data-apis/create-async.mdx b/src/routes/solid-router/reference/data-apis/create-async.mdx index 802eebdf9..78b8bb154 100644 --- a/src/routes/solid-router/reference/data-apis/create-async.mdx +++ b/src/routes/solid-router/reference/data-apis/create-async.mdx @@ -1,16 +1,19 @@ --- title: createAsync use_cases: >- - data fetching, async operations, loading states, suspense, api calls, server - data + data fetching, async operations, suspense boundaries, loading states, api + calls, ssr data tags: - async - - data-fetching - suspense + - data-fetching - loading - - api - promises + - ssr version: '1.0' +description: >- + Transform promises into reactive signals with createAsync. Handle async data + with Suspense and automatic loading states. --- An asynchronous primitive with a function that tracks similar to `createMemo`. diff --git a/src/routes/solid-router/reference/data-apis/query.mdx b/src/routes/solid-router/reference/data-apis/query.mdx index ac1d0f43d..0523565ff 100644 --- a/src/routes/solid-router/reference/data-apis/query.mdx +++ b/src/routes/solid-router/reference/data-apis/query.mdx @@ -1,16 +1,20 @@ --- title: query use_cases: >- - data fetching, caching, api calls, server requests, deduplication, performance - optimization + api calls, data fetching, caching, deduplication, preloading routes, + preventing waterfalls, ssr tags: - query - - caching + - cache - data-fetching - - api - - performance - deduplication + - preload + - ssr + - api version: '1.0' +description: >- + Cache and deduplicate API calls with query. Prevent waterfalls, enable + preloading, and manage server-side rendering efficiently. --- `query` is a [higher-order function](https://en.wikipedia.org/wiki/Higher-order_function) designed to create a new function with the same signature as the function passed to it. diff --git a/src/routes/solid-router/reference/data-apis/revalidate.mdx b/src/routes/solid-router/reference/data-apis/revalidate.mdx index accc03488..f1b4ac37f 100644 --- a/src/routes/solid-router/reference/data-apis/revalidate.mdx +++ b/src/routes/solid-router/reference/data-apis/revalidate.mdx @@ -1,14 +1,19 @@ --- title: revalidate -use_cases: 'cache invalidation, data refresh, updating stale data, manual refresh, polling' +use_cases: >- + refresh data, invalidate cache, polling, real-time updates, manual refetch, + stale data tags: - - revalidation + - revalidate - cache - refresh - invalidation - polling - - update + - refetch version: '1.0' +description: >- + Manually revalidate cached queries to refresh stale data, implement polling, + or trigger updates after mutations in SolidJS. --- The `revalidate` function is used to revalidate queries associated with specified [query keys](/solid-router/reference/data-apis/query#query-keys). diff --git a/src/routes/solid-router/reference/data-apis/use-action.mdx b/src/routes/solid-router/reference/data-apis/use-action.mdx index 8564f7fae..303573e4b 100644 --- a/src/routes/solid-router/reference/data-apis/use-action.mdx +++ b/src/routes/solid-router/reference/data-apis/use-action.mdx @@ -1,15 +1,18 @@ --- title: useAction use_cases: >- - programmatic form submission, javascript-based mutations, custom form - handling, non-form actions + programmatic forms, client-side mutations, imperative actions, non-form + submissions tags: - - action - - programmatic - - javascript + - actions - mutations - - custom + - client + - imperative + - programmatic version: '1.0' +description: >- + Invoke actions programmatically without forms using useAction. Perfect for + client-side mutations and imperative updates. --- `useAction` allows an [`action`](/solid-router/reference/data-apis/action) to be invoked programmatically. diff --git a/src/routes/solid-router/reference/data-apis/use-submission.mdx b/src/routes/solid-router/reference/data-apis/use-submission.mdx index 47205e112..1ba58fa79 100644 --- a/src/routes/solid-router/reference/data-apis/use-submission.mdx +++ b/src/routes/solid-router/reference/data-apis/use-submission.mdx @@ -1,16 +1,19 @@ --- title: useSubmission use_cases: >- - form feedback, loading states, optimistic updates, error handling, single - submissions + form feedback, pending states, optimistic updates, error handling, single + submission tracking tags: - forms - - feedback + - submissions + - pending - optimistic - - loading - errors - - submission + - feedback version: '1.0' +description: >- + Track form submission states with useSubmission. Handle pending feedback, + optimistic updates, and errors for single forms. --- This helper is used to handle form submissions and can provide optimistic updates while actions are in flight as well as pending state feedback. diff --git a/src/routes/solid-router/reference/data-apis/use-submissions.mdx b/src/routes/solid-router/reference/data-apis/use-submissions.mdx index 7815c66a9..f03cb70b4 100644 --- a/src/routes/solid-router/reference/data-apis/use-submissions.mdx +++ b/src/routes/solid-router/reference/data-apis/use-submissions.mdx @@ -1,16 +1,19 @@ --- title: useSubmissions use_cases: >- - multiple submissions tracking, batch operations, submission history, complex - forms, retry logic + multiple forms, submission history, batch operations, optimistic lists, error + recovery tags: - forms + - submissions - multiple - - tracking - - batch - history - - retry + - optimistic + - batch version: '1.0' +description: >- + Manage multiple form submissions simultaneously with useSubmissions. Track + history, handle errors, and show optimistic updates. --- This helper is used to handle form submissions and can provide optimistic updates while actions are in flight as well as pending state feedback. diff --git a/src/routes/solid-router/reference/preload-functions/preload.mdx b/src/routes/solid-router/reference/preload-functions/preload.mdx index 6787bc5a9..9cb0ae2fa 100644 --- a/src/routes/solid-router/reference/preload-functions/preload.mdx +++ b/src/routes/solid-router/reference/preload-functions/preload.mdx @@ -1,16 +1,19 @@ --- title: Preload use_cases: >- - performance optimization, data preloading, route preparation, preventing - waterfalls, hover prefetch + route preloading, hover prefetch, parallel loading, performance optimization, + lazy routes, code splitting tags: - preload - performance - - optimization - - routes + - routing - prefetch - - waterfall + - lazy + - optimization version: '1.0' +description: >- + Preload route data and code in parallel to eliminate waterfalls. Enable hover + prefetching for instant page transitions. --- With smart caches waterfalls are still possible with view logic and with lazy loaded code. diff --git a/src/routes/solid-router/reference/primitives/use-before-leave.mdx b/src/routes/solid-router/reference/primitives/use-before-leave.mdx index 8663701f9..94f0fab07 100644 --- a/src/routes/solid-router/reference/primitives/use-before-leave.mdx +++ b/src/routes/solid-router/reference/primitives/use-before-leave.mdx @@ -1,15 +1,19 @@ --- title: useBeforeLeave use_cases: >- - forms with unsaved changes, data loss prevention, confirmation dialogs, - blocking navigation + unsaved forms, exit confirmations, data loss prevention, user prompts before + navigation, dirty state handling tags: - navigation - forms - confirmation - - data-protection - - user-experience + - prevent + - prompt + - leave version: '1.0' +description: >- + Prevent route navigation with useBeforeLeave - prompt users before leaving + with unsaved changes, handle exit confirmations in SolidJS. --- `useBeforeLeave` takes a function that will be called prior to leaving a route. diff --git a/src/routes/solid-router/reference/primitives/use-current-matches.mdx b/src/routes/solid-router/reference/primitives/use-current-matches.mdx index 2051176cb..5b0191477 100644 --- a/src/routes/solid-router/reference/primitives/use-current-matches.mdx +++ b/src/routes/solid-router/reference/primitives/use-current-matches.mdx @@ -1,13 +1,18 @@ --- title: useCurrentMatches -use_cases: 'breadcrumbs, route metadata, nested route information, navigation context' +use_cases: >- + breadcrumbs, route metadata, nested routes, navigation menus, route info + extraction tags: + - routes - breadcrumbs - - metadata - - nested-routes + - matches - navigation - - route-info + - metadata version: '1.0' +description: >- + Access all matched route information with useCurrentMatches - build + breadcrumbs, extract route metadata, and navigate nested routes. --- `useCurrentMatches` returns all the matches for the current matched route. Useful for getting all the route information. diff --git a/src/routes/solid-router/reference/primitives/use-is-routing.mdx b/src/routes/solid-router/reference/primitives/use-is-routing.mdx index 2f2d69b4e..e92ea7e2d 100644 --- a/src/routes/solid-router/reference/primitives/use-is-routing.mdx +++ b/src/routes/solid-router/reference/primitives/use-is-routing.mdx @@ -1,15 +1,18 @@ --- title: useIsRouting use_cases: >- - loading states, pending navigation indicators, transition feedback, concurrent - rendering + loading states, transition indicators, pending ui, stale content, concurrent + rendering feedback tags: - - loading-states - - transitions + - loading + - transition - pending - - feedback - - concurrent + - state + - ui version: '1.0' +description: >- + Track route transitions with useIsRouting - display loading states, pending + UI, and transition feedback during navigation in SolidJS. --- Retrieves a signal that indicates whether the route is currently in a transition. diff --git a/src/routes/solid-router/reference/primitives/use-location.mdx b/src/routes/solid-router/reference/primitives/use-location.mdx index 567a314d0..5e60a3175 100644 --- a/src/routes/solid-router/reference/primitives/use-location.mdx +++ b/src/routes/solid-router/reference/primitives/use-location.mdx @@ -1,13 +1,19 @@ --- title: useLocation -use_cases: 'accessing url parts, query parameters, pathname parsing, location-based logic' +use_cases: >- + current url tracking, query parameters, pathname parsing, hash navigation, + location state access tags: + - location - url - pathname - - query-params - - location - - navigation + - query + - hash + - state version: '1.0' +description: >- + Access reactive URL information with useLocation - track pathname, query + strings, hash, and navigation state in your SolidJS app. --- Retrieves reactive `location` object useful for getting things like `pathname` diff --git a/src/routes/solid-router/reference/primitives/use-match.mdx b/src/routes/solid-router/reference/primitives/use-match.mdx index fe1f22dea..4c46cbe80 100644 --- a/src/routes/solid-router/reference/primitives/use-match.mdx +++ b/src/routes/solid-router/reference/primitives/use-match.mdx @@ -1,15 +1,19 @@ --- title: useMatch use_cases: >- - active navigation links, conditional rendering, route matching, menu - highlighting + active links, navigation highlighting, conditional rendering, path matching, + menu items tags: - - active-links - - conditional-rendering + - match + - active - navigation - - matching - - menus + - path + - conditional + - links version: '1.0' +description: >- + Check if paths match current route with useMatch - create active navigation + links, conditional rendering based on route matching. --- `useMatch` takes an accessor that returns the path and creates a Memo that returns match information if the current path matches the provided path. diff --git a/src/routes/solid-router/reference/primitives/use-navigate.mdx b/src/routes/solid-router/reference/primitives/use-navigate.mdx index 2c2320110..621bfb226 100644 --- a/src/routes/solid-router/reference/primitives/use-navigate.mdx +++ b/src/routes/solid-router/reference/primitives/use-navigate.mdx @@ -1,13 +1,18 @@ --- title: useNavigate -use_cases: 'programmatic navigation, redirects, conditional routing, authentication flows' +use_cases: >- + programmatic navigation, redirects, auth flows, form submissions, history + manipulation tags: - - navigation - - redirects + - navigate + - redirect - programmatic - - authentication - - routing + - history + - state version: '1.0' +description: >- + Navigate programmatically with useNavigate - redirect users, handle auth + flows, and control navigation with replace and scroll options. --- Retrieves the method which accepts a path to navigate to and an optional object with the following options: diff --git a/src/routes/solid-router/reference/primitives/use-params.mdx b/src/routes/solid-router/reference/primitives/use-params.mdx index 405d553bf..750752b20 100644 --- a/src/routes/solid-router/reference/primitives/use-params.mdx +++ b/src/routes/solid-router/reference/primitives/use-params.mdx @@ -1,12 +1,16 @@ --- title: useParams -use_cases: 'dynamic routes, path parameters, user ids, resource identifiers' +use_cases: 'dynamic routes, user profiles, product pages, id-based content, url parameters' tags: - - dynamic-routes + - params + - dynamic + - routes - parameters - - path-params - - routing + - reactive version: '1.0' +description: >- + Access route parameters reactively with useParams - extract dynamic segments + from URLs for user profiles, products, and ID-based pages. --- `useParams` retrieves a reactive object similar to a store. diff --git a/src/routes/solid-router/reference/primitives/use-preload-route.mdx b/src/routes/solid-router/reference/primitives/use-preload-route.mdx index fe5e73f27..b6368a6e4 100644 --- a/src/routes/solid-router/reference/primitives/use-preload-route.mdx +++ b/src/routes/solid-router/reference/primitives/use-preload-route.mdx @@ -1,14 +1,18 @@ --- title: usePreloadRoute use_cases: >- - performance optimization, manual preloading, custom preload triggers, faster - navigation + performance optimization, manual preloading, predictive navigation, + prefetching routes tags: + - preload - performance - - preloading - optimization - prefetch + - manual version: '1.0' +description: >- + Manually preload routes with usePreloadRoute - optimize performance by + prefetching route data before navigation in your SolidJS app. --- `usePreloadRoute` returns a function that can be used to preload a route manually. This is what happens automatically with link hovering and similar focus based behavior, but it is available here as an API. diff --git a/src/routes/solid-router/reference/primitives/use-resolved-path.mdx b/src/routes/solid-router/reference/primitives/use-resolved-path.mdx index f3eca99f0..cf8f1a59a 100644 --- a/src/routes/solid-router/reference/primitives/use-resolved-path.mdx +++ b/src/routes/solid-router/reference/primitives/use-resolved-path.mdx @@ -1,12 +1,19 @@ --- title: useResolvedPath -use_cases: 'modular routers, nested routing systems, path resolution, component libraries' +use_cases: >- + modular routing, nested routers, relative paths, dynamic base paths, component + isolation tags: - - modular-routing - - nested-routes - - path-resolution - - components + - path + - modular + - nested + - routing + - base + - resolved version: '1.0' +description: >- + Resolve relative paths with useResolvedPath - build modular routers, handle + nested routes, and create isolated routing components. --- `useResolvedPath` retrieves a signal\. diff --git a/src/routes/solid-router/reference/primitives/use-search-params.mdx b/src/routes/solid-router/reference/primitives/use-search-params.mdx index 461e52c0b..0aa58b7cf 100644 --- a/src/routes/solid-router/reference/primitives/use-search-params.mdx +++ b/src/routes/solid-router/reference/primitives/use-search-params.mdx @@ -1,13 +1,17 @@ --- title: useSearchParams -use_cases: 'query parameters, search filters, pagination, url state management' +use_cases: 'pagination, filters, search forms, url state management, query string updates' tags: - - query-params - search + - query + - params - pagination - filters - - url-state + - url version: '1.0' +description: >- + Manage URL query parameters with useSearchParams - handle pagination, filters, + and search state directly in the URL query string. --- Retrieves a tuple containing a reactive object to read the current location's query parameters and a method to update them. diff --git a/src/routes/solid-router/reference/response-helpers/json.mdx b/src/routes/solid-router/reference/response-helpers/json.mdx index 6f567ae9e..b2668eee8 100644 --- a/src/routes/solid-router/reference/response-helpers/json.mdx +++ b/src/routes/solid-router/reference/response-helpers/json.mdx @@ -1,16 +1,19 @@ --- title: json use_cases: >- - api responses, data fetching, actions returning data, cache revalidation, - structured responses + returning api data, action responses, cache control, revalidation strategies, + server actions tags: + - json - api - - responses - actions - cache - revalidation - - data + - response version: '1.0' +description: >- + Return JSON data from actions with cache revalidation control. Configure how + route data updates after mutations for optimal performance. --- Returns JSON data from an action while also providing options for controlling revalidation of cache data on the route. diff --git a/src/routes/solid-router/reference/response-helpers/redirect.mdx b/src/routes/solid-router/reference/response-helpers/redirect.mdx index e21571916..394193965 100644 --- a/src/routes/solid-router/reference/response-helpers/redirect.mdx +++ b/src/routes/solid-router/reference/response-helpers/redirect.mdx @@ -1,16 +1,19 @@ --- title: redirect use_cases: >- - authentication flows, login pages, navigation, route protection, form - submissions, single-flight mutations + authentication flows, login redirects, form submissions, route guards, user + authorization, navigation control tags: + - redirect - authentication - navigation - routing + - authorization - forms - - mutations - - login version: '1.0' +description: >- + Redirect users between routes with proper status codes. Handle authentication + flows, form submissions, and protected route access. --- Redirects to the next route. diff --git a/src/routes/solid-router/reference/response-helpers/reload.mdx b/src/routes/solid-router/reference/response-helpers/reload.mdx index fbc05a62d..4a7f2546d 100644 --- a/src/routes/solid-router/reference/response-helpers/reload.mdx +++ b/src/routes/solid-router/reference/response-helpers/reload.mdx @@ -1,16 +1,19 @@ --- title: reload use_cases: >- - cache invalidation, data refresh, query revalidation, optimistic updates, data - synchronization + data refresh, cache invalidation, after mutations, updating queries, form + submissions, data synchronization tags: + - reload - cache - revalidation + - mutations - queries - - data - - updates - - invalidation + - refresh version: '1.0' +description: >- + Reload and revalidate specific queries after mutations. Efficiently update + cached data without full page refreshes for better UX. --- Reload is a response helper built on top of [revalidate](/solid-router/reference/response-helpers/revalidate). diff --git a/src/routes/solid-router/rendering-modes/spa.mdx b/src/routes/solid-router/rendering-modes/spa.mdx index 9a5975b3a..ef9dbcec5 100644 --- a/src/routes/solid-router/rendering-modes/spa.mdx +++ b/src/routes/solid-router/rendering-modes/spa.mdx @@ -1,16 +1,19 @@ --- title: Single page applications use_cases: >- - client-side routing, spa deployment, hosting configuration, cdn setup, static - hosting + client-side routing, cdn deployment, static hosting, spa configuration, + deployment setup tags: - spa - deployment - - hosting - cdn - - client-routing - - static + - hosting + - client-side + - routing version: '1.0' +description: >- + Configure single-page applications for proper CDN and hosting deployment. + Handle client-side routing without server-side rendering. --- When deploying applications that use a client-side router without relying on Server-Side Rendering, it is important that redirects to the index page are handled properly. diff --git a/src/routes/solid-router/rendering-modes/ssr.mdx b/src/routes/solid-router/rendering-modes/ssr.mdx index 07ee401cd..c8aaa05e0 100644 --- a/src/routes/solid-router/rendering-modes/ssr.mdx +++ b/src/routes/solid-router/rendering-modes/ssr.mdx @@ -1,16 +1,19 @@ --- title: Server side rendering use_cases: >- - server-side rendering, preloading data, suspense, resources, lazy loading, - initial page loads + server rendering, seo optimization, initial page load, performance + optimization, data preloading tags: - ssr - - preloading - - suspense - - resources - - lazy + - server + - rendering + - seo - performance + - preload version: '1.0' +description: >- + Enable server-side rendering with Solid Router for SEO and performance. + Support suspense, resources, and render-as-you-fetch patterns. --- Solid Router supports all of Solid's SSR capabilities. diff --git a/src/routes/solid-start/advanced/auth.mdx b/src/routes/solid-start/advanced/auth.mdx index 467b09bfb..b77162ee0 100644 --- a/src/routes/solid-start/advanced/auth.mdx +++ b/src/routes/solid-start/advanced/auth.mdx @@ -1,16 +1,19 @@ --- title: Auth use_cases: >- - authentication, user protection, login systems, private routes, user data, - session management + user authentication, protected routes, authorization checks, secure data + access, login systems tags: - authentication - authorization - - login - - sessions - - user - security + - protected + - login + - users version: '1.0' +description: >- + Implement authentication and protected routes in SolidStart. Secure sensitive + resources and handle user authorization properly. --- Server functions can be used to protect sensitive resources like user data. diff --git a/src/routes/solid-start/advanced/middleware.mdx b/src/routes/solid-start/advanced/middleware.mdx index f49d8505d..37e455192 100644 --- a/src/routes/solid-start/advanced/middleware.mdx +++ b/src/routes/solid-start/advanced/middleware.mdx @@ -1,17 +1,19 @@ --- title: Middleware use_cases: >- - request interception, authentication, logging, headers, global data sharing, - redirects, preprocessing + request interception, header management, global data sharing, request + preprocessing, logging, redirects tags: - middleware - - requests - - authentication - - logging - headers + - interceptors + - logging - preprocessing - - globals + - locals version: '1.0' +description: >- + Intercept HTTP requests with middleware for authentication, logging, and + header management. Share request-scoped data across your app. --- Middleware intercepts HTTP requests and responses to perform tasks like authentication, redirection, logging, and more. diff --git a/src/routes/solid-start/advanced/request-events.mdx b/src/routes/solid-start/advanced/request-events.mdx index 75dbbd020..db68db147 100644 --- a/src/routes/solid-start/advanced/request-events.mdx +++ b/src/routes/solid-start/advanced/request-events.mdx @@ -1,16 +1,19 @@ --- title: Request events use_cases: >- - server context, request data, locals typing, native events, vinxi integration, - server functions + server context access, local data storage, request handling, server functions, + event access tags: + - events - server - context - - events - locals - - vinxi - - typing + - requests + - functions version: '1.0' +description: >- + Access request events and local context in SolidStart server functions. + Type-safe locals and native event handling for server code. --- Request events in SolidStart are retrieved using the [`getRequestEvent`](/reference/server-utilities/get-request-event) from `@solidjs/web`. diff --git a/src/routes/solid-start/advanced/return-responses.mdx b/src/routes/solid-start/advanced/return-responses.mdx index 655d7cec6..6a7ef643e 100644 --- a/src/routes/solid-start/advanced/return-responses.mdx +++ b/src/routes/solid-start/advanced/return-responses.mdx @@ -1,16 +1,19 @@ --- title: Returning responses use_cases: >- - server functions, response objects, typescript typing, error handling, custom - responses + server function responses, error handling, response types, api responses, + typescript typing tags: - - server - responses + - server + - functions - typescript - errors - - functions - - types + - api version: '1.0' +description: >- + Return typed Response objects from server functions. Handle redirects, + reloads, and JSON responses with proper TypeScript support. --- In SolidStart, it is possible to return a Response object from a server function. diff --git a/src/routes/solid-start/advanced/session.mdx b/src/routes/solid-start/advanced/session.mdx index cc6ba15dc..c4af27cba 100644 --- a/src/routes/solid-start/advanced/session.mdx +++ b/src/routes/solid-start/advanced/session.mdx @@ -1,16 +1,19 @@ --- title: Sessions use_cases: >- - user sessions, state persistence, authentication, user preferences, login - state, stateful applications + user sessions, authentication state, preferences storage, stateful + interactions, login persistence tags: - sessions - - state + - cookies - authentication + - state + - storage - persistence - - preferences - - cookies version: '1.0' +description: >- + Manage user sessions with encrypted cookies in SolidStart. Maintain + authentication state and user preferences between requests. --- Sessions allow web applications to maintain state between user requests. diff --git a/src/routes/solid-start/advanced/websocket.mdx b/src/routes/solid-start/advanced/websocket.mdx index 9334a7568..e3869b836 100644 --- a/src/routes/solid-start/advanced/websocket.mdx +++ b/src/routes/solid-start/advanced/websocket.mdx @@ -1,16 +1,19 @@ --- title: WebSocket endpoint use_cases: >- - real-time communication, live chat, live updates, multiplayer games, - collaborative apps, streaming data + real-time updates, chat applications, live notifications, multiplayer games, + collaborative editing, streaming data tags: - - websockets + - websocket - real-time - - experimental - streaming - - chat - - live-updates + - experimental + - server + - events version: '1.0' +description: >- + Set up WebSocket endpoints in SolidStart for real-time bidirectional + communication. Handle connections, messages, and events. --- WebSocket endpoint may be included by passing the ws handler file you specify in your start config. diff --git a/src/routes/solid-start/building-your-application/api-routes.mdx b/src/routes/solid-start/building-your-application/api-routes.mdx index 191ce9799..503c7c304 100644 --- a/src/routes/solid-start/building-your-application/api-routes.mdx +++ b/src/routes/solid-start/building-your-application/api-routes.mdx @@ -1,17 +1,20 @@ --- title: API routes use_cases: >- - rest api, graphql endpoints, webhooks, oauth callbacks, third-party - integrations, non-html responses, public apis + rest api, graphql endpoints, trpc setup, webhooks, oauth callbacks, pdf + generation, third-party integrations tags: - api - rest - graphql - trpc - - webhooks - - oauth - endpoints + - server + - http version: '1.0' +description: >- + Create API routes in SolidStart for REST, GraphQL, or tRPC endpoints. Handle + HTTP methods, sessions, and external integrations. --- While Server Functions can be a good way to write server-side code for data needed by your UI, sometimes you need to expose API routes. diff --git a/src/routes/solid-start/building-your-application/css-and-styling.mdx b/src/routes/solid-start/building-your-application/css-and-styling.mdx index 65422e25d..d8e806ee3 100644 --- a/src/routes/solid-start/building-your-application/css-and-styling.mdx +++ b/src/routes/solid-start/building-your-application/css-and-styling.mdx @@ -1,16 +1,19 @@ --- title: CSS and styling use_cases: >- - styling components, css organization, scoped styles, maintaining design - systems, component libraries + styling components, css modules, scoped styles, component styling, design + system setup, visual customization tags: - css - styling - - css-modules - - scoped-styles - - design + - modules - components + - design + - vite version: '1.0' +description: >- + Style your SolidStart components with CSS, CSS modules, and other styling + solutions. Implement scoped styles and design systems. --- SolidStart is a standards-based framework that, instead of modifying the behavior of the [`