| name | solid-meta-0-29-4 |
| description | Manages document head tags in SolidJS applications with @solidjs/meta v0.29.4, providing SSR-ready Document Head management including Title, Meta, Link, Style, Base, and Stylesheet components with MetaProvider. Use when building SolidJS applications requiring dynamic head tag control, SEO meta tags, or managing document title/stylesheets across routes. |
@solidjs/meta v0.29.4
Overview
Asynchronous SSR-ready Document Head management for SolidJS. Based on react-head, it allows you to define document.head tags anywhere in your component hierarchy — similar to react-helmet but built for SolidJS's fine-grained reactivity model.
The library provides six head tag components (Title, Meta, Link, Style, Base, Stylesheet) and a single context provider (MetaProvider). On the server, tags are collected via Solid's useAssets API and injected into the HTML <head>. On the client, server-generated tags (marked with data-sm attributes) are removed in favor of client-rendered tags so SPAs work correctly across navigation.
v0.29.4 changes: Simplified server-side provider (removed getRequestEvent() / solidMeta module augmentation), fixed array children concatenation, added parentNode safety check during tag cleanup. MetaProvider no longer accepts a tags prop.
When to Use
- Setting dynamic page titles in a SolidJS SPA or SSR application
- Managing SEO meta tags (
og:, twitter:, description, canonical URLs)
- Injecting stylesheets or inline
<style> blocks conditionally
- Building SolidStart applications with per-route head management
- Replacing react-helmet patterns when migrating to SolidJS
- Any scenario where head tag information is only available deep in the component tree
Installation / Setup
npm i @solidjs/meta
Requires solid-js >= 1.8.4 as a peer dependency. Zero additional dependencies.
Core Concepts
MetaProvider Context
All head tag components require <MetaProvider> somewhere above them in the component tree. It creates a MetaContext with addTag and removeTag operations. Without it, any head component throws: <MetaProvider /> should be in the tree.
import { MetaProvider, Title } from "@solidjs/meta";
function App() {
return (
<MetaProvider>
<Title>My App</Title>
{/* rest of app */}
</MetaProvider>
);
}
Note (v0.29.4): MetaProvider no longer accepts a tags prop. Server-side tag collection is handled internally without the solid-js/web module augmentation pattern.
Cascading Tags
<title> and <meta> are "cascading" — only the last instance with a matching key is rendered. The key for <title> is just the tag name (so only one title exists). For <meta>, the key is derived from name or property attributes. This means deeper components in the tree override shallower ones, enabling per-route overrides.
<MetaProvider>
<Title>Title 1</Title>
<Title>Title 2</Title>
<Title>Title 3</Title>
</MetaProvider>
For <meta>, tags with the same name or property cascade (last wins), but tags with different attributes coexist:
<Meta name="theme-color" media="(prefers-color-scheme: light)" content="#fff" />
<Meta name="theme-color" media="(prefers-color-scheme: dark)" content="#000" />
Non-Cascading Tags
<link>, <style>, <base> are non-cascading — all instances render. Multiple <Link> tags for different stylesheets or favicons all appear in <head>.
SSR Hydration
On the server, tags are collected into an internal array and serialized via useAssets with data-sm markers. On the client, during hydration, MetaProvider removes all [data-sm] elements from <head> before rendering client-side tags. This prevents duplicate head tags after hydration.
Usage Examples
Basic Client-Side Setup
import { MetaProvider, Title, Link, Meta } from "@solidjs/meta";
const App = () => (
<MetaProvider>
<Title>Title of page</Title>
<Link rel="canonical" href="http://solidjs.com/" />
<Meta name="description" content="A SolidJS application" />
<div class="Home">
{/* page content */}
</div>
</MetaProvider>
);
SolidStart Setup
Wrap the app with <MetaProvider> inside the root prop of <Router>:
import { MetaProvider, Title } from "@solidjs/meta";
import { Router } from "@solidjs/router";
import { FileRoutes } from "@solidjs/start";
import { Suspense } from "solid-js";
export default function App() {
return (
<Router
root={props => (
<MetaProvider>
<Title>SolidStart - Basic</Title>
<a href="/">Index</a>
<a href="/about">About</a>
<Suspense>{props.children}</Suspense>
</MetaProvider>
)}
>
<FileRoutes />
</Router>
);
}
Important: Do not add any normal <title> tags in server files (e.g., entry-server.tsx), as they would override @solidjs/meta's functionality.
Per-Route Meta Tags
Each route component can define its own head tags. Deeper tags cascade over shallower ones:
import { Title, Meta } from "@solidjs/meta";
export default function Index() {
return (
<>
<Title>Home - My App</Title>
<Meta name="description" content="The home page" />
<h1>Welcome</h1>
</>
);
}
import { Title, Meta } from "@solidjs/meta";
export default function About() {
return (
<>
<Title>About - My App</Title>
<Meta name="description" content="About this application" />
<h1>About Us</h1>
</>
);
}
Dynamic Title with Signals
SolidJS reactivity integrates naturally — titles update when signals change:
import { createSignal } from "solid-js";
import { Title } from "@solidjs/meta";
function Page() {
const [count, setCount] = createSignal(0);
return (
<>
<Title>Counter: {count()}</Title>
<button onClick={() => setCount(c => c + 1)}>Increment</button>
</>
);
}
Open Graph and Social Meta Tags
Use property attribute for Open Graph tags (treated equivalently to name for cascading):
<Meta property="og:title" content="My Page Title" />
<Meta property="og:type" content="website" />
<Meta property="og:image" content="https://example.com/og-image.png" />
<Meta name="twitter:card" content="summary_large_image" />
Stylesheets and Inline Styles
import { Link, Style, Stylesheet } from "@solidjs/meta";
function App() {
return (
<MetaProvider>
<Stylesheet href="https://fonts.googleapis.com/css2?family=Inter" />
<Link rel="icon" href="/favicon.ico" type="image/x-icon" />
<Link rel="preconnect" href="https://fonts.gstatic.com" />
<Style>{`body { margin: 0; font-family: Inter, sans-serif; }`}</Style>
</MetaProvider>
);
}
Base Tag
import { Base } from "@solidjs/meta";
function App() {
return (
<MetaProvider>
<Base href="/my-app/" />
</MetaProvider>
);
}
Advanced Topics
Cascading and SSR Internals: How cascading works, XSS protection, hydration behavior → Cascading & SSR
API Reference: Complete component, hook, and type documentation → API Reference
Migration Notes: Changes from v0.29.0 to v0.29.4 → Migration Guide
