dot_matrix_text 0.1.0

A Flutter plugin for creating customizable dot matrix text displays. This package allows developers to easily implement retro-style LED text effects with adjustable LED size, spacing, colors, and dyna [...]

Dot Matrix Text Plugin for Flutter

A Flutter plugin for creating customizable dot matrix text displays.

Features

• Customizable LED size and spacing
• Adjustable text style and color
• Mirror mode for reversed text display
• Flicker mode for dynamic LED effects
• Invert colors for different display styles
• Customizable board size

Getting Started

To use this plugin, add dot_matrix_text as a dependency in your pubspec.yaml file:

dependencies:
  dot_matrix_text: ^0.1.0

Parameters

Parameter	Type	Default	Description
text	String	Required	The text to be displayed in dot matrix style.
ledSize	double	4.0	The size of each LED dot.
ledSpacing	double	2.0	The spacing between each LED dot.
blankLedColor	Color	Color.fromRGBO(10, 10, 10, 1)	The color of the LEDs that are off (blank).
boardSize	Size?	null	The size of the board displaying the text. If null, size is calculated based on text.
textStyle	TextStyle	TextStyle(fontSize: 100.0, fontWeight: FontWeight.bold, color: Colors.red)	The text style for the displayed text.
mirrorMode	bool	false	Whether to mirror the text horizontally.
flickerMode	bool	false	Whether to enable a flickering effect on the LEDs.
invertColors	bool	false	Whether to invert the colors of the LEDs.
alignment	Alignment	Alignment.center	The alignment of the text within the board.

Usage

Import the package in your Dart code:

import 'package:dot_matrix_text/dot_matrix_text.dart';

Basic usage:

DotMatrixText(text: 'Hello World');

Customizing Appearance

You can customize various aspects of the dot matrix display:

DotMatrixText(
  text: 'Custom Text',
  ledSize: 5.0,
  ledSpacing: 3.0,
  blankLedColor: Colors.grey[800],
  textStyle: TextStyle(
    fontSize: 80,
    fontWeight: FontWeight.w600,
    color: Colors.green,
  ),
  mirrorMode: true,
  flickerMode: true,
  invertColors: false,
);

Setting a Custom Board Size

By default, the board size is calculated based on the text. You can set a custom size:

DotMatrixText(
  text: 'Fixed Size',
  boardSize: Size(300, 150),
  // ... other properties
);

Additional Information

This plugin is optimized for performance, utilizing efficient rendering techniques to display dot matrix text with minimal overhead. It is built using Flutter Hooks for efficient state management.

Features Highlight

• Mirror Mode: Implemented to allow text to be displayed in reverse, enhancing visual effects.
• Flicker Mode Enhancements: Improved flicker mode provides dynamic LED effects without significant performance impact.
• Efficient Pixel Data Handling: Optimized pixel data access improves memory usage and performance.

For more detailed examples and advanced usage, please refer to the example app in the GitHub repository.

Issues and Feedback

Please file issues, bugs, or feature requests in our issue tracker.

Contributing

Contributions are welcome! If you would like to improve this plugin, please create a pull request with your changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Hero LED Display App

The dot_matrix_text plugin was used to create the Hero LED Display app on the App Store. This app provides a customizable dot matrix display, allowing users to create unique LED sign simulations and retro-style text displays.