Getting started

Install

Add the package to a Jaspr application:

dependencies:
  jaspr_hooks: ^0.1.2

Import the public library and extend HookComponent:

import 'package:jaspr/dom.dart';
import 'package:jaspr/jaspr.dart';
import 'package:jaspr_hooks/jaspr_hooks.dart';

class Greeting extends HookComponent {
  const Greeting({super.key});

  @override
  Component build(BuildContext context) {
    final excited = useState(false);

    return button(
      onClick: () => excited.value = !excited.value,
      [Component.text(excited.value ? 'Hello!' : 'Hello')],
    );
  }
}

Use StatefulHookComponent when hooks need to coexist with a Jaspr State, PreloadStateMixin, or SyncStateMixin. For a small hook-enabled subtree, use HookBuilder.

Choose the next page

• Read the rules of hooks before extracting custom hooks.
• Read SSR and hydration before using effects, futures, streams, or browser APIs.
• Browse the hook catalog for API-specific examples.