useConnect<T, S extends T> function

Connect<T, S> useConnect<T, S extends T>(Signal<T> signal, { Stream<S>? stream, })

Creates a new Connect instance and automatically disposes of it when the widget unmounts.

Connect connects one or more streams to feed a target signal.

:::tip Clean up is fully automated: when the HookWidget is disposed, all connected streams are unsubscribed, and the connected signal is disposed. :::

Parameters

• signal: The target Signal to feed.
• stream: An optional initial stream to connect immediately.

Example

import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:signals_hooks/signals_hooks.dart';

class StreamingCounterWidget extends HookWidget {
  const StreamingCounterWidget({super.key});

  @override
  Widget build(BuildContext context) {
    final counter = useSignal(0);

    // Automatically connects the periodic stream to the counter signal
    final periodicStream = useMemoized(
      () => Stream.periodic(const Duration(seconds: 1), (i) => i),
    );
    useConnect(counter, periodicStream);

    return Text('Tick count: ${counter.value}');
  }
}

Implementation

Connect<T, S> useConnect<T, S extends T>(
  Signal<T> signal, {
  Stream<S>? stream,
}) {
  final connector = useMemoized(() => connect<T, S>(signal, stream), [signal]);
  useEffect(() => connector.dispose, [connector]);
  return connector;
}