Om Console #

Om Console is a live console for Flutter that enables viewing UI prints and HTTP requests. It integrates with Postman via curl for enhanced debugging capabilities.

Note: This package is currently in beta. While it functions well on wide screens, mobile support and the ability to copy HTTP requests as form data are still under development.

Screenshots #

1. #

[Om Console Screenshot 1]

2. #

[Om Console Screenshot 2]

3. #

[Om Console Screenshot 3]

4. #

[Om Console Screenshot 4]

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  om_console: ^latest_version

Usage #

1. Configure the main function #

In your main.dart file:

import 'package:om_console/om_console.dart';

void main() async {
  OmConsole.consoleLisitener(() {
    // Your app initialization code here
    runApp(MyApp());
  });
}

2. Wrap your MaterialApp or root widget #

In your app's root widget:

import 'package:om_console/console_wrapper.dart';

@override
Widget build(BuildContext context) {
  return ConsoleWrapper(
    showConsole: true,
    maxLines: 200,
    child: MaterialApp(
      home: HomePage(),
      // Other MaterialApp properties
    ),
  );
}

3. Logging with tags and colors #

Use the Console.log method for custom logging:

Console.log("Your Message or Your object", type: LogType.logs, color: Colors.amber)

Available LogTypes:

• normal
• error
• logs
• http

4. Logging HTTP requests #

For HTTP logging, use the Console.logHttp method:

Console.logHttp(
  url: url,
  method: "Post",
  headers: response.headers ?? {},
  body: data,
  statusCode: responseBody["status"] ?? 500,
  response: responseBody,
  textColor: Colors.black,
  backgroundColor: responseBody["status"] == 200
      ? const Color.fromARGB(255, 207, 223, 190)
      : Color.fromARGB(255, 223, 190, 190)
);

Configuration #

The ConsoleWrapper widget supports the following properties:

• showConsole: Boolean to toggle console visibility.
• maxLines: Integer to set the maximum number of rendered console lines, optimizing performance for large logs.

Limitations and Future Improvements #

• The console is currently optimized for wide screens. Mobile screen support is in development.
• HTTP requests can only be copied as raw data. Support for copying as form data is planned for future releases.
• Search in http requests still under development.

Contributing #

We welcome contributions to Om Console! Please submit issues and pull requests on our GitHub repository.