interactive_pdf_viewer 0.1.3+1

A Flutter package for displaying PDFs with the ability to retrieve sentences by tapping on their position.

Interactive PDF Viewer

A Flutter plugin that provides interactive PDF viewing capabilities for iOS devices using PDFKit. This plugin allows you to view PDFs, extract text content, and interact with the document through various gestures.

Features

• Open PDF files from multiple sources:
  • Local storage
  • URLs (with download progress tracking)
  • Flutter assets
• Interactive text selection:
  • Tap to select sentences
  • Double-tap to clear selections
  • Visual highlighting of selected text
  • Save selected sentences
• Text extraction and processing:
  • Extract text content from PDFs
  • Real-time sentence selection
  • Support for sentence-level text selection
  • Automatic sentence tracking
• User Interface:
  • Native PDFKit viewer with full-screen support
  • Custom close button (top left)
  • Save button for selected sentences (top right)
  • Page navigation controls
• iOS 13.0+ support using PDFKit and SF Symbols

Installation

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

dependencies:
  interactive_pdf_viewer: ^0.1.0  # Use the latest version

Then run:

flutter pub get

Usage

Basic Setup

First, ensure Flutter bindings are initialized:

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(MyApp());
}

Creating a PDF Viewer Instance

Create an instance of InteractivePdfViewer with optional callbacks:

final pdfViewer = InteractivePdfViewer(
  // Called when a sentence is selected
  onSelectedSentencesChanged: (sentence) {
    print('Selected sentence: $sentence');
  },
  // Called when save button is pressed
  onSaveSelectedSentences: () {
    print('Save selected sentences triggered');
    // Handle saving the selected sentences
  },
);

Opening PDFs

From Local File

final success = await pdfViewer.openPDF('/path/to/your/file.pdf');

From URL

await pdfViewer.openPDFFromUrl(
  'https://example.com/sample.pdf',
  progressCallback: (progress) {
    print('Download progress: $progress');
  },
);

From Assets

await pdfViewer.openPDFAsset('assets/sample.pdf');

Text Selection and Interaction

The plugin provides several ways to interact with the PDF:

1. Single Tap: Select a sentence at the tapped location
2. Double Tap: Clear all selections
3. Save Button: Trigger saving of selected sentences
4. Close Button: Dismiss the PDF viewer

To handle selected sentences and save actions:

final pdfViewer = InteractivePdfViewer(
  onSelectedSentencesChanged: (sentence) {
    // Handle selected sentence updates
    print('Selected sentence: $sentence');
  },
  onSaveSelectedSentences: () {
    // Handle saving the selected sentences
    print('Save triggered for current sentence');
  },
);

Platform Support

The plugin currently only supports iOS devices. You can check platform support using:

if (InteractivePdfViewer.isIOS) {
  // iOS-specific code
} else {
  // Handle unsupported platform
}

Example

Here's a complete example of how to use the plugin:

import 'package:flutter/material.dart';
import 'package:interactive_pdf_viewer/v2/interactive_pdf_viewer.dart';

class PDFViewerScreen extends StatefulWidget {
  @override
  _PDFViewerScreenState createState() => _PDFViewerScreenState();
}

class _PDFViewerScreenState extends State<PDFViewerScreen> {
  String _status = 'Idle';
  bool _isLoading = false;
  String? _selectedSentence;
  late InteractivePdfViewer _pdfViewer;

  @override
  void initState() {
    super.initState();
    _pdfViewer = InteractivePdfViewer(
      onSelectedSentencesChanged: (sentence) {
        setState(() {
          _selectedSentence = sentence;
        });
      },
      onSaveSelectedSentences: () {
        _saveSelectedSentence();
      },
    );
  }

  void _saveSelectedSentence() {
    if (_selectedSentence != null) {
      // Implement your save logic here
      print('Saving sentence: $_selectedSentence');
      // For example, save to a file or database
    }
  }

  @override
  void dispose() {
    _pdfViewer.dispose();
    super.dispose();
  }

  Future<void> _openPDFFromUrl(String url) async {
    if (!InteractivePdfViewer.isIOS) {
      setState(() => _status = 'This feature is only available on iOS devices');
      return;
    }

    setState(() {
      _isLoading = true;
      _status = 'Downloading and opening PDF...';
    });

    try {
      await _pdfViewer.openPDFFromUrl(
        url,
        progressCallback: (progress) {
          setState(() => _status = 'Download progress: ${(progress * 100).toStringAsFixed(1)}%');
        },
      );
      setState(() => _status = 'PDF opened successfully');
    } catch (e) {
      setState(() => _status = 'Error: $e');
    } finally {
      setState(() => _isLoading = false);
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('PDF Viewer')),
      body: Column(
        children: [
          Expanded(
            child: Center(
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  if (_isLoading)
                    CircularProgressIndicator()
                  else
                    Icon(Icons.picture_as_pdf, size: 100),
                  Text('Status: $_status'),
                  ElevatedButton(
                    onPressed: () => _openPDFFromUrl('https://example.com/sample.pdf'),
                    child: Text('Open Sample PDF'),
                  ),
                ],
              ),
            ),
          ),
          if (_selectedSentence != null)
            Container(
              padding: EdgeInsets.all(16),
              color: Colors.grey[200],
              child: Column(
                crossAxisAlignment: CrossAxisAlignment.start,
                children: [
                  Row(
                    mainAxisAlignment: MainAxisAlignment.spaceBetween,
                    children: [
                      Text('Selected Sentence:',
                          style: Theme.of(context).textTheme.titleMedium),
                      IconButton(
                        icon: Icon(Icons.save),
                        onPressed: _saveSelectedSentence,
                        tooltip: 'Save selected sentence',
                      ),
                    ],
                  ),
                  SizedBox(height: 8),
                  Text(_selectedSentence!),
                ],
              ),
            ),
        ],
      ),
    );
  }
}

Requirements

• iOS 13.0 or later
• Flutter 2.0.0 or later
• Dart SDK 2.17.0 or later

Known Limitations

• Currently only supports iOS devices
• Requires iOS 13.0 or later due to PDFKit and SF Symbols dependency
• Text highlighting covers entire lines rather than individual text
• Text position information is approximated
• Native text selection features are not available

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

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