screen_on_view #

A Flutter plugin that allows you to show a custom Flutter widget when the device screen turns on.
Useful for creating lockscreen-style popups like CashWalk or simple greeting screens.

Platform Support #

📌 Key Concepts & Warnings #

This plugin, unlike screen_on_view, uses a separate Flutter engine. While it is disadvantageous for state management, it has the advantage of making Flutter engine management easier.

Therefore, the app is separated into two Activitys:

• MainActivity: the main app content
• LockScreenActivity: used to show the popup when the screen turns on

⚙️ Setup Instructions (Required) #

Installation #

Add this to your pubspec.yaml:

dependencies:
  screen_on_view: ^0.1.1

Usage #

Add the following import to your Dart code:

import 'package:screen_on_view/screen_on_view.dart';

🔧 Initialization Code #

/// Main entry point when the app launches normally
void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // Specify the entry point to launch when the screen turns on
  final service = ScreenOnView(entryPointName: "main2");

  // Request the necessary permission
  await service.requestPermission();

  // Start the background service
  await service.startService(
    model: AlarmModel(
      title: "Screen_On_View",
      content: "Start foreground service",
    ),
  );

  // Launch the main app
  runApp(
    MaterialApp(
      debugShowCheckedModeBanner: false,
      home: MainApp(service: service),
    ),
  );
}

/// Entry point launched when the screen turns on
@pragma('vm:entry-point')
void main2() {
  runApp(MaterialApp(debugShowCheckedModeBanner: false, home: LockScreen()));
}

📲 API Usage #

▶️ Start the service #

await service.startService(
    model: AlarmModel(
        title: "Screen_On_View",
        content: "Start foreground service",
    ),
);

⏹ Stop the service #

await screenService.endService()

🔐 Request permission #

await screenService.requestPermission()

If permissions are already granted, this will be ignored.

🧪 Full Example #

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:screen_on_view/class/alarm_model.dart';
import 'package:screen_on_view/screen_on_view.dart';

/// Main entry point when the app launches normally
void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // Specify the entry point to launch when the screen turns on
  final service = ScreenOnView(entryPointName: "main2");

  // Request the necessary permission
  await service.requestPermission();

  // Start the background service
  await service.startService(
    model: AlarmModel(
      title: "Screen_On_View",
      content: "Start foreground service",
    ),
  );

  // Launch the main app
  runApp(
    MaterialApp(
      debugShowCheckedModeBanner: false,
      home: MainApp(service: service),
    ),
  );
}

/// Entry point launched when the screen turns on
@pragma('vm:entry-point')
void main2() {
  runApp(MaterialApp(debugShowCheckedModeBanner: false, home: LockScreen()));
}

/// The main app screen
class MainApp extends StatelessWidget {
  final ScreenOnView service;
  const MainApp({super.key, required this.service});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Screen On View Example')),
      body: Center(
        child: ElevatedButton(
          onPressed: () => service.endService(),
          child: const Text("Stop Service"),
        ),
      ),
    );
  }
}

/// The screen shown when the device screen turns on
class LockScreen extends StatelessWidget {
  const LockScreen({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      backgroundColor: Colors.white,
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Icon(Icons.wb_sunny, color: Colors.orange, size: 80),
            const SizedBox(height: 20),
            const Text(
              'Screen On Detected!',
              style: TextStyle(fontSize: 24, color: Colors.black),
            ),
            const SizedBox(height: 40),
            ElevatedButton(
              onPressed: () => SystemNavigator.pop(),
              child: const Text('Close'),
            ),
          ],
        ),
      ),
    );
  }
}

License #

This project is licensed under the MIT License.