# flutter_lifecycle

**Repository Path**: djun100/flutter_lifecycle

## Basic Information

- **Project Name**: flutter_lifecycle
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-05
- **Last Updated**: 2024-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# flutter_lifecycle

flutter页面生命周期插件；可根据这个插件设计项目基类widget,底下demo

## 接入步骤：
* 1. 引入

```
import 'package:flutter_lifecycle/flutter_lifecycle.dart';
```

* 2. MaterialApp进行设置navigatorObservers: [defaultLifecycleObserver]

```
MaterialApp(
      navigatorObservers: [defaultLifecycleObserver],
      routes: {
        'sub1': (_) => Sub1(),
        'nav2': (_) => const Nav2Home(),
      },
      home: HomePage(),
    );
```

* 3. 需要获取页面生命周期的可以直接套上BasePageLifecycle，提供以下方法：

```
@override
  Widget build(BuildContext context) {
    return BasePageLifecycle(
      //是否是滚动视图的子组件，默认false
      isScrollViewItem: true,
      onPageCreate: (){
        debugPrint("onPageCreate ${widget.txt}");
      },
      onPageShow: (){
        debugPrint("onPageShow ${widget.txt}");
      },
      onPageHide: (){
        debugPrint("onPageHide ${widget.txt}");
      },
      onPageDispose: (){
        debugPrint("onPageDispose ${widget.txt}");
      },
      onForeground: (){
        debugPrint("onForeground ${widget.txt}");
      },
      onInactive: () {
        debugPrint("onInactive ${widget.txt}");
      },
      onBackground: (){
        debugPrint("onBackground ${widget.txt}");
      },
      child: Container(
        color: widget.color,
        alignment: Alignment.center,
        child: Text(
          widget.txt,
          style: const TextStyle(color: Colors.white, fontSize: 28),
        ),
      ),
    );
```

* ps. 也可以自定义StatefulWidget,继承LifecycleState来实现，具体参考BasePageLifecycle类的实现

```
  ///页面创建
  void onPageCreate();
  ///页面展示
  void onPageShow();
  ///页面隐藏
  void onPageHide();
  ///页面销毁
  void onPageDispose();
  ///回调前台
  void onForeground();
  ///失去活动
  void onInactive();
  ///进入后台
  void onBackground();
  
  /// 是否需要APP状态通知, true需要，false不需要
  /// background 、foreground 、inactive
  bool get needAppLifecycleEvent => true;

  /// 是否需要页面生命通知, true需要，false不需要
  /// create、show、hide、dispose
  bool get needPageLifecycleEvent => true;
```

##  以下demo:

```
///基础容器
class BasePage extends StatefulWidget {
  final Widget? child;
  final VoidCallback? onPageCreate;
  final VoidCallback? onPageShow;
  final VoidCallback? onPageHide;
  final VoidCallback? onPageDispose;
  final VoidCallback? onBackground;
  final VoidCallback? onForeground;
  final VoidCallback? onInactive;

  const BasePage({
    Key? key,
    this.child,
    this.onPageCreate,
    this.onPageShow,
    this.onPageHide,
    this.onPageDispose,
    this.onBackground,
    this.onForeground,
    this.onInactive,
  })  : super(key: key);

  @override
  State createState() {
    return _BasePageState();
  }
}

class _BasePageState extends LifecycleState<BasePage> {

  /// 是否需要APP状态通知, true需要，false不需要
  /// background 、foreground 、inactive
  @override
  bool get needAppLifecycleEvent => widget.onBackground != null || widget.onForeground != null;

  /// 是否需要页面生命通知, true需要，false不需要
  /// create、show、hide、dispose
  @override
  bool get needPageLifecycleEvent => widget.onPageCreate != null ||
      widget.onPageShow != null ||
      widget.onPageHide != null ||
      widget.onPageDispose != null;

  @override
  void onPageCreate() {
    widget.onPageCreate?.call();
  }

  @override
  void onPageDispose() {
    widget.onPageDispose?.call();
  }

  @override
  void onPageShow() {
    widget.onPageShow?.call();
  }

  @override
  void onPageHide() {
    widget.onPageHide?.call();
  }

  @override
  void onBackground() {
    widget.onBackground?.call();
  }

  @override
  void onForeground() {
    widget.onForeground?.call();
  }

  @override
  void onInactive() {
    widget.onInactive?.call();
  }

  @override
  Widget build(BuildContext context) {
    return Container( 
      child: widget.child,
    );
  }
}
```