interactive_text_plus 1.0.2

A Flutter package for rendering interactive text with support for clickable phone numbers, email addresses, and URLs.

Here is a professional README.md template for your package:

# Interactive Text Package

[![Pub Version](https://img.shields.io/pub/v/interactive_text.svg)](https://pub.dev/packages/interactive_text)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

A Flutter package for rendering interactive text with support for clickable phone numbers, email addresses, and URLs. This package allows you to easily parse and display phone numbers, URLs, and email addresses within a text block, making them clickable and functional.

## Features

- **Phone Number Detection**: Automatically detects and makes phone numbers clickable. Tapping on a phone number will initiate a call.
- **URL Detection**: Automatically detects URLs (both HTTP and HTTPS) and makes them clickable. Tapping on a URL will open the browser.
- **Email Detection**: Automatically detects email addresses and makes them clickable. Tapping on an email address will open the default email app to send an email.

## Installation

To use this package, add `interactive_text` to your `pubspec.yaml` file:

```yaml
dependencies:
  flutter:
    sdk: flutter
  interactive_text: ^1.0.0 # Check for the latest version on pub.dev

Run the following command to install the package:

flutter pub get

Usage

Basic Example

To display interactive text, simply use the InteractiveTextScreen widget and pass the text as a parameter.

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: InteractiveTextScreen(
        description: "Contact us at [e-mail] or call 123-456-7890. Visit https://example.com",
      ),
    );
  }
}

Customization

You can further customize the style of the clickable items by modifying the TextStyle in the _buildTextSpan method in the package's source code.

Supported Platforms

• Android
• iOS
• Web

License

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

Contributing

We welcome contributions to this project! Please feel free to fork the repository, submit issues, or create pull requests.

To contribute:

• Fork the repository.
• Create a new branch for your feature or bugfix.
• Write tests for your code.
• Make sure your code adheres to the existing coding standards.
• Submit a pull request with a clear description of your changes.

Contact

For any inquiries, feel free to contact me:

• Name: Houssam Eddine Aziez
• Email: [e-mail]

### Key Sections:
1. **Badges**: This section includes badges like version and license, which add professionalism and help users quickly identify package details.
2. **Features**: Briefly describes what the package can do, highlighting the key functionalities.
3. **Installation**: Instructions on how to add the package to a Flutter project.
4. **Usage**: Provides a sample usage of the package in a Flutter app, making it easier for users to get started quickly.
5. **Customization**: Brief note on customizing the widget or package features.
6. **Supported Platforms**: A list of platforms supported by the package.
7. **License**: Information about the license type, helping users understand the legal terms of using your package.
8. **Contributing**: A section inviting users to contribute to the project with clear steps on how to do so.
9. **Contact**: A professional way for users to get in touch.

Let me know if you'd like to adjust or add anything!