No description
Find a file
2025-11-21 08:57:08 +01:00
.github/workflows feat: add release workflow 2025-04-03 16:08:37 +02:00
.husky feat: increase packages versions; add lintern; add formatter; add pre-commit hook 2025-05-25 12:08:27 +02:00
components feat: fuzzy finder for lucide icons 2025-11-21 08:57:08 +01:00
constants feat: add configurable single-status frontmatter storage 2025-11-18 18:48:58 +01:00
core feat: add configurable single-status frontmatter storage 2025-11-18 18:48:58 +01:00
images chore: updated readme 2025-07-23 21:01:20 +02:00
integrations feat: add lucid icons support 2025-11-21 08:04:30 +01:00
scripts refactor: auto-format 2025-05-25 13:24:28 +02:00
styles feat: add lucid icon modal 2025-11-21 08:51:00 +01:00
types feat: add lucid icons support 2025-11-21 08:04:30 +01:00
utils feat: add lucid icons support 2025-11-21 08:04:30 +01:00
wiki chore: remove unused setting 2025-07-21 18:55:19 +02:00
.editorconfig Initial commit 2025-04-03 15:49:10 +02:00
.eslintignore Initial commit 2025-04-03 15:49:10 +02:00
.eslintrc Initial commit 2025-04-03 15:49:10 +02:00
.gitignore chore: remove .obsidian folder, added to gitignore 2025-07-21 20:54:30 +02:00
.npmrc Initial commit 2025-04-03 15:49:10 +02:00
esbuild.config.mjs refactor: js components to react 2025-06-15 17:37:20 +02:00
LICENSE chore: update the LICENSE file 2025-05-05 12:20:13 +02:00
main.tsx feat: add setting to toggle status overview popup 2025-11-17 18:01:05 +01:00
manifest.json chore: new version 2025-08-07 21:07:44 +02:00
package-lock.json refactor: vanillajs to react 2025-07-15 17:30:17 +02:00
package.json chore: add v2 and build styles 2025-07-23 21:11:51 +02:00
README.md chore: add v2 and build styles 2025-07-23 21:11:51 +02:00
styles.css feat: align status modal icons with explorer styles and polish selector layout 2025-11-18 19:05:48 +01:00
tsconfig.json chore: style and reused func 2025-07-19 18:30:54 +02:00
version-bump.mjs Initial commit 2025-04-03 15:49:10 +02:00
versions.json Initial commit 2025-04-03 15:49:10 +02:00

Note Status for Obsidian

GitHub release Build Status Obsidian Downloads GitHub License GitHub Stars

Track the status of your notes with a powerful, customizable status management system. Mark notes as active, completed, on hold, or create your own custom workflows.

Status assignment workflow demonstration

Alt: Demonstration of assigning status to a note using the toolbar dropdown

🎯 Features

  • 📋 Status Assignment - Mark notes with workflow statuses (active, completed, on hold, etc.)
  • 🎯 Multi-Status Support - Assign multiple statuses per note
  • 📁 File Explorer Icons - Visual indicators next to filenames with configurable positioning
  • 🧭 Status Bar Integration - View current status at bottom of editor
  • ⬇️ Toolbar Dropdown - Change statuses quickly from editor toolbar
  • 📊 Status Dashboard - Vault overview with statistics and quick actions
  • 📈 Grouped View - Browse notes organized by status with search and filtering
  • Batch Operations - Update multiple files simultaneously
  • 🎨 Custom Statuses - Create your own statuses with icons, colors, and descriptions
  • 🏷️ Template Scoping - Organize statuses by note templates
  • 🚀 Performance Optimized - Works with large vaults (40k+ notes tested)

File explorer with status icons

Alt: File explorer showing multiple notes with different status icons positioned next to note names and the tooltip with status overview

Status dashboard with vault statistics

Alt: Status dashboard showing current note information, vault statistics with total notes and coverage percentages Status dashboard with vault statistics

Alt: Status distribution chart showing different statuses with colored bars and note counts for each status type Status dashboard with vault statistics

Alt: Quick actions panel with organized sections for views, current note operations, clipboard actions, and tools

💻 Technology Stack

Built with modern web technologies for performance and reliability:

  • TypeScript - Type-safe development
  • React - Modern UI framework
  • esbuild - Fast bundling and development
  • Obsidian API - Deep vault integration

📦 Installation

  1. Open Obsidian → Settings → Community plugins
  2. Disable Safe mode → Browse → Search "Note Status"
  3. Install and Enable

Manual Installation

  1. Download latest release from GitHub Releases
  2. Extract main.js, manifest.json, and styles.css to .obsidian/plugins/note-status/
  3. Enable in Community plugins settings

🚀 How to Use

Quick Start

  1. Assign Status:

    1. Click the "No status" in toolbar

      Status toolbar

      Alt: Editor toolbar showing "No status" button for status assignment

    2. → Select a status

  2. View in Explorer: Status icons appear next to note names

    File explorer item

    Alt: Single file explorer item showing a note with status icon positioned next to the filename

  3. Browse by Status or open the Dashboard: Open from left sidebar

    Open status view

    Alt: Left sidebar showing ribbon buttons for opening grouped status view and status dashboard

  4. Batch Update: Select multiple files → Right-click → Change status

    Multiple status context

    Alt: Context menu appearing when right-clicking multiple selected files, showing "Change note status" option

Example Workflows

Personal Knowledge Management

💡 idea → 📝 draft → ✏️ editing → ✅ completed → 📦 archived

Project Management

📋 backlog → 🚦 ready → 👨‍💻 inDevelopment → 🧪 testing → 🚀 live

Academic Research

🔍 research → 📑 outline → ✏️ draft → 🔬 review → 📚 final

Grouped status view with filtering

Alt: Grouped status view showing notes organized by status with template filtering and search functionality

Custom Statuses

Create your own workflow:

  1. Settings → Note Status → Custom Statuses
  2. Add Status → Configure name, icon, color, description
  3. Reorder using arrow controls
  4. Use in your notes

Example custom status:

Name: urgent
Icon: 🔥
Color: #FF0000
Description: Requires immediate attention

Custom statuses

Alt: Status selection modal showing custom and template statuses with icons, names, and selection interface

📋 Data Format

Statuses are stored in YAML frontmatter:

---
obsidian-note-status:
    - active
    - inProgress
---

Works with:

  • Dataview queries
  • Templater scripts
  • QuickAdd macros
  • Global search

🛠️ API Reference

For developers building integrations or contributing:

📚 Developer Documentation

Includes:

  • Architecture overview
  • Development setup
  • API reference
  • Contributing guide

🤝 Contributing

We welcome contributions!

  1. Check GitHub Issues for bugs/features
  2. Fork the repository
  3. Follow Development Setup
  4. Submit pull request

🐛 Support

❤️ Support Development

If you find this plugin useful:

PayPal

PayPal: https://paypal.me/aleixsoler


License: MIT | Author: Aleix Soler