Buscar pacotes, repositórios e categorias de apps

Detalhes do pacotev1.2.0

flutter_overlay_apps

Plugin Android para exibir widgets do Flutter sobre outros aplicativos

Android
Downloads em 30 dias
58
Curtidas
71
Pontos Pub
160

Instalar pacote

flutter pub add flutter_overlay_apps

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

Um plugin do Flutter que permite exibir widgets do Flutter como sobreposições sobre outros aplicativos Android. Ele permite que desenvolvedores criem elementos de interface persistentes, como botões flutuantes, notificações ou exibições de dados em tempo real que permanecem visíveis durante as trocas entre aplicativos. O plugin integra-se às permissões de sobreposição do sistema Android e fornece uma ponte entre o Flutter e a funcionalidade nativa de sobreposição do Android. Projetado especificamente para Android, suporta posicionamento personalizado e interação com o conteúdo da sobreposição.

Casos de uso

  • Controles flutuantes em aplicativos de jogos
  • sobreposições de monitoramento de dados em tempo real
  • Banners de notificação persistentes
  • Ferramentas de assistência no aplicativo
  • Widgets de sobreposição para aplicativos de produtividade

Principais recursos

  • Suporte de sobreposição exclusivo para Android
  • Gerenciamento de permissões do sistema
  • Posicionamento personalizável do widget
  • Elementos de sobreposição interativos
  • Integração suave com a interface do Flutter

Indicado para

  • Desenvolvedores direcionados para recursos de sobreposição do Android
  • Aplicativos que precisam de UI em tela permanente
  • Ferramentas que exigem visibilidade entre aplicativos
  • Aplicativos de melhoria para jogos ou produtividade
  • Interfaces que devem permanecer visíveis durante a troca de aplicativos

Considerações

  • Requer permissão de sobreposição do sistema Android
  • Limitado à plataforma Android
  • Pode ser restrito por fabricantes de dispositivos
  • O usuário deve habilitar manualmente a permissão de sobreposição
  • Impacto potencial no desempenho com sobreposições complexas

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

flutter_overlay_apps

Android plugin for displaying flutter app over other apps

Usage

Add dependency to pubspec.yaml file

Android

You'll need to add the SYSTEM_ALERT_WINDOW permission and OverlayService to your Android Manifest.

    <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
    <application>
        ...
        <service
           android:name="com.phan_tech.flutter_overlay_apps.OverlayService"
           android:exported="false" />
    </application>
Entry point

Inside main.dart create an entry point for your Overlay widget; NOTE: MaterialApp is required

// overlay entry point
@pragma("vm:entry-point")
void showOverlay() {
  runApp(const MaterialApp(
    debugShowCheckedModeBanner: false,
    home: Material(child: Text("My overlay"))
  ));
}
Methods

To open an overlay, call FlutterOverlayApps.showOverlay(). Default height & width is fill screen

FlutterOverlayApps.showOverlay(height: 300, width: 400, alignment: OverlayAlignment.center);

To close the overlay widget call

FlutterOverlayApps.closeOverlay();

To send data to and from Overlay widget, call

FlutterOverlayApps.sendDataToAndFromOverlay(<data>);

For listening to broadcasted data, stream the messages by calling

FlutterOverlayApps.overlayListener().listen((data) {
    print(data);
});
Code Example
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter_overlay_apps/flutter_overlay_apps.dart';

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

// overlay entry point
@pragma("vm:entry-point")
void showOverlay() {
  runApp(const MaterialApp(
    debugShowCheckedModeBanner: false,
    home: MyOverlaContent()
  ));
}


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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {

              // Open overlay
              await FlutterOverlayApps.showOverlay(height: 300, width: 400, alignment: OverlayAlignment.center);

              // send data to ovelay
              await Future.delayed(const Duration(seconds: 2));
              FlutterOverlayApps.sendDataToAndFromOverlay("Hello from main app");
            }, 
            child: const Text("showOverlay")
          ),
        ),
      ),
    );
  }
}



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

  @override
  State<MyOverlaContent> createState() => _MyOverlaContentState();
}

class _MyOverlaContentState extends State<MyOverlaContent> {
  String _dataFromApp = "Hey send data";

  @override
  void initState() {
    super.initState();

    // lisent for any data from the main app
    FlutterOverlayApps.overlayListener().listen((event) {
      setState(() {
        _dataFromApp = event.toString();
      });
    });
  }

  @override
  Widget build(BuildContext context) {
    return Material(
      child: InkWell(
        onTap: (){
          // close overlay
          FlutterOverlayApps.closeOverlay();
        },
        child: Card(
          shape: RoundedRectangleBorder(
            borderRadius: BorderRadius.circular(16),
          ),
          child: Center(child: Text(_dataFromApp, style: const TextStyle(color: Colors.red),)),
        ),
      ),
    );
  }
}

Android back button

The back navigation button on android will close the overlay app. To prevent this, set closeOnBackButton to false. Example;

await FlutterOverlayApps.showOverlay(
  height: 300,
  closeOnBackButton: false,
  alignment: OverlayAlignment.center);

When closeOnBackButton is set to false, an action will be sent via the stream controller. You can get the action like the example below;

var overlayStreamController = FlutterOverlayApps.overlayListener();

overlayStreamController.stream.listen((event) {
  if(event['method'] == 'backButton'){
    // handle back button 
    if(mounted && Navigator.of(context).canPop()){
      Navigator.of(context).pop();
    }
  }
})

Support the plugin Buy Me A Coffee

Categorias

Repositório-fonte

Projetos que usam este pacote

Ainda não há dados.