Checkbox Progress

approved

by Wallace Wyslas

Shows checkbox progress bar in the view header (mobile + desktop) and status bar, with a reset button to clear all checkboxes. - This plugin has not been manually reviewed by Obsidian staff.

↓ 62 downloadsUpdated 1mo agoMIT
Install in ObsidianView on GitHub

Checkbox Progress for Obsidian

An Obsidian plugin that displays a real-time checkbox completion counter in your status bar (next to words and characters). It also adds a progress bar with a reset button to the view header on both desktop and mobile!

Status Bar and View Header

Features

  • Real-time Counting: Counts all checkboxes (- [ ], - [x], - [-], - [/]) in the active note.
  • Status Bar Integration: Displays ☑ 3/10 (30%) directly in the Obsidian status bar.
  • Smart Ignoring: Automatically ignores checkboxes inside code blocks (like dataviewjs) and frontmatter YAML.
  • Auto-hide: The counter hides itself gracefully in notes without any checkboxes.
  • Reset Button: Quickly clear all completed checkboxes in a note with a single click.

Reset Button Action

Manual Installation

While the plugin is not yet available in the Community Plugins directory, you can install it manually:

  1. Download the latest release from the GitHub Releases page.
  2. Extract the contents (main.js, manifest.json, styles.css) into your Obsidian vault's plugin directory: .obsidian/plugins/checkbox-progress/.
  3. In Obsidian, go to Settings > Community plugins and click Reload plugins.
  4. Enable "Checkbox Progress" in the plugins list.

Development

To build the plugin from source:

npm install
npm run build

How it works

The plugin listens to several Obsidian events to provide a seamless experience:

  • File open events
  • File modification (debounced 300ms for performance)
  • Tab/pane switching

Upon each event, it quickly scans the active note's content, counts total vs. completed checkboxes, and updates the UI elements accordingly.

License

This project is licensed under the MIT License - see the LICENSE file for details.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.