Revisit the new fxl navigator and introduce a reflowable one (#680)

Author: qnga

.github/workflows/checks.yml

@@ -74,21 +74,21 @@ jobs:
     runs-on: macos-latest
     if: ${{ !github.event.pull_request.draft }}
     env:
-      scripts: ${{ 'readium/navigators/web/scripts' }}
+      scripts: ${{ 'readium/navigators/web/internals/scripts' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
-          package_json_file: readium/navigators/web/scripts/package.json
+          package_json_file: readium/navigators/web/internals/scripts/package.json
           run_install: false
       - name: Setup cache
         uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: 'pnpm'
-          cache-dependency-path: readium/navigators/web/scripts/pnpm-lock.yaml
+          cache-dependency-path: readium/navigators/web/internals/scripts/pnpm-lock.yaml
       - name: Install dependencies
         run: pnpm --dir "$scripts" install --frozen-lockfile
       - name: Lint
@@ -98,4 +98,4 @@ jobs:
       - name: Check if bundled scripts are up-to-date
         run: |
           make scripts-new
-          git diff --exit-code --name-only readium/navigators/web/src/main/assets/*
+          git diff --exit-code --name-only readium/navigators/web/internals/src/main/assets/*

.idea/inspectionProfiles/Project_Default.xml

@@ -1,5 +1,5 @@
 SCRIPTS_PATH := readium/navigator/src/main/assets/_scripts
-SCRIPTS_NAVIGATOR_WEB_PATH := readium/navigators/web/scripts
+SCRIPTS_NAVIGATOR_WEB_PATH := readium/navigators/web/internals/scripts
 
 help:
 	@echo "Usage: make <target>\n\n\
@@ -38,7 +38,8 @@ scripts-new:
 	pnpm run format; \
 	pnpm run lint; \
 	pnpm run bundle; \
-	mv dist/* ../src/main/assets/readium/navigators/web/
+	rm -r ../src/main/assets/readium/navigator/web/internals/generated/*; \
+	mv dist/* ../src/main/assets/readium/navigator/web/internals/generated/
 
 .PHONY: scripts
 scripts: scripts-legacy scripts-new

Makefile

@@ -10,7 +10,7 @@ android {
     compileSdk = (property("android.compileSdk") as String).toInt()
 
     defaultConfig {
-        minSdk = (property("android.minSdk") as String).toInt()
+        minSdk = 23
         targetSdk = (property("android.targetSdk") as String).toInt()
 
         applicationId = "org.readium.navigator.demo"
@@ -56,22 +56,25 @@ android {
             assets.srcDirs("src/main/assets")
         }
     }
-    namespace = "org.readium.navigator.demo"
+    namespace = "org.readium.demo.navigator"
 }
 
 dependencies {
     implementation(project(":readium:readium-shared"))
     implementation(project(":readium:readium-streamer"))
     implementation(project(":readium:readium-navigator"))
-    implementation(project(":readium:navigators:readium-navigator-web"))
+    implementation(project(":readium:navigators:web:readium-navigator-web-reflowable"))
+    implementation(project(":readium:navigators:web:readium-navigator-web-fixedlayout"))
     implementation(project(":readium:adapters:pdfium"))
 
     coreLibraryDesugaring(libs.desugar.jdk.libs)
 
     implementation(libs.timber)
     implementation(libs.kotlinx.coroutines.android)
+    implementation(libs.kotlinx.collections.immutable)
     implementation(libs.kotlin.stdlib)
     implementation(libs.bundles.compose)
+    implementation(libs.google.material)
     implementation(libs.androidx.core)
     implementation(libs.androidx.fragment.ktx)
     implementation(libs.androidx.appcompat)

readium/navigators/demo/build.gradle.kts renamed to demos/navigator/build.gradle.kts

@@ -5,9 +5,8 @@
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
-        android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
-        android:theme="@android:style/Theme.Material.Light.NoActionBar">
+        android:theme="@style/Theme.AppTheme">
         <activity
             android:name=".DemoActivity"
             android:exported="true">

readium/navigators/demo/src/main/AndroidManifest.xml renamed to demos/navigator/src/main/AndroidManifest.xml

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.navigator.demo
+package org.readium.demo.navigator
 
 import android.net.Uri
 import android.os.Bundle
@@ -17,7 +17,7 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.core.view.WindowCompat
 import androidx.fragment.app.FragmentActivity
-import org.readium.navigator.demo.util.Theme
+import org.readium.demo.navigator.theme.Theme
 import org.readium.r2.shared.util.toAbsoluteUrl
 
 class DemoActivity : FragmentActivity() {

demos/navigator/src/main/assets/annotation-icon.svg

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.navigator.demo
+package org.readium.demo.navigator
 
 import androidx.activity.compose.BackHandler
 import androidx.compose.foundation.layout.Box
@@ -21,16 +21,17 @@ import androidx.compose.runtime.State
 import androidx.compose.runtime.collectAsState
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.LocalTextToolbar
 import androidx.core.view.WindowInsetsControllerCompat
-import org.readium.navigator.demo.reader.Reader
-import org.readium.navigator.demo.util.Fullscreenable
+import org.readium.demo.navigator.reader.Rendition
+import org.readium.demo.navigator.util.Fullscreenable
 
 @Composable
 fun Scaffold(
     fullscreenState: State<Boolean>,
     insetsController: WindowInsetsControllerCompat,
     snackbarHostState: SnackbarHostState,
-    content: @Composable () -> Unit
+    content: @Composable () -> Unit,
 ) {
     Fullscreenable(
         fullscreenState = fullscreenState,
@@ -41,6 +42,7 @@ fun Scaffold(
         ) {
             content.invoke()
 
+            LocalTextToolbar
             SnackbarHost(
                 modifier = Modifier
                     .align(Alignment.BottomCenter)
@@ -56,7 +58,7 @@ fun MainContent(
     viewmodel: DemoViewModel,
     launchBookSelection: () -> Unit,
     snackbarHostState: SnackbarHostState,
-    fullscreenState: MutableState<Boolean>
+    fullscreenState: MutableState<Boolean>,
 ) {
     val viewmodelState = viewmodel.state.collectAsState().value
 
@@ -98,7 +100,7 @@ fun MainContent(
                 viewmodel.onBookClosed()
             }
 
-            Reader(
+            Rendition(
                 readerState = viewmodelState.readerState,
                 fullScreenState = fullscreenState
             )