Flutter页面导航与控制插件pagepilot的使用

Flutter页面导航与控制插件pagepilot的使用

该插件用于在你的应用中快速且简便地集成PagePilot。

示例代码

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:pagepilot/models/config_model.dart';
import 'package:pagepilot/models/styles_model.dart';
import 'package:pagepilot/pagepilot.dart';
import 'app_theme.dart';

void main() {
  runApp(MyApp());
}

// TODO : 添加你的凭证
const applicationId = "";
const userId = "21"; //1234

GlobalKey keyDialog = GlobalKey();
GlobalKey keyTooltip = GlobalKey();
GlobalKey keyBeacon = GlobalKey();

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = '未知';
  final _pagepilotPlugin = Pagepilot();

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
    initPagePilot();
  }

  // 平台消息是异步的,所以我们通过异步方法进行初始化。
  Future<void> initPlatformState() async {
    String platformVersion;
    // 平台消息可能会失败,所以我们使用一个try/catch来处理PlatformException。
    // 我们还处理消息可能返回null的情况。
    try {
      platformVersion = await _pagepilotPlugin.getPlatformVersion() ?? 
          '未知平台版本';
    } on PlatformException {
      platformVersion = '获取平台版本失败。';
    } catch (e) {
      print(e.toString());
      platformVersion = '获取平台版本失败。';
    }

    // 如果小部件从树中被移除时异步平台消息还在飞行,我们想丢弃回复而不是调用setState来更新我们的非存在的外观。
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  initPagePilot() async {
    Map<String, GlobalKey> keys = {
      '#dialog': keyDialog,
      '#tooltip': keyTooltip,
      '#beacon': keyBeacon
    };

    Config config = Config(
      credentials: {
        "applicationId": applicationId,
      },
      keys: keys,
      styles:
          Styles(shadowColor: Colors.blue, shadowOpacity: 0.3, textSkip: "OK"),
    );
    try {
      await _pagepilotPlugin.init(config!); // 初始化库
      _pagepilotPlugin.setUserIdentifier(userId: userId);
    } on PlatformException {
      // 记录异常并报告给studio@gameolive.com
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      theme: AppTheme.lightTheme,
      home: App(
        platformVersion: _platformVersion,
        pagepilotPlugin: _pagepilotPlugin,
      ),
    );
  }
}

class App extends StatelessWidget {
  final String platformVersion;
  final Pagepilot pagepilotPlugin;

  App({
    super.key,
    required this.platformVersion,
    required this.pagepilotPlugin,
  });

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('插件示例应用'),
      ),
      body: Column(
        children: [
          Center(
            child: Text('运行于: $platformVersion\n'),
          ),
          ElevatedButton(
            key: keyBeacon,
            onPressed: () {
              pagepilotPlugin.show(context: context, screen: "home"); // 显示名为"home"的屏幕
            },
            child: Text("点击我!"),
          ),
          SizedBox(height: 20),
          Row(
            mainAxisAlignment: MainAxisAlignment.spaceAround,
            children: [
              Text(key: keyDialog, '对话框'),
              Text(key: keyTooltip, '工具提示'),
            ],
          ),
          SizedBox(height: 20),
          Center(
            child: Text('引导'),
          ),
        ],
      ),
    );
  }
}

更多关于Flutter页面导航与控制插件pagepilot的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter页面导航与控制插件pagepilot的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


PagePilot 是一个用于 Flutter 应用中进行页面导航和控制的插件。它旨在简化页面之间的导航逻辑,并提供更灵活的控制方式。以下是如何使用 PagePilot 的基本步骤和示例。

1. 添加依赖

首先,你需要在 pubspec.yaml 文件中添加 pagepilot 插件的依赖:

dependencies:
  flutter:
    sdk: flutter
  pagepilot: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

2. 初始化 PagePilot

在你的应用中初始化 PagePilot,通常在 main.dart 文件中进行:

import 'package:flutter/material.dart';
import 'package:pagepilot/pagepilot.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  final PagePilot _pagePilot = PagePilot();

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: _pagePilot.navigatorKey,
      onGenerateRoute: _pagePilot.onGenerateRoute,
      initialRoute: '/',
      routes: {
        '/': (context) => HomePage(),
        '/second': (context) => SecondPage(),
      },
    );
  }
}

3. 页面导航

在需要导航的地方,使用 PagePilot 提供的导航方法:

class HomePage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Home Page'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            PagePilot.of(context).push('/second');
          },
          child: Text('Go to Second Page'),
        ),
      ),
    );
  }
}

class SecondPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Second Page'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            PagePilot.of(context).pop();
          },
          child: Text('Go back to Home Page'),
        ),
      ),
    );
  }
}

4. 其他导航方法

PagePilot 提供了多种导航方法,例如:

  • pushReplacement: 替换当前页面。
  • pushAndRemoveUntil: 导航到新页面并移除之前的页面。
  • popUntil: 返回到指定的页面。
PagePilot.of(context).pushReplacement('/second');
PagePilot.of(context).pushAndRemoveUntil('/second', (route) => false);
PagePilot.of(context).popUntil('/');

5. 传递参数

你还可以在导航时传递参数:

PagePilot.of(context).push('/second', arguments: {'message': 'Hello from Home Page'});

class SecondPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    final Map<String, dynamic> args = ModalRoute.of(context)!.settings.arguments as Map<String, dynamic>;
    final String message = args['message'];

    return Scaffold(
      appBar: AppBar(
        title: Text('Second Page'),
      ),
      body: Center(
        child: Text(message),
      ),
    );
  }
}

6. 自定义路由

你还可以通过 PagePilot 自定义路由:

_pagePilot.registerRoute(
  '/custom',
  (RouteSettings settings) {
    return MaterialPageRoute(
      builder: (context) => CustomPage(),
      settings: settings,
    );
  },
);

7. 处理返回按钮

你可以使用 PagePilot 来处理返回按钮的逻辑:

WillPopScope(
  onWillPop: () async {
    return !await PagePilot.of(context).maybePop();
  },
  child: Scaffold(
    // Your widget tree
  ),
);
回到顶部