npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sham-ui-ssr

v2.1.2

Published

Server side rendering for sham-ui

Downloads

31

Readme

sham-ui-ssr

Build Status npm version MIT Licence

Server side rendering for sham-ui

Install

# npm
npm install --save-dev sham-ui-ssr
# yarn
yarn add -D sham-ui-ssr

API

Table of Contents

setup

Main function for setup hydrating components

Parameters

setup

Main function for rehydrating

Parameters
Examples
import { createDI, start } from 'sham-ui';
import setupUnsafe from 'sham-ui-unsafe';
import { setupRehydrator } from 'sham-ui-ssr/rehydrator';

const DI = createDI();
const data = JSON.parse( document.getElementById( 'data' ).innerText );
const disableRehydrating = setupRehydrator( DI, data );
mainInitializer( DI, root );
start( DI );
disableRehydrating();
setupUnsafe( DI );

Returns Function Restore function for disable rehydrating and switch to default behavior

hydrate

Hydrate all components

Parameters
Examples
import { createDI, start } from 'sham-ui';
import { setupHydrator, hydrate } from 'sham-ui-ssr/hydrator';

const DI = createDI();
const root = setupHydrator( DI );
mainInitializer( DI, root );
start( DI );
hydrate( DI ).then( storage => {
    const { html, data } = storage.hydrate();
} )

Returns Promise

hydrate

Hydrate node

Parameters

Returns string

makeRestore

Save hooks & dom services for restore after rehydrating

Parameters

Returns Function

makeRestore

Make restore function for hooks & dom

Parameters

Returns Function

Component

sham-ui component

SSRRenderResult

Result of server side renderer

Type: Object

Properties
  • component Component Rendered component instance
  • html string Rendered html
  • data string Data for component rehydrating
  • toJSON SSRToJSON Dump to JSON for jest's snapshot testing

SSRToJSON

Function for dump server side render result (using for jest-snapshots)

Type: Function

Returns SSRRenderResultSnapshot

SSRRenderResultSnapshot

Type: Object

Properties

ssr

Server side render for component

Parameters
  • componentClass Class<Component> Component class for rendering
  • componentOptions Object Options (optional, default {})
Examples
import Label from './Label.sht';
import { ssr } from 'sham-ui-ssr/testing';

it( 'renders correctly', () => {
    const meta = ssr( Label );

    expect( meta.component.ID ).toEqual( 'component' );
    expect( meta.toJSON() ).toMatchSnapshot();
} );

Returns SSRRenderResult

RenderResultSnapshot

Type: Object

Properties

RenderResult

Result of renderer

Type: Object

Properties
  • DI Object App DI container
  • component Component Rendered component instance
  • html string SSR html string
  • data string Data for rehydrating
  • toJSON ToJSON Dump to JSON for jest's snapshot testing

ToJSON

Function for dump render result (using for jest-snapshots)

Type: Function

Returns RenderResultSnapshot

ssrAndRehydrate

Render component with SSR & rehydrating

Parameters
  • componentClass Class<Component> Component class for rendering
  • componentOptions Object Options (optional, default {})
Examples
import Label from './Label.sht';
import { ssrAndRehydrate } from 'sham-ui-ssr/testing';

it( 'renders correctly', () => {
    const meta = ssrAndRehydrate( Label );

    expect( meta.component.ID ).toEqual( 'component' );
    expect( meta.toJSON() ).toMatchSnapshot();
} );

Returns RenderResult