Chronological navigation in libraries #13863

subhramit · 2025-09-12T16:16:50Z

This brings back an "improved" (per-tab) version of chronological navigation across entries that existed in JabRef 4.x.

Steps to test

Start JabRef
Open Chocolate.bib
Click (or double-click to open the entry editor) on an entry
Click on another entry (the "Back" navigation button should now be available)
Repeat step 4 a couple of times
Press the "Back" navigation button any number of times till valid (the "Forward" navigation button should now be available)
Press the "Forward" navigation button any number of times as valid
Play with permutations of step 6 and 7 and check if a) the order is correct b) the entry editor correctly reflects the entry that is navigated to.
Open another non-empty library and check steps 3-8, switching between libraries (individual navigation states and history of each should persist)
Test the same functionality with the keybindings (alt+left, alt+right)
Open the Welcome tab (ensure that the navigation buttons are unavailable)
Close all libraries/tabs (ensure that the navigation buttons are unavailable)

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
I manually tested my changes in running JabRef (always required)
[/] I added JUnit tests for changes (if applicable)
I added screenshots in the PR description (if change is visible to the user)
I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

HoussemNasri · 2025-09-12T17:08:37Z

jabgui/src/main/java/org/jabref/gui/LibraryTab.java

+
+    private void newEntryShowing(BibEntry entry) {
+        // skip history updates if this is from a back/forward operation
+        if (backOrForwardInProgress) {


Is this condition necessary? I would use such a check if scrolling and entry showing run on different threads, and use AtomicBoolean instead. But here both would run on the JavaFX thread, so it is not possible for this method to be called while scrolling is in progress.

This is to differentiate if the call is coming from back/forward navigation button (in which case history management is nit needed, just need to update the UI) or if the user clicked a new entry (in which case history list needs an update).

In other words, without this, a back navigation call would be treated as direct navigation on the maintable and nextEntries.clear() would immediately undo the work the back() method just did and break the forward button.

I changed the name of the boolean to backOrForwardNavigation to avoid confusion

HoussemNasri · 2025-09-12T17:15:56Z

jabgui/src/main/java/org/jabref/gui/LibraryTab.java

+    private final List<BibEntry> previousEntries = new ArrayList<>();
+    private final List<BibEntry> nextEntries = new ArrayList<>();


We can replace this by one list and an index that points to the currently selected entry:

When an entry is selected we add it to the list.

When back called we decrement (if possible) the index and navigate to that entry

When forward called we increment (if possible) and navigate.

I thought about this a bit, I am a bit reluctant about this scenario:
You seelct entry A, then B, then C, then D.

You click Back twice. You are now viewing B.

From B, you click on a new entry, E.

The old "forward" history (entries C, D) must be discarded. The new history should be A -> B -> E.

The logic to truncate the "forward" part of the list will be slightly less cleaner (clearing the forward "sublist" of the original list and adding the new entry) than the way we just do nextEntries.clear() now, but if two people are in favor of this I'll shift to a single list.

I thought whether Eclipse Collections and sublists could help here. However, the current code is very clean and I would keep it.

IMO, managing one state is much easier them managing 2+, because you need to keep them in sync: Whenever you modify one you need to think which one needs to also change.

But, you can still make the current design better by encapsulating the forward and backward list into a record.

Record is suitable in a context of immutability. If we wish to encapsulate, can do with a separate class

Refactored in commit d890eea, lets see if you guys like this

HoussemNasri · 2025-09-12T17:17:52Z

jabgui/src/main/java/org/jabref/gui/LibraryTab.java

+                // when no entries are selected, don't update navigation history
+                // but still update the navigation state


This comment does not add anything that the code doesn't already show, a better comment would describe the why.

I just checked, it is not possible to "de-select" an entry by clicking on an empty cell in the main table.
I am refining the comments and keeping this as a fallback just in case there is a way to do that.
If there is not, maybe this can be removed,

ThiloteE · 2025-09-12T17:43:56Z

Don't show the arrows in the GUI, if only one library is open. They take a lot of screenspace. Especially on small screens, if I remember right, there was a bug that would cause JabRef to crash when there are too many symbols in that row. That was one of the reasons that we removed social buttons from that row (+ the fact that social buttons for Linkedin or Twitter are really just a distraction in the GUI).

subhramit · 2025-09-12T17:49:14Z

Don't show the arrows in the GUI, if only one library is open.

Do you mean when no library is open? As this will make the user rely only on keyboard shortcuts?

Also, the undo/redo buttons also have the same behavior.

subhramit · 2025-09-12T17:55:51Z

Don't show the arrows in the GUI, if only one library is open.

Do you mean when no library is open? As this will make the user rely only on keyboard shortcuts?

Also, the undo/redo buttons also have the same behavior.

Also, on shrinking, one by one all the buttons shift to a side menu:

InAnYan · 2025-09-12T18:02:26Z

That's interesting

ThiloteE · 2025-09-12T19:05:59Z

Don't show the arrows in the GUI, if only one library is open.

Do you mean when no library is open? As this will make the user rely only on keyboard shortcuts?

Also, the undo/redo buttons also have the same behavior.

Aren't those buttons to switch between libraries? Or what is it for? If there is only one library, they would be useless, right?

subhramit · 2025-09-12T19:07:50Z

Don't show the arrows in the GUI, if only one library is open.

Do you mean when no library is open? As this will make the user rely only on keyboard shortcuts?
Also, the undo/redo buttons also have the same behavior.

Aren't those buttons to switch between libraries? Or what is it for? If there is only one library, they would be useless, right?

No, it's for history navigation amongst entries of a library (like the back/forward button in a browser). Check the linked issue once, it'll be clear.

koppor · 2025-09-13T07:13:53Z

jabgui/src/main/java/org/jabref/gui/LibraryTab.java

    private final BooleanProperty nonUndoableChangeProperty = new SimpleBooleanProperty(false);
+    private final List<BibEntry> previousEntries = new ArrayList<>();
+    private final List<BibEntry> nextEntries = new ArrayList<>();
+    private BibEntry currentlyShowing;


This misses a connection to org.jabref.gui.maintable.MainTable#clearAndSelect(org.jabref.model.entry.BibEntry).

I didn't get this - there is BibEntry toShow in navigateToEntry, on which this class' clearAndSelect is called, which is indeed MainTable#clearAndSelect internally. I don't think we can use it for currentlyShowing?

My quick thoughts were: If there is an entry selected, I push the back button and then the forward button, the entry should be selected - and not an "arbitrary" one.

Oh got it. Yeah, no arbitrary entries are selected.

I hope, its just a binding thing 😅

jabgui/src/main/java/org/jabref/gui/LibraryTab.java

trag-bot · 2025-09-13T12:20:31Z

jabgui/src/main/java/org/jabref/gui/NavigationHistory.java

+    private final List<BibEntry> previousEntries = new ArrayList<>();
+    private final List<BibEntry> nextEntries = new ArrayList<>();


Using plain ArrayList instead of JavaFX ObservableList prevents UI from automatically updating when the collection changes. This impacts reactive UI updates.

trag-bot · 2025-09-13T12:20:32Z

jabgui/src/main/java/org/jabref/gui/NavigationHistory.java

+        if (currentEntry != null) {
+            previousEntries.add(currentEntry);
+        }


Null check for currentEntry indicates possible null state handling. Methods should use Optional instead of null for better type safety and clarity.

trag-bot · 2025-09-13T12:20:36Z

jabgui/src/main/java/org/jabref/gui/NavigationHistory.java

+            return;
+        }
+
+        // a new selection invalidates the forward history


Comment merely restates what the code does (clearing nextEntries). It doesn't provide additional information about why this is necessary.

* upstream/main: Chronological navigation in libraries (#13863) Adapt code style (#13874) LSP Refactor to use ranges instead of string matching (#13862) Use jspecify (#13873) changed Keyword.of to accept List<String> instead of varargs (#13871)

InAnYan · 2025-09-25T17:42:40Z

If I have selected several entries, will this work?

Use case (please allow me to use will after if in English):

I'm selecting many entries from a big library to filter out irrelevant research. I want to focus only on selecting entries. 
If I'll make a mistake and I'll click on some entry without CTRL, my selection and all my work will go to trash and I would have to reselect entries from the very beginning.

I find this immensively useful

subhramit · 2025-09-26T04:17:50Z

If I have selected several entries, will this work?

Use case (please allow me to use will after if in English):
I'm selecting many entries from a big library to filter out irrelevant research. I want to focus only on selecting entries. 
If I'll make a mistake and I'll click on some entry without CTRL, my selection and all my work will go to trash and I would have to reselect entries from the very beginning.
I find this immensively useful

This is a very good idea. While developing, I did not think about multi-select behaviour. Can you file an issue and mark it good third?
I'll look into it if nobody tries.

subhramit added 4 commits September 12, 2025 21:04

Add basic implementation

1d75410

Extend implementation to per-tab

df50edc

Add changelog entry

b042e38

Refine comment

589bdd8

subhramit added project: jabcon component: maintable labels Sep 12, 2025

subhramit requested review from Siedlerchr, calixtus and koppor September 12, 2025 16:24

subhramit added 2 commits September 12, 2025 21:59

l10n

a9c95eb

l10n format

8304feb

subhramit added this to the 6.0-beta2🎄❄️🎅 milestone Sep 12, 2025

subhramit added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Sep 12, 2025

subhramit requested a review from ThiloteE September 12, 2025 16:34

HoussemNasri reviewed Sep 12, 2025

View reviewed changes

Refine comments

a8f57d6

Better name for variable

0559d11

koppor reviewed Sep 13, 2025

View reviewed changes

Merge branch 'main' into chronological-navigation

e33973a

koppor reviewed Sep 13, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/LibraryTab.java Outdated Show resolved Hide resolved

subhramit added 2 commits September 13, 2025 17:28

Even better name

fbb37fa

Refactor lists into class

d890eea

trag-bot bot reviewed Sep 13, 2025

View reviewed changes

koppor approved these changes Sep 13, 2025

View reviewed changes

koppor added this pull request to the merge queue Sep 13, 2025

Merged via the queue into JabRef:main with commit e7a5420 Sep 13, 2025
40 checks passed

koppor deleted the chronological-navigation branch September 13, 2025 15:24

github-actions bot mentioned this pull request Sep 13, 2025

Navigate between entries (Back/Forward button) #6352

Closed

subhramit mentioned this pull request Sep 13, 2025

Remove/prevent "Ghost" navigation history when using importers #13878

Open

2 tasks

subhramit mentioned this pull request Oct 22, 2025

Improve chronological navigation #14145

Open

		private final List<BibEntry> previousEntries = new ArrayList<>();
		private final List<BibEntry> nextEntries = new ArrayList<>();

		// when no entries are selected, don't update navigation history
		// but still update the navigation state

Uh oh!

Chronological navigation in libraries #13863

Chronological navigation in libraries #13863

Uh oh!

Conversation

subhramit commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Mandatory checks

Uh oh!

Choose a reason for hiding this comment

Uh oh!

subhramit Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

subhramit Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThiloteE commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhramit commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhramit commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

InAnYan commented Sep 12, 2025

Uh oh!

ThiloteE commented Sep 12, 2025

Uh oh!

subhramit commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

InAnYan commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhramit commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

subhramit commented Sep 12, 2025 •

edited

Loading

subhramit Sep 12, 2025 •

edited

Loading

subhramit Sep 12, 2025 •

edited

Loading

ThiloteE commented Sep 12, 2025 •

edited

Loading

subhramit commented Sep 12, 2025 •

edited

Loading

subhramit commented Sep 12, 2025 •

edited

Loading

subhramit commented Sep 12, 2025 •

edited

Loading

InAnYan commented Sep 25, 2025 •

edited

Loading

subhramit commented Sep 26, 2025 •

edited

Loading