Htmx-debugger - a debugging tool for htmx applications

Latest Version

Version
1.0.6
Update
October 22, 2024
Size
71.28KiB
Developer
Category
Users
105
Rating
5 ★
Manifest Version
3
Web Store Status
Languages Support
English (United States)
See more
Permissions
Alarms
See more

htmx-debugger Extension

## Overview

htmx-debugger is a powerful browser extension (compatible with Chrome and Firefox) designed to help developers debug and analyze htmx applications. It provides a comprehensive and user-friendly interface for viewing htmx events, requests, and responses in real-time. This tool is essential for understanding and troubleshooting htmx-powered web applications, making the development process smoother and more efficient.

## Features

- Real-time capture and display of htmx events
- Intelligent grouping of related events for easier analysis
- Powerful search functionality to filter events
- One-click clear button to reset the debugger view
- Flexible event filtering (All, Request, Response)
- Collapsible event details for a cleaner interface
- Detailed timing information for request-response cycles
- Live connection status indicator
- Automatic periodic connection checks for improved stability
- Robust error handling and reporting

## Future

- Export functionality to save captured events as a JSON file
- Import capability to load and analyze events from a JSON file

## Usage

### Opening the Debugger

1. Navigate to a webpage that uses htmx.
2. Open Chrome DevTools (Right-click > Inspect or press F12).
3. Look for the \"htmx\" tab in the DevTools panel. If you don't see it, click on the \">>\" icon to find it in the list of additional tools.

### Debugging htmx Events

The debugger automatically captures htmx events as they occur on the page. Each event is displayed with the following information:

- Event type
- Timestamp
- Target element details
- Event-specific details
- XHR information (for relevant events)

### Using the Debugger Features

1. **Connection Status**: Check the connection status indicator in the panel header to ensure the debugger is properly connected.
2. **Search**: Use the search bar at the top to filter events based on their content.
3. **Clear**: Click the \"Clear\" button to reset the debugger and remove all captured events.
4. **Event Filtering**: Use the filter buttons to show all events, only requests, or only responses.
5. **Expand/Collapse**: Click on an event header to expand or collapse its details.
6. **Timing Information**: For grouped events, the total duration is displayed at the bottom of the group.

## Troubleshooting

- If you don't see any events in the debugger, ensure that the webpage you're debugging is actually using htmx.
- If the htmx tab doesn't appear in DevTools, try reloading the page or reopening DevTools.
- Check the browser console for any error messages related to the extension.
- If the connection status shows \"Disconnected\", try reloading the page.
- If problems persist, try disabling and re-enabling the extension, reloading the webpage, or restarting Chrome.

## Privacy Policy

htmx-debugger is committed to protecting user privacy and does not collect or use any personal user data. The extension operates solely within the context of the user's browser to provide debugging functionality for htmx applications.

### Permissions and Their Justifications

1. **alarms**: The alarms permission is used to schedule periodic connection checks, ensuring the debugger maintains a stable connection to the webpage. This improves the reliability of the debugging process.

### Single Purpose Description

The single purpose of htmx-debugger is to provide a comprehensive debugging tool for web developers working with htmx-powered applications. It captures, displays, and analyzes htmx events in real-time, offering insights into the behavior and performance of htmx interactions within web pages.

### Data Usage Compliance

htmx-debugger complies with the Chrome Web Store Developer Program Policies regarding data usage. The extension:

- Does not collect any personal user data
- Does not transmit any captured debugging information outside of the user's browser
- Only processes information necessary for its core debugging functionality
- Stores data locally and solely for the purpose of improving the user's debugging experience

By using htmx-debugger, users can be assured that their privacy is respected and that the extension operates within the bounds of its stated purpose as a development tool for htmx applications.
Read more

Source Manifest.json

{"manifest_version": 3,"name": "htmx-debugger","version": "1.0.6","description": "htmx-debugger - a debugging tool for htmx applications","permissions": ["alarms"],"optional_host_permissions": [""],"action": {"default_icon": {"16": "htmx-debugger-logo-16.png","32": "htmx-debugger-logo-32.png","48": "htmx-debugger-logo-48.png","128": "htmx-debugger-logo-128.png"},"default_title": "htmx-debugger"},"background": {"service_worker": "background.js","type": "module"},"content_scripts": [{"matches": [""],"js": ["content.js"],"run_at": "document_idle"}],"devtools_page": "devtools.html","icons": {"16": "htmx-debugger-logo-16.png","32": "htmx-debugger-logo-32.png","48": "htmx-debugger-logo-48.png","128": "htmx-debugger-logo-128.png"},"content_security_policy": {"extension_pages": "script-src 'self'; object-src 'self';"},"minimum_chrome_version": "88","update_url": "https://clients2.google.com/service/update2/crx"}
Read more

How to download and manually install htmx-debugger extension for Chrome

Looking for a way to install htmx-debugger extensions for Chrome, you can search for them in the Chrome Web Store, clicking the "Add to Chrome" button, and following the straightforward process.

However, you may need to install htmx-debugger extensions manually, this article outlines two simple methods to effortlessly install htmx-debugger extensions, whether they come as unpacked folders in compressed formats like .zip or as .crx files.

Method 1: Download htmx-debugger extension and manually install through Drag &Drop

If you ever need to manually install a htmx-debugger extension for Chrome, don't worry, it's a simple process. Just follow these easy steps, and you will have your extension ready to use in no time.

Step 1: Download the htmx-debugger Extension by clicking the "Download CRX" button on the website.

Look for the htmx-debugger extension you wish to install. Go to the website and download the htmx-debugger extension package, which is usually a .CRX file and comes in a zipped file. Here ".crx" file is the format for htmx-debugger extension that contains all the data.

Step 2: Extract &Arrange Files

Once the file is downloaded, extract that file into its own folder. Similarly, give that extension files a permanent home. In other words, keep it in a folder that you don't accidentally delete it because these files will be needed to make that extension work.

Step 3: Go to the Chrome Extensions Page

Open Google Chrome and in the address bar, type chrome://extensions; it will open the Google Chrome extensions page. Make sure that "My extensions" is selected in the sidebar.

Step 4: Drag and Drop the Extension

Now, go to the folder where you extracted the htmx-debugger extension and drag &drop the extension file from there anywhere onto the extension page within Google Chrome.

Step 5: Complete the Installation

Once you drag and drop the extension file, follow the steps that Google Chrome takes you through. Similarly, if the extension file is of .crx file format, you will be required to review the permissions and then add the extension.

Now, you can manage that added extension as you would like to with any other Chrome extension that you added through Chrome Webstore. Its icon will also appear in the Google Chrome Menu on the right side of the address bar once you activate it.

Method 2: Download htmx-debugger extension for Chrome and install in Developer Mode

This is another method to install htmx-debugger extension manually, but the twist is that here, you install by enabling the developer mode option provided in Google Chrome. This mode is commonly used for testing extensions or running unpublished tools.

Step 1: Download the htmx-debugger extension file

Select and download the htmx-debugger extension by clicking the 'Download CRX' button on the website.

Step 2: Extract the downloaded contents

Convert the file to a ZIP file if it is in CRX format then extract the htmx-debugger extension zip file or folder that you downloaded. Make sure you extract it using the same folder name and keep it safely in another folder, so you don't delete it by mistake. The extracted folder will be needed to keep your htmx-debugger extension running.

Step 3: Open Chrome Extension Setting Page

In the address bar of Google Chrome, type chrome://extensions and open the Chrome Extension Page.

Step 4: Enable Developer Mode

After opening the Chrome Extension page, look at the top right side, and you will find the toggle option of "Developer mode."Simply enable that developer mode option.

Step 5: Load the Unpacked Extension

Once you enable the developer mode option, you will see the menu of Load Unpacked, Pack Extensions and Update. From that, select the option "Load unpacked."

Step 6: Select the Extension Folder

Once the pop-up opens upon clicking Load unpacked, select the htmx-debugger extension directory and click on the "Select Folder "button.

Step 7: Confirm and Install

After you select an extension folder of a Google Chrome extension you're installing manually, confirm its installation for the final time and let the installation complete.

Conclusion

Here we've made a step-by-step guide on How to manually install htmx-debugger extension in 2 ways. We hope this guide proves helpful.

Similar Extensions

icon

Svelte DevTools Extension · Developer Tools 105 19 ★ 58.61KiB

icon

DivMagic - Copy Style from any website Extension · Developer Tools 105 55 ★ 1.3MiB

icon

Web MIDI Mapper Extension · Productivity 105 0 ★ 22.4KiB

icon

Polypane helper Extension · Developer Tools 105 4 ★ 23.12KiB

icon

Alpine.js devtools Extension · Developer Tools 105 34 ★ 67.78KiB

icon

jQuery Debugger Extension · Developer Tools 105 110 ★ 88.52KiB

icon

Gimli Tailwind Extension · Developer Tools 105 33 ★ 151KiB

icon

Locale Switcher Extension · Developer Tools 105 71 ★ 87.46KiB

icon

Readable HackerNews Extension · Accessibility 105 27 ★ 39.07KiB

icon

OpenAPI DevTools Extension · Developer Tools 105 10 ★ 2.38MiB

icon

Atomic CSS Devtools Extension · Developer Tools 105 15 ★ 196KiB

icon

markClipper - obsidian web clipper Extension · Productivity 105 28 ★ 205KiB

icon

Initab Extension · Developer Tools 105 95 ★ 12.93MiB

icon

Dev Tabs Extension · Developer Tools 105 2 ★ 498KiB

icon

Windy Extension · Developer Tools 105 21 ★ 2.31MiB

icon

Chrome Extension Source Viewer Extension · Developer Tools 105 3 ★ 580KiB

icon

ChatGPT Prompt List Extension · Productivity 105 11 ★ 53.83KiB

icon

MultiBridge Trader Extension · Productivity 105 2 ★ 40.49KiB

icon

Clockwork Extension · Developer Tools 105 74 ★ 2.26MiB

icon

ARIA DevTools Extension · Developer Tools 105 32 ★ 491KiB

icon

CSS Stacking Context inspector Extension · Developer Tools 105 21 ★ 262KiB

icon

Hackertab.dev - developer news Extension · Developer Tools 105 168 ★ 525KiB

icon

Landmark Navigation via Keyboard or Pop-up Extension · Accessibility 105 9 ★ 67.37KiB

icon

Svelte Reactive Debugger Extension · Developer Tools 105 0 ★ 216KiB