Skip to content

Installation

From npm with a bundler, or one script tag with no build at all.

npm

Install the package and import what you need.

npm install signy
import { Component, Signal, application, html } from 'signy';

Signy also works with yarn add signy and pnpm add signy.

CDN

The global build defines Signy on window, so a page needs no bundler and no build step.

<script src="https://cdn.jsdelivr.net/npm/signy@1/dist/signy.global.min.js"></script>
<script>
  const { Component, Signal, application, html } = Signy;
</script>

Entry points

The signy import has everything. The smaller entry points let a bundler leave out the parts you do not use.

ImportWhat you get
signyEverything below
signy/coreSignal, Computed, effect, batch, untrack and the other primitives. No DOM.
signy/webCore plus html, Component, control flow, context and the DOM helpers
signy/storestore, ReactiveStore, produce, unwrap
signy/routerrouter, Link, Outlet and the route helpers
signy/appapplication and Application
signy/jsx-runtimeThe JSX runtime, see JSX and TypeScript

Other builds

The package also ships ES2017 and ES5 builds in dist, for older browsers, and a global build per entry point, such as signy.core.global.min.js.