Installation#

@banksia/signals is available on npm and JSR. It requires Node.js >= 20 (or modern evergreen browsers).

Package Managers#

pnpm#

pnpm add @banksia/signals

npm#

npm install @banksia/signals

yarn#

yarn add @banksia/signals

bun#

bun add @banksia/signals

JSR#

npx jsr add @banksia/signals

Framework Peer Dependencies#

The core package @banksia/signals has zero external runtime dependencies.

Framework adapters are optional and available via dedicated subpath exports. Install the corresponding peer dependency if using an adapter:

Example installing with React:

pnpm add @banksia/signals react react-dom

Example installing with Lit:

pnpm add @banksia/signals lit

Example installing with Solid:

pnpm add @banksia/signals solid-js

TypeScript Configuration#

@banksia/signals includes complete, strict TypeScript type declarations. For optimal type inference and modern subpath resolution, configure your tsconfig.json:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "strict": true,
    "skipLibCheck": true
  }
}