패키지, 저장소 및 앱 카테고리 검색

패키지 상세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 동작을 요구하는 앱
  • 접근성 중심 애플리케이션
  • 포커스에 대한 동적 반응이 필요한 위젯
  • 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 개

소스 저장소

이 패키지를 사용하는 프로젝트