搜索插件、代码仓与 APP 分类

插件详情v2.0.1

focus_on_it

当小部件获得或失去焦点时收到通知,并作出相应反应。

AndroidiOSmacOSWindowsLinux
近 30 天下载
1.2万
喜欢数
49
Pub 分数
160

安装插件

flutter pub add focus_on_it

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

focus_on_it 包提供了一种简单的方法,用于检测 Flutter 应用中的小部件何时获得或失去焦点。它允许开发者通过执行自定义逻辑来响应焦点变化,例如更新 UI 状态、触发动画或验证输入。这对于表单、交互式组件和辅助功能特别有用。该包可与现有小部件无缝集成,并支持所有主要平台,包括 Android、iOS、macOS、Windows 和 Linux。

适合场景

  • 表单字段交互跟踪
  • 无障碍功能增强
  • 基于焦点的动态UI更新
  • 输入验证在焦点变化时
  • 自定义焦点效果

主要特点

  • 简单的焦点事件监听器
  • 跨平台支持
  • 最小化样板代码
  • 与现有小部件的轻松集成
  • 实时焦点状态检测

适合对象

  • 开发交互式表单的开发者
  • 需要基于焦点的 UI 行为的应用程序
  • 面向可访问性的应用程序
  • 需要对焦点动态响应的 Widgets
  • Flutter 初学者学习状态管理

使用建议

  • 在复杂的控件树中可能需要仔细处理
  • 焦点事件可能会以快速连续的方式触发
  • 不适用于高性能关键路径
  • 限制为小部件级别的焦点检测
  • 依赖于 Flutter 的焦点系统稳定性

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Flutter Focus On It Package

Pub.dev Badge GitHub Build Badge Effective Dart Badge MIT License Badge Flutter Platform Badge

Focus on It is a Dart library that allows you to get notified when a Flutter widget is focused or unfocused and react to it.

It is a continuation of the Focus Detector project, which is no longer maintained.

About

Similar to the onResume()/onPause() methods on Android and the viewDidAppear()/viewDidDisappear() methods on iOS, Focus on It lets you know when a Flutter widget is focused or unfocused and gives you the opportunity to do something about it. You can use callbacks to get more control over your app and manage the events you want, such as:

  • Pause a video when the user is not looking at it.
  • Stop a camera preview when the user is not looking at it and start it again when the user looks at it.
  • Turn off a resource-intensive feature when the user is not looking at it and turn it on again when the user looks at it.
  • Sync data with an API when the user opens a screen.
  • And much more!

Installation

To install Focus on It, you can use either of the following methods:

Method 1: flutter pub add

Use the flutter pub add command to install Focus on It:

flutter pub add focus_on_it
Method 2: pubspec.yaml

Alternatively, you can add the following line to your pubspec.yaml file:

dependencies:
  focus_on_it: ^VERSION

Replace VERSION with the latest version of Focus on It. You can find the latest version on the pub.dev page.

Then, run flutter pub get to install the library.

Import the library into your code by adding the following line at the top of your file:

import 'package:focus_on_it/focus_on_it.dart';

Events

Focus on It offers 13 events to help you manage your app:

  • onFocus: Equivalent to onResume() on Android and viewDidAppear() on iOS. Triggered when the Flutter widget is focused after a route transition or when the widget is resumed from a paused state.
  • onUnfocus: Equivalent to onPause() on Android and viewDidDisappear() on iOS. Triggered when the Flutter widget is unfocused after a route transition or when the widget is paused from a focused state.
  • onForegroundGained: Triggered when the app is resumed from a paused state.
  • onForegroundLost: Triggered when the app is paused from a resumed state.
  • onVisibilityGained: Triggered when the Flutter widget is visible after a route transition.
  • onVisibilityLost: Triggered when the Flutter widget is no longer visible after a route transition.
  • onDetach: Triggered when the app is detached from the view hierarchy.
  • onExitRequested: Triggered when an exit request is made for the app.
  • onHide: Triggered when the app's window becomes hidden.
  • onInactive: Triggered when the app enters an inactive state.
  • onRestart: Triggered when the app is restarted.
  • onShow: Triggered when the app's window becomes visible.
  • onStateChange: Callback for handling app lifecycle state changes, providing information about both the old and new app lifecycle states.

Usage

@override
Widget build(BuildContext context) =>
    FocusOnIt(
      onFocus: () {
        /// Equivalent to `onResume()` on Android and `viewDidAppear()` on iOS. 
        /// Triggered when the widget is focused after route transition or the widget resumed from a paused state.
        logger.i('Focus Gained.');
      },
      onUnfocus: () {
        /// Equivalent to `onPause()` on Android and `viewDidDisappear()` on iOS. 
        /// Triggered when the widget is unfocused after route transition or the widget paused from a focused state.
        logger.i('Focus Lost.');
      },
      onForegroundGained: () {
        /// Triggered when the app is resumed from a paused state.
        logger.i('Foreground Gained.');
      },
      onForegroundLost: () {
        /// Triggered when the app is paused from a resumed state.
        logger.i('Foreground Lost.');
      },
      onVisibilityGained: () {
        /// Triggered when the widget is visible after route transition.
        logger.i('Visibility Gained.');
      },
      onVisibilityLost: () {
        /// Triggered when the widget is no longer visible after route transition.
        logger.i('Visibility Lost.');
      },
      onDetach: () {
        /// Triggered when the widget is detached from the widget tree.
        logger.i('Detach.');
      },
      onExitRequested: () async {
        /// Triggered when the app is requested to exit.
        logger.i('Exit Requested.');
        return AppExitResponse.exit;
      },
      onHide: () {
        /// Triggered when the app is hidden.
        logger.i('Hide.');
      },
      onInactive: () {
        /// Triggered when the app is inactive.
        logger.i('Inactive.');
      },
      onRestart: () {
        /// Triggered when the app is restarted.
        logger.i('Restart.');
      },
      onShow: () {
        /// Triggered when the app is shown.
        logger.i('Show.');
      },
      onStateChange: (oldState, newState) {
        /// Triggered when the app state changes.
        logger.i('State Change: $oldState -> $newState');
      },
      child: const Placeholder(),
    );

Testing

Please note that enabling the test environment variable (TEST=true) is only necessary when testing in a web environment. For iOS and Android, this configuration is automatically handled.

Web Testing (if applicable)
  1. Set the test environment variable:

    • To enable the testing fix in web environments, you can set the TEST environment variable to true when running the flutter run command. Use the following command:

      flutter test --dart-define=TEST=true {file}
      
  2. Run your tests:

    • Now you can run your tests as usual to ensure that the behavior of the FocusOnIt package is as expected.

Example

To see an example of how to use Focus on It, check out the following file in this repository:

Contributing

We welcome contributions to the Focus on It project! If you would like to contribute, please feel free to reach out to the current maintainers for more information.

Issues

If you encounter any issues while using Focus on It, please open a new issue in the issue tracker. Please include as much information as possible, such as the version of Focus on It you are using and steps to reproduce the issue.

License

Focus on It is licensed under the MIT license. See LICENSE for more information.

所属分类

依赖

依赖清单 2 项

源码仓库

使用此插件的项目