vike-solid
v0.4.5
Published
[<img src="https://vike.dev/vike-readme.svg" align="right" height="90">](https://vike.dev) [](https://www.npmjs.com/package/vike-solid)
Downloads
3,116
Readme
vike-solid
SolidJS integration for Vike, see vike.dev/solid.
Introduction
UI framework Vike extensions like vike-solid:
- implement Vike Core hooks (e.g.
onRenderHtml()) on your behalf, - set Vike Core settings on your behalf,
- introduce new hooks for you to implement if needed,
- introduce new settings for you to set if needed,
- introduce new components and component hooks.
Scaffold new app
Use Bati to scaffold a Vike app using vike-solid.
Add to existing app
To add vike-solid to an existing Vike app:
- Install the
vike-solidnpm package in your project:
npm install vike-solid- Edit your Vite config:
// vite.config.ts
import vikeSolid from "vike-solid/vite";
import vike from "vike/plugin";
import type { UserConfig } from "vite";
export default {
plugins: [
vike(),
// Add vikeSolid() after vike()
vikeSolid()
]
} satisfies UserConfig- Extend your existing Vike config files with
vike-solid:
// /pages/+config.js
+import vikeSolid from 'vike-solid/config'
+
export default {
// Existing Vike Core settings
// ...
+
+ // New setting introduced by vike-solid:
+ title: 'My Vike + Solid App',
+
+ extends: vikeSolid
}Hooks
vike-solid implements the onRenderHtml() and
onRenderClient() hooks on your behalf, which are essentially the glue code between
Vike and Solid.
Settings
vike-solid sets the following Vike Core settings on your behalf:
clientRouting=true: Enable Client Routing.hydrationCanBeAborted=true: Solid allows the hydration to be aborted.
vike-solid introduces the following new settings:
Head: Component Component to be rendered inside the<head>tag.title: string<title>...</title>tag.favicon: string<link rel="icon" href="..." />attribute.lang: string<html lang="...">attribute.ssr: boolean Enable/disable Server-Side Rendering (SSR).stream: boolean Enable/disable HTML streaming.Layout: Component Wrapper for your Page component.
Component hooks
vike-solid introduces the following new component hooks:
useData(): Access the data that is returned by adata()hook from any component.usePageContext(): Access thepageContextobject from any component.
Components
vike-solid introduces the following new components:
ClientOnly: Wrapper to render and load a component only on the client-side.