flutter_readium_platform_interface 0.0.1 copy "flutter_readium_platform_interface: ^0.0.1" to clipboard
flutter_readium_platform_interface: ^0.0.1 copied to clipboard

Platform interface for the flutter_readium plugin. Provides shared Dart models, the method-channel contract, and the reader API surface used by native implementations.

flutter_readium_platform_interface #

pub package Quality Tests

The platform interface package for flutter_readium.

This package defines the abstract FlutterReadiumPlatform class, all shared Dart models (Publication, Locator, EPUBPreferences, ReaderDecoration, …), and the default MethodChannel implementation that native plugins wire into.


Usage #

You do not need to depend on this package directly. Add flutter_readium to your pubspec.yaml and it will be included transitively.

If you are implementing a new platform plugin for flutter_readium, extend FlutterReadiumPlatform and call FlutterReadiumPlatform.instance = MyPlatformImpl() during plugin registration.

import 'package:flutter_readium_platform_interface/flutter_readium_platform_interface.dart';

class MyPlatformImpl extends FlutterReadiumPlatform {
  @override
  Future<Publication> openPublication(String pubUrl) async { ... }
  // implement remaining abstract members
}

Models #

The key model types exported by this package:

Type Description
Publication Top-level publication container
Locator Position identifier within a resource
EPUBPreferences EPUB display preferences (font, scroll, …)
TTSPreferences TTS playback preferences
AudioPreferences Audio playback preferences
ReaderDecoration Highlight / decoration applied to a range
ReadiumTimebasedState Timebased navigator playback state
ReadiumError Structured error from native to Dart


License #

BSD 3-Clause — see LICENSE.

0
likes
150
points
173
downloads

Documentation

API reference

Publisher

verified publisherkb.dk

Weekly Downloads

Platform interface for the flutter_readium plugin. Provides shared Dart models, the method-channel contract, and the reader API surface used by native implementations.

Repository (GitHub)
View/report issues
Contributing

Topics

#readium #ebook #audiobook #comic #tts

License

BSD-3-Clause (license)

Dependencies

collection, crypto, dartx, dfunc, equatable, flutter, logging, meta, path, plugin_platform_interface

More

Packages that depend on flutter_readium_platform_interface