Get Started

Getting Started

Welcome to reactjs-signal! A lightweight state management library for React using the Signal pattern to share store state across components.

Installation

You can install reactjs-signal using your preferred package manager:

npm install reactjs-signal

yarn add reactjs-signal

pnpm add reactjs-signal

bun add reactjs-signal

Quick Start

Once installed, you can start using reactjs-signal in your React application:

import React from 'react';
import { useSignal } from 'reactjs-signal';

const App = () => {
  const [state, setState] = useSignal({ count: 0 });

  return (
    <div>
      <h1>Count: {state.count}</h1>
      <button onClick={() => setState({ count: state.count + 1 })}>
        Increment
      </button>
    </div>
  );
};

export default App;

Requirements

• React 16.8 or higher (requires Hooks support)
• TypeScript 4.0+ (optional, for TypeScript projects)

Next Steps

Now that you have reactjs-signal installed, you can:

• Explore the API documentation to learn about all available features
• Check out more advanced examples and patterns
• Install the devtools extension for debugging