feat: configurable injection of js and css - #174
Open
m-abs wants to merge 8 commits into
Open
Conversation
m-abs
marked this pull request as ready for review
August 25, 2026 13:15
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a cross-platform API for registering additional JavaScript and CSS assets to be injected into EPUB HTML resources, extending the existing built-in flutterReadiumTools.js / flutterReadiumTools.css helper injection. It introduces a new shared InjectionAsset model and wires the method-channel plumbing, with Android implementing the injection into HTML resources and iOS adding storage + method handlers.
Changes:
- Added
InjectionAsset(JSON-serializable) and new platform-interface methods:setCssInjections/setJavaScriptInjections. - Android: implemented configurable injection by composing built-in helpers with extra injection assets and making injection idempotent via marker replacement.
- iOS: added method-channel handlers and state for injection lists; updated docs/changelog and extended tooling scripts.
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| flutter_readium/test/flutter_readium_test.dart | Updates mock platform to satisfy new platform interface methods. |
| flutter_readium/lib/flutter_readium.dart | Exposes new public API methods on FlutterReadium. |
| flutter_readium/ios/flutter_readium/Sources/flutter_readium/FlutterReadiumPlugin.swift | Adds iOS-side injection asset parsing and method-channel handlers; stores injection lists. |
| flutter_readium/CHANGELOG.md | Documents the new injection feature and platform support. |
| flutter_readium/android/src/main/kotlin/dk/nota/flutterreadium/ReadiumReader.kt | Passes configured injections into the HTML injection pipeline. |
| flutter_readium/android/src/main/kotlin/dk/nota/flutterreadium/ReadiumExtensions.kt | Implements injection asset URL building and marker-based replace/insert logic. |
| flutter_readium/android/src/main/kotlin/dk/nota/flutterreadium/PublicationChannel.kt | Adds method-channel handlers to set injections from Dart. |
| flutter_readium_platform_interface/lib/src/shared/injection_asset.dart | Introduces the shared Dart InjectionAsset model and JSON serialization. |
| flutter_readium_platform_interface/lib/src/shared/index.dart | Exports InjectionAsset from the shared model index. |
| flutter_readium_platform_interface/lib/method_channel_flutter_readium.dart | Implements method-channel calls for the new injection setters. |
| flutter_readium_platform_interface/lib/flutter_readium_platform_interface.dart | Adds the new injection methods to the platform interface contract. |
| CLAUDE.md | Updates documented repo toolchain facts and Flutter version update guidance. |
| bin/format | Extends formatting script behavior (formatting scope + added analysis calls). |
| .vscode/settings.json | Adjusts tool auto-approve configuration entries. |
Suppressed comments (2)
flutter_readium/ios/flutter_readium/Sources/flutter_readium/FlutterReadiumPlugin.swift:233
- The arguments coming from Dart are bridged as
[[String: Any]](withNSNullfor nulls). Casting to[[String: Any?]]will often fail and silently fall back to[], making injection registration a no-op on iOS. Also, mapping via the force-casting initializer can crash; use acompactMapwith the failable initializer.
case "setCssInjections":
let items = call.arguments as? [[String: Any?]] ?? []
self.cssInjections = items.map { InjectionAsset(from: $0) }
result(nil)
case "setJavaScriptInjections":
flutter_readium/ios/flutter_readium/Sources/flutter_readium/FlutterReadiumPlugin.swift:43
- These new injection lists are stored and can be set over the method channel, but they are never read when building the WKWebView user scripts. As a result, the iOS implementation appears to accept injections without actually injecting them into EPUB resources.
/// Extra CSS assets injected alongside the built-in helpers.
var cssInjections: [InjectionAsset] = []
/// Extra JavaScript assets injected alongside the built-in helpers.
var javaScriptInjections: [InjectionAsset] = []
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+69
to
+78
| /// Registers extra CSS assets to inject into every EPUB HTML resource, | ||
| /// in addition to the built-in `flutterReadiumTools.css`. | ||
| /// Call before opening a publication so the injections are active when the reader view is created. | ||
| Future<void> setCssInjections(List<InjectionAsset> injections) => _platform.setCssInjections(injections); | ||
|
|
||
| /// Registers extra JavaScript assets to inject into every EPUB HTML resource, | ||
| /// in addition to the built-in `flutterReadiumTools.js`. | ||
| /// Call before opening a publication so the injections are active when the reader view is created. | ||
| Future<void> setJavaScriptInjections(List<InjectionAsset> injections) => | ||
| _platform.setJavaScriptInjections(injections); |
| } | ||
| } | ||
|
|
||
| PluginLog.d(TAG, "Injecting files into: $filename") |
Comment on lines
+18
to
+21
| init(from map: [String: Any?]) { | ||
| assetPath = map["assetPath"] as! String | ||
| packageName = map["package"] as? String | ||
| } |
Comment on lines
+5
to
+17
| /// Identifies a Flutter asset (JS or CSS file) to inject into EPUB HTML resources. | ||
| /// | ||
| /// [assetPath] is the asset path as declared in `pubspec.yaml`, e.g. `assets/custom.js`. | ||
| /// [package] is the pub package that owns the asset, or `null` for app-level assets. | ||
| /// The file type is inferred from the path extension (`.js` or `.css`). | ||
| @immutable | ||
| class InjectionAsset implements JSONable { | ||
| const InjectionAsset({required this.assetPath, this.package}); | ||
|
|
||
| factory InjectionAsset.fromJson(Map<String, dynamic> json) => InjectionAsset( | ||
| assetPath: json['assetPath'] as String, | ||
| package: json['package'] as String?, | ||
| ); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restored dev branch from before rewritting history