Skip to main content

avoid-misused-hooks

v1.17.0
warning
effort: 8m
configurable
teams+

Warns when hooks are used in non-hook widgets.

⚙️ Config​

Set ignored-widgets (default is empty) to specify custom hook widgets that should be ignored (example).

analysis_options.yaml
dcm:
  rules:
    - avoid-misused-hooks:
        ignored-widgets:
          - CustomHookWidget

Example​

❌ Bad:

class SomeWidget extends StatelessWidget {
  const SomeWidget();

  @override
  Widget build(BuildContext context) {
    useMemoized(() => {}, keys); // LINT: Avoid using hooks in non-hook widgets.

    return Container();
  }
}

✅ Good:

class SomeHookWidget extends HookWidget {
  const SomeHookWidget();

  @override
  Widget build(BuildContext context) {
    useMemoized(() => {}, keys); // Correct, the widget is a 'HookWidget'

    return Container();
  }
}

Example with "ignored-widgets"​

Config
analysis_options.yaml
dcm:
  rules:
    - avoid-misused-hooks:
        ignored-widgets:
          - CustomHookWidget

✅ Good:

abstract class CustomHookWidget extends StatelessWidget {
  Widget buildWithHooks(BuildContext context, Widget? child);

  @override
  @nonVirtual
  Widget buildWithChild(BuildContext context, Widget? child) =>
      _SingleChildHookBuilder(
        builder: buildWithHooks,
        child: child,
      );

  @override
  @nonVirtual
  Widget build(BuildContext context) => buildWithChild(context, _child);
}

class MyWidget extends CustomHookWidget {
  @override
  Widget buildWithHooks() {
    // Correct, CustomHookWidget is ignored
    useMemoized(() => {}, []);
  }
}
Last updated on