screen_helper:

A package that provides essential tools for Flutter developers to access device screen details, including PPI, screen size in inches, resolution in pixels, and conversion from millimeters to pixels.

Table of Contents

• Features
• Getting Started
• Usage
• Example

Features

• Get screen PPI (Pixels Per Inch).
• Get screen width and height and diagonal size in pixels.
• Get screen width and height and diagonal size in inches.
• Convert millimeters to pixels and vice versa.
• Convert inches to pixels and vice versa.
• Convert centimeters to pixels and vice versa.

Getting Started

In your flutter project add the dependency:

dependencies:
  screen_helper: ^1.0.0

Usage

Wrap your app with ScreenHelperWidget to provide screen information to all descendant widgets:

import 'package:screen_helper/screen_helper.dart';

void main() {
  runApp(
    /// Wrap your app with ScreenHelperWidget to provide screen information
    /// to all descendant widgets
    ScreenHelperWidget(
      child: const MyApp(),
    ),
  );
}

Access screen information

To get screen information, use ScreenInfo.maybeOf(context)

final screenInfo = ScreenInfo.maybeOf(context);

available data:

/// Get screen size in inches {width: , height: }
final Map<String, double> screenSizeInInches = screenInfo.screenSizeInInches;

/// Get screen resolution in pixels {width: , height: }
final Map<String, double> screenResolution = screenInfo.screenResolution;
/// Get screen Dot per inch
final double dpi = screenInfo.dpi;

/// Get screen pixel per inch
final double ppi = screenInfo.ppi;

/// Get screen width in inches
final double screenWidthInInches = screenInfo.screenWidthInInches;

/// Get screen height in inches
final double screenHeightInInches = screenInfo.screenHeightInInches;

/// Get screen diagonal size in inches
final double screenDiagonalInInches = screenInfo.screenDiagonalInInches;

/// Get screen width in pixels
final double screenWidthInPixels = screenInfo.screenWidthInPixels;

/// Get screen height in pixels
final double screenHeightInPixels = screenInfo.screenHeightInPixels;

/// Get screen aspect ratio
final double screenAspectRatio = screenInfo.screenAspectRatio;

Convert from one unit to another

To convert between different units, you can use the extension methods on BuildContext:

  // Access the BuildContext, typically in a build method
  Widget build(BuildContext context) {
  // Convert  millimeters to pixels
  double mmToPx = context.mmToPx(double mm);
  // Convert  pixels to millimeters
  double pxToMm = context.pxToMm(int px);
  // Convert  centimeters to pixels
  double cmToPx = context.cmToPx(double cm);
  // Convert  pixels to centimeters
  double pxToCm = context.pxToCm(int px);
  // Convert  inches to pixels
  double inchesToPx = context.inchesToPx(double inches);
  // Convert  pixels to inches
  double pxToInches = context.pxToInches(int px);
  }

Example

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

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    // Wrap your app with ScreenHelperWidget to provide screen information
    // to all descendant widgets
    return ScreenHelperWidget(
      child: MaterialApp(
        debugShowCheckedModeBanner: false,
        home: Scaffold(
          appBar: AppBar(
            title: const Text('Screen Helper Example App'),
          ),
          body: const Center(
            child: Padding(
              padding: EdgeInsets.all(16.0),
              child: ScreenInfoDisplay(),
            ),
          ),
        ),
      ),
    );
  }
}

class ScreenInfoDisplay extends StatefulWidget {
  const ScreenInfoDisplay({super.key});

  @override
  State<ScreenInfoDisplay> createState() => _ScreenInfoDisplayState();
}

class _ScreenInfoDisplayState extends State<ScreenInfoDisplay> {
  double _lineLengthMm = 15.0;

  @override
  Widget build(BuildContext context) {
    // Access screen information using ScreenInfo.of(context)
    final screenInfo = ScreenInfo.maybeOf(context);
    if (screenInfo == null) {
      return const CircularProgressIndicator();
    }

    // Use the extension method to convert mm to pixels
    final lineLengthInPixels = context.mmToPx(_lineLengthMm);

    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      crossAxisAlignment: CrossAxisAlignment.start,
      children: <Widget>[
        // Display various screen properties
        Text(
          'Screen PPI: ${screenInfo.ppi.toStringAsFixed(2)}',
          style: const TextStyle(fontSize: 16),
        ),
        const SizedBox(height: 10),
        Text(
          'Screen Diagonal Size (in inches): ${screenInfo.screenDiagonalInInches.toStringAsFixed(2)}',
          style: const TextStyle(fontSize: 16),
        ),
        const SizedBox(height: 10),
        Text(
          'Screen Width (in inches): ${screenInfo.screenWidthInInches.toStringAsFixed(2)}',
          style: const TextStyle(fontSize: 16),
        ),
        const SizedBox(height: 10),
        Text(
          'Screen Height (in inches): ${screenInfo.screenHeightInInches.toStringAsFixed(2)}',
          style: const TextStyle(fontSize: 16),
        ),
        const SizedBox(height: 10),
        Text(
          'Screen Real Width (in pixels): ${screenInfo.screenWidthInPixels.toStringAsFixed(0)}',
          style: const TextStyle(fontSize: 16),
        ),
        const SizedBox(height: 10),
        Text(
          'Screen Real Height (in pixels): ${screenInfo.screenHeightInPixels.toStringAsFixed(0)}',
          style: const TextStyle(fontSize: 16),
        ),
        const SizedBox(height: 20),
        Text(
          "Line length: ${_lineLengthMm.toStringAsFixed(1)} mm",
          style: const TextStyle(fontSize: 16),
        ),
        Slider(
          value: _lineLengthMm,
          min: 1,
          max: 100,
          divisions: 99,
          label: _lineLengthMm.round().toString(),
          onChanged: (double value) {
            setState(() {
              _lineLengthMm = value;
            });
          },
        ),
        const SizedBox(height: 10),
        Text(
          "Line length in pixels: ${lineLengthInPixels.toStringAsFixed(2)}",
          style: const TextStyle(fontSize: 16),
        ),
        const SizedBox(height: 10),
        // Display a line with the converted length
        Center(
          child: Container(
            width: lineLengthInPixels,
            height: 2.0,
            color: Colors.black,
          ),
        ),
      ],
    );
  }
}

Contributing

We welcome contributions to the screen_helper package! If you'd like to contribute, here are some guidelines to help you get started:

How to Contribute

1. Fork the Repository:

• Start by forking the GitHub repository and creating a new branch for your feature or bug fix.

2. Clone Your Fork:

• Clone your forked repository to your local machine.

  git clone https://github.com/your-username/screen_helper.git
  cd screen_helper
  

3. Create a Branch:

• Create a new branch for your feature or bug fix.

  git checkout -b feature/your-feature-name
  

4. Make Changes:

• Make your changes in your branch. Ensure your code follows the existing style and conventions used in the project.

5. Test Your Changes:

• Test your changes thoroughly. If you've added new features or fixed bugs, include tests where appropriate.

6. Commit and Push:

• Commit your changes with a clear commit message.

  git add .
  git commit -m "Description of the changes you made"
  git push origin feature/your-feature-name
  

7. Submit a Pull Request:

• Open a pull request from your branch on GitHub. Provide a clear description of what you've done and reference any related issues.

Libraries

screen_extension

screen_helper

screen_helper_method_channel

screen_helper_platform_interface

screen_helper_widget

screen_info_data