https://github.com/zitherharpcommunity/blue_screen
A BlueScreen widget replaces the default ErrorWidget used for Flutter apps.
https://github.com/zitherharpcommunity/blue_screen
dart flutter pubdev
Last synced: 4 days ago
JSON representation
A BlueScreen widget replaces the default ErrorWidget used for Flutter apps.
- Host: GitHub
- URL: https://github.com/zitherharpcommunity/blue_screen
- Owner: zitherharpcommunity
- License: mit
- Created: 2023-12-12T16:45:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-24T14:38:46.000Z (over 2 years ago)
- Last Synced: 2025-10-23T05:39:50.144Z (7 months ago)
- Topics: dart, flutter, pubdev
- Language: Dart
- Homepage: https://pub.dev/packages/blue_screen
- Size: 12.8 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# blue_screen
A BlueScreen widget replaces the default ErrorWidget used for Flutter apps.
> The **Blue Screen of Death (BSoD)**, **Blue screen error**, **Blue Screen**, **fatal error**, or **bugcheck**,
and officially known as a **Stop error**, is a critical error screen displayed
by the *Microsoft Windows* and *ReactOS* operating systems in the event of a fatal system error.
The Blue Screen of Death indicates a system crash, in which the operating system
has reached a critical condition where it can no longer operate safely.
Possible issues include hardware failure, an issue with or without a device driver,
or unexpected termination of a crucial process or thread.
## Features
- Support run app in a safe mode with `runSafeMode` function or wrap widgets in a `SafeModeBuilder` to avoid throw an exception when run app in release mode.
- You can use a `BlueScreenWidget` instead of the default `ErrorWidget` of Flutter to show error messages with `BlueScreenBuilder` widget or use it likes other widgets in your app.
> **Safe mode** is a diagnostic mode of a computer operating system (OS). It can also refer to a mode of operation by application software. Safe mode is intended to help fix most, if not all, problems within an operating system. It is also widely used for removing rogue security software.
## Getting started
### Add the package to the app
- To add the `blue_screen` package as a dependency, run this command in your project terminal:
```sh
flutter pub add blue_screen
```
> See more details at [Installing](https://pub.dev/packages/blue_screen/install) page.
### Declare the font assets (optional)
- Now that you've imported the package, tell Flutter where to find the fonts from the `blue_screen`.
- To declare fonts in this package, prefix the path to the font with `packages/blue_screen`.
This tells Flutter to look in the `lib` folder of the package for the font.
> See all fonts and other data assets at [here](/example/README.md).
```yaml
flutter:
fonts:
- family:
fonts:
- asset: packages/blue_screen/fonts/
```
- To use fonts in this package, declare which font you'd like to use like this.
```dart
...
fontFamily: '',
...
```
## Usage
> See complete example at [Example](https://pub.dev/packages/blue_screen/example) page
and **live demo** at [here](https://zitherharpcommunity.github.io/blue_screen).
```dart
import 'package:blue_screen/blue_screen.dart';
/// Flutter code sample for [BlueScreenWidget].
void main() {
// Put the app in a safe mode.
runSafeMode(() {
// Start the app.
runApp(const BlueScreenExampleApp());
});
}
```
## Additional information
Please request features and bugs for us at the [issue](https://github.com/zitherharpcommunity/blue_screen/issues) page.