kiwix/kiwix-desktop

TOC navigations should be recorded in history

Open

#1,248 opened on Nov 13, 2024

View on GitHubContributor guide
 (7 comments) (0 reactions) (1 assignee)C++ (174 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (1,391 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, the TOC #42 navigations do not go through the Qt system and use Javascript to scroll directly. It would be great to have an in-page history, where the history records those actions but sends them to Javascript for scrolling instead of refreshing the current page to the URL.

Note that if a page is refreshed, all DOM states are also reset, which is not what we want. This is the reason why we cannot use setUr to navigate to TOC entries.

Contributor guide

Research direction
Understand how Qt web engine handles navigation and history, and propose a solution to inject JavaScript for scrolling while updating the browser history without reloading the page. Look at existing code for TOC handling.
Tech stack
cppjavascript
Domain
desktop
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++QtJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50