solid-pod v0.0.5

Solid Pod

Solid Pod is a plug-and-play Server-Side Rendering solution for SolidJS.

NOTE: Solid Pod is still a work in progress. Some or all features may still not work. Use at your own risk.

Installation

You can add solid-pod to any existing SolidJS app using the following commands:

NPM

npm install solid-pod

Yarn

yarn add solid-pod

Usage

At its most basic form, all you have to do to run Solid Pod is change one line in your src/index.tsx file.

import { runApp } from 'solid-pod';
import App from './App';

runApp(App);

Notice that the only change we made to our index.ts file is we change SolidJS' render() call to Solid Pod's runApp() call.

At its most simplest form, this is all we need to do. We can now run the application by running solid-pod start at the root of our project directory. This will run our application in SSR mode.

Helper Primitives

Solid Pod comes with some pre-built primitives to give you access to different pieces of information.

useServerRequestContext()

The useServerRequestContext() primitive will give you access to the server request information. Below is an example of how we may use this primitive to pass routing information from the server to our app.

// App,tsx
import { Component } from 'solid-js';
import { useServerRequestContext } from 'solid-pod';
import { Router, useRoutes } from '@solidjs/router';
import { routes } from './routes';

const App: Component = () => {
    const req = useServerRequestContext();
    const Routes = useRoutes(routes);

    return (
        <Router url={req()?.url}>
            <Routes />
        </Router>
    );
}

export default App;

useEnvironment()

The useEnvironment() primitive tells us whether our application is in a production or development environment. We can use this to enable or disable features and components that are only meant for use in development.

Suppose we have an <Inspect> componet which lets us inspect our app's HTML during development. We propbably do not want this to be available during production. Below is an example of how we might restrict this using the useEnvironment() primitive.

// MyComponent.tsx
import { Component } from 'solid-js';
import { useEnvironment } from 'solid-pod';
import Inspect from './Inspect';

const MyComponent: Component = () => {
    const env = useEnvironment();

    return (
        <Inspect disable={() => env() == 'production'}>
            ....
        </Inspect>
    );
}

export default MyComponent;

useIsServer() and useIsClient()

The useIsServer() and useIsClient() primitives are used to determine if we are currently running on the client or on the server.

License

Solid Pod is provided under the MIT License.