Issue 451 - hanlde headings containg umlauts

[gesinn-it-ilm]

This PR is related to the issue #451.

This PR contains:

• decodeURIComponent() used inside adjustScroll() to handle hash with umlauts and other special characters
• now the links inside table of contents which contains umlauts will work as it should

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of encoded URL fragments during page scroll adjustments, ensuring smoother and more accurate navigation to target elements.

[coderabbitai]

📝 Walkthrough

Walkthrough

The change updates the adjustScroll function within a JavaScript component. The assignment of the hash variable now decodes URL-encoded fragments using decodeURIComponent. No other parts of the function or any exported entities are modified, and the overall logic remains intact.

Changes

File	Change Summary
resources/js/.../sticky.js	Updated the adjustScroll function by replacing the direct assignment of hash with a decoded version using decodeURIComponent.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

resources/js/Components/Modifications/sticky.js (1)

62-62: Add error handling for malformed URLs.

While the use of decodeURIComponent is correct for handling umlauts, it can throw errors for malformed URLs containing invalid percent-encoding.

Consider wrapping it in a try-catch:

-			hash = decodeURIComponent( window.location.hash.replace( '#', '' ) ),
+			hash = '',
+			rawHash = window.location.hash.replace( '#', '' );
+			try {
+				hash = decodeURIComponent( rawHash );
+			} catch (e) {
+				// Fallback to raw hash if decoding fails
+				hash = rawHash;
+				mw.log.warn('Failed to decode URL hash:', e);
+			}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65c38bd and e762d54.

📒 Files selected for processing (1)

• resources/js/Components/Modifications/sticky.js (1 hunks)

🔇 Additional comments (1)

resources/js/Components/Modifications/sticky.js (1)

59-72:

❓ Verification inconclusive

LGTM! The fix correctly handles umlauts in hash links.

The implementation properly decodes URL-encoded characters, ensuring that links to headings with umlauts work as expected.

Let's verify the fix works with various special characters:

---

🏁 Script executed:

#!/bin/bash
# Description: Test the fix with various special characters by checking for any existing headings with umlauts

# Search for heading elements with umlauts or other special characters
rg -l '[äöüßÄÖÜ]' | grep -i '\.html?$'

Length of output: 40

---

LGTM! The fix in resources/js/Components/Modifications/sticky.js (lines 59–72) correctly decodes URL-encoded characters, ensuring that hash links with special characters such as umlauts work as expected.

However, the automated search for headings containing umlauts using the provided shell script did not produce any output. Please manually verify that your HTML files include elements with umlauts (or other special characters) that are intended to be targeted by this functionality.