LogoSignals.dart
Copy Markdown
rodydavis/signals.dart ★9999⑂99

Installing

Learn how to install and configure Signals for pure Dart, Flutter, and developer tooling.

Signals is built with zero external dependencies and runs anywhere Dart can execute—including the Dart VM, Flutter (iOS, Android, macOS, Windows, Linux, Web), Web (WASM, JS), and server-side environments.

Unified Package: The standard signals package is a unified library that automatically selects the correct Dart-only or Flutter-native bindings depending on your target platform. In most cases, this is the only dependency you need!

Quick Start#

Add the stable release of Signals to your project using the command line:

For pure Dart projects:

dart pub add signals

For Flutter projects:

flutter pub add signals

Package Directory#

For modular development, the ecosystem is divided into specific packages depending on your architecture:

Package Purpose Target Pub Badge
signals Full reactive framework (includes Flutter bindings) Dart & Flutter
signals
signals_flutter UI-bound reactive components and .watch(context) extensions Flutter Only
signals_flutter
signals_core Zero-dependency, ultra-fast reactive primitives Pure Dart / Web
signals_core
signals_lint Real-time static analysis and IDE quick-fixes Dev Tooling
signals_lint
preact_signals Direct low-overhead Dart port of Preact.js Signals Core Engine
preact_signals

Manual Configuration (pubspec.yaml)#

If you prefer to configure dependencies manually, add the following to your pubspec.yaml file: 

dependencies:
  signals: ^7.0.0

Development Release (Direct from Git)#

To track the latest updates on the main branch of the repository:

dependencies:
  signals:
    git:
      url: https://github.com/rodydavis/signals.dart
      ref: main
      path: packages/signals

Linter Integration (signals_lint)#

To guarantee best practices and catch performance gotchas before they hit production, we highly recommend integrating signals_lint into your development environment.

It automatically scans your code in real-time to alert you of common mistakes (such as creating signals inside Flutter build methods or reactive effect blocks) and provides automatic IDE quick-fixes.

1. Add Developer Dependency#

Add the linter package under dev_dependencies in your pubspec.yaml:

dev_dependencies:
  signals_lint: ^7.0.0

2. Enable Analyzer Plugin#

Activate the plugin in your project's analysis_options.yaml file:

analyzer:
  plugins:
    - signals_lint

Once added, restart your editor's Dart Analysis server to start receiving real-time warnings and quick-fixes directly in your IDE!