mboyov / Obsidian-ProgressBar

Tracking tasks with a progress bar with Obsidian

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License


Logo

Obsidian ProgressBar

Tracking tasks with a progress bar with Obsidian

Table of Contents
  1. About The Project
  2. Usage
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About

Product Name Screen Shot

I recently started using the Obsidian software. After configuring it to my preferences, I found that I was missing a visual overview of my task progress.

After some research, I found a way to integrate it, and now I would like to share this procedure.

Built With

Obsidian

Prerequisites

Plugins

Installation

After installing both plugins, I'll let you configure them like this:

Dataview

Dataview is a live index and query engine over your personal knowledge base. You can add metadata to your notes and query them with the Dataview Query Language to list, filter, sort or group your data. Dataview keeps your queries always up to date and makes data aggregation a breeze.

dataview_config

  • To reduce the refresh time, I'll let you change the value of the 'Refresh Interval' field from 2500 to 150 milliseconds.

If these options are not enabled, the JavaScript code we will edit later will not be able to be interpreted.

MetaEdit

By Christian B. B. Houmann aka chhoumann MetaEdit for Obsidian

Progress Properties that automatically update properties/fields

metaedit-config

I'll let you add these three fields and values as shown in the screenshot.

It's important to maintain the association between names and types, otherwise synchronization won't be possible.

It is now time to create your note page and add this header, specifying the property names.

header

To finish, we will now add our dataviewjs script.

dataviewjs

let myPage = dv.current()
    let total = myPage.total;
    let status = ((myPage.completed / myPage.total) * 100).toFixed();
    const progress = "![pb|500](https://progressbar-guibranco.vercel.app/" + status + "/?scale=" + "100" + "&width=400)";
    dv.header(3, "Objectif du jour"); dv.paragraph(progress);

We can now add our tasks and see the progress bar update automatically in read mode

progressbar

Usage

git clone git@github.com:mboyov/TasksProgressBar.git
  • In the Obsidian application, open a folder as a vault.
  • Select the location where you cloned the repository.
  • Trust the author and enable plugins.

Et voilĂ  !

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

v__nova - @mboyov - mboyov@arcadev.ch

Project Link: https://github.com/mboyov/TasksProgressBar

Acknowledgments

(back to top)

About

Tracking tasks with a progress bar with Obsidian

License:MIT License