[FEATURE] Client-side paging #878

beatrycze-volk · 2022-12-07T11:47:34Z

Changes are tested - paging works.

Known problems:

there are still some TODOs to be resolved
- check multiple instances of metadata plugin
- initiate load of full texts for empty document controller (resolved in [FEATURE] Remove client-side paging redundancies #938)
- avoid redundancy to DocumentController in PageViewController (resolved in [FEATURE] Remove client-side paging redundancies #938)
- avoid instantiating dlfToolbox multiple times (resolved in [FEATURE] Remove client-side paging redundancies #938)
- consider passing full new state in stateChanged event, then reduce usage of currentPageNo and simultaneousPages properties in Controller.js (removed in [FEATURE] Remove TODO for passing state #946)
- add toplevel sections in TableOfContents.js
- TOC from DB in TableOfContents.js
- check children depth in TableOfContents.js (really needed?)

beatrycze-volk · 2022-12-07T12:08:11Z

Resources/Private/Templates/Metadata/Main.html

+
+<script>
+    window.addEventListener('tx-dlf-documentLoaded', (e) => {
+        // TODO(client-side): When there are multiple instances of metadata plugin?


This part should be tested and checked if the metadata is correctly displayed.

beatrycze-volk · 2022-12-07T12:17:42Z

Resources/Public/Javascript/PageView/PageView.js

-    var cnt = Math.min(this.fulltexts.length, this.images.length);
+dlfViewer.prototype.initLoadFulltexts = function (visiblePages) {
+    if (this.docController === null) {
+        // TODO(client-side): Make it work then docController === null


Probably it should be: Make it work when docController === null

Resources/Public/Javascript/PageView/PageView.js

Resources/Public/Javascript/PageView/Navigation.js

beatrycze-volk · 2023-03-28T08:32:50Z

Resources/Private/Templates/Document/Main.html

+      data-namespace-typo3-fluid="true"
+      lang="en">
+
+    <script>{docConfiguration -> f:format.raw()}</script>


It looks like a false positive

beatrycze-volk · 2023-03-28T08:34:18Z

Resources/Private/Templates/Metadata/Main.html

+    window.addEventListener('tx-dlf-documentLoaded', (e) => {
+        // TODO(client-side): When there are multiple instances of metadata plugin?
+        const container = document.querySelector('.dlf-metadata-container');
+        const rootline = {settings.rootline};


It looks like a false positive

beatrycze-volk · 2023-03-28T08:33:47Z

Resources/Private/Templates/Navigation/Main.html

+    // NOTE: The navigation plugin may be instantiated multiple times, even on a single page view
+    window.addEventListener('tx-dlf-documentLoaded', e => {
+        const controller = e.detail.docController;
+        const features = {features -> f:format.json() -> f:format.raw()};


It looks like a false positive

Resources/Public/JavaScript/PageView/PageView.js

Resources/Public/JavaScript/PageView/Navigation.js

beatrycze-volk · 2023-03-29T12:14:03Z

All warnings "..." is defined but never used. are false positives. Those classes are called from fluid templates.

On large documents, rendering metadata of all sections can take a considerable amount of time. Instead, allow to just render the current metadata, and fetch the additional metadata in an API call.

- remove dead variables - fix check for mime type

- removed unused e param from onStateChanged - make fetchMetadata async so no spinner is needed

- remove unused paramaters - decrease complexity of updateNavigationControls

Error: `Inventory link with key "t3tsref:data-type-page-id" (data-type-page-id) not found.`

beatrycze-volk marked this pull request as draft December 7, 2022 11:47

beatrycze-volk commented Dec 7, 2022

View reviewed changes

sebastian-meyer added ⏳ prototype A provisional pull request still work in progress. ⚙ feature A new feature or enhancement. labels Jan 4, 2023

beatrycze-volk force-pushed the sprint-rebased branch from b1bd553 to 12f215c Compare January 20, 2023 09:52

beatrycze-volk force-pushed the sprint-rebased branch from 12f215c to 08c9b78 Compare January 30, 2023 13:00

github-advanced-security bot found potential problems Jan 30, 2023

View reviewed changes

sebastian-meyer changed the title ~~Client sided paging~~ [FEATURE] Client-side paging Jan 30, 2023

beatrycze-volk force-pushed the sprint-rebased branch 4 times, most recently from 7d9cbf1 to 4d07ae1 Compare February 3, 2023 16:47

beatrycze-volk mentioned this pull request Feb 3, 2023

[MAINTENANCE] Simplify and unify check for doc existence #899

Merged

sebastian-meyer mentioned this pull request Feb 6, 2023

Migrate frontend plugins to a client-side application #780

Open

beatrycze-volk force-pushed the sprint-rebased branch 2 times, most recently from 7507d50 to 14853a2 Compare February 6, 2023 17:48

sebastian-meyer added this to the Kitodo.Presentation 5.0.0 milestone Feb 7, 2023

beatrycze-volk force-pushed the sprint-rebased branch from b274075 to b5bf409 Compare February 7, 2023 16:04

github-advanced-security bot found potential problems Feb 7, 2023

View reviewed changes

Resources/Public/JavaScript/PageView/PageView.js Fixed Show fixed Hide fixed

Resources/Public/JavaScript/PageView/Navigation.js Fixed Show fixed Hide fixed

beatrycze-volk force-pushed the sprint-rebased branch 2 times, most recently from 03957df to c794dec Compare February 16, 2023 12:37

beatrycze-volk force-pushed the sprint-rebased branch from c794dec to 64c6835 Compare February 27, 2023 13:07

beatrycze-volk force-pushed the sprint-rebased branch 3 times, most recently from bbadfff to 0a03d63 Compare March 10, 2023 13:15

beatrycze-volk force-pushed the sprint-rebased branch 2 times, most recently from bcce7c6 to a135764 Compare March 28, 2023 08:43

beatrycze-volk mentioned this pull request Mar 29, 2023

Client-side paging slub/dfg-viewer#222

Open

Kajetan Dvoracek and others added 28 commits February 11, 2025 15:46

Refactor: Extract dlfController::eventTarget

d2654ce

Refactor: Don't dispatch stateChanged manually

9516ba4

Refactor: Dissolve global tx_dlf_loaded

d76631e

[EXT] Memoize MetsDocument::getStructureDepth()

dd3875d

Fetch prerendererd metadata dynamically

9996a8b

On large documents, rendering metadata of all sections can take a considerable amount of time. Instead, allow to just render the current metadata, and fetch the additional metadata in an API call.

Convert TODO to TODO(client-side)

1d9be00

Update and extend documentation

4f92ff9

Update .editorconfig (4 spaces for JS) to reflect actual use

37401a8

Extend documentation

a933196

Add and update notes about URL generation

4d3c67f

Fix Codacy warnings

eeb9c41

Fix toArray method in Doc class

13f5341

- remove dead variables - fix check for mime type

Adjust DocumentController

5f38127

Move nonProxyMimeTypes to config

3b1ef2c

Implement getAllFiles for IIIFManifest

bd6fa5e

Remove unused manifest variable

1eb7ad0

Fix intend in css

48f400f

Improve Metadata script

04ca397

- removed unused e param from onStateChanged - make fetchMetadata async so no spinner is needed

Improve Navigation script

ee51149

- remove unused paramaters - decrease complexity of updateNavigationControls

Assign fulltextEntry directly

9fb5051

Fix comment

645c2a6

Allow console logs

9ee789c

Activate full text highlight if full text is active

e55382e

Fix errors marked by PHPStan

ee443b5

Fix Codacy errors

27f9b15

Fix error: Direct use of $GLOBALS Superglobal detected

1537707

Fix documentation build

be3face

Error: `Inventory link with key "t3tsref:data-type-page-id" (data-type-page-id) not found.`

Fix PHPStan warnings

34043ca

beatrycze-volk force-pushed the sprint-rebased branch from b4c4773 to 34043ca Compare February 11, 2025 16:03

Fix return for getStructureDepth() function

949d636

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE] Client-side paging #878

[FEATURE] Client-side paging #878

beatrycze-volk commented Dec 7, 2022 •

edited

Loading

beatrycze-volk Dec 7, 2022

beatrycze-volk Dec 7, 2022

beatrycze-volk Mar 28, 2023 •

edited

Loading

beatrycze-volk Mar 28, 2023

beatrycze-volk Mar 28, 2023

beatrycze-volk commented Mar 29, 2023

[FEATURE] Client-side paging #878

Are you sure you want to change the base?

[FEATURE] Client-side paging #878

Conversation

beatrycze-volk commented Dec 7, 2022 • edited Loading

beatrycze-volk Dec 7, 2022

Choose a reason for hiding this comment

beatrycze-volk Dec 7, 2022

Choose a reason for hiding this comment

beatrycze-volk Mar 28, 2023 • edited Loading

Choose a reason for hiding this comment

beatrycze-volk Mar 28, 2023

Choose a reason for hiding this comment

beatrycze-volk Mar 28, 2023

Choose a reason for hiding this comment

beatrycze-volk commented Mar 29, 2023

beatrycze-volk commented Dec 7, 2022 •

edited

Loading

beatrycze-volk Mar 28, 2023 •

edited

Loading