Text Progress Bar

by Michael Adams
5
4
3
2
1
Score: 40/100

Description

Category: Note Enhancements

The Text Progress Bar plugin enhances Obsidian by allowing users to create customizable text-based or emoji-based progress bars directly in their notes. Progress bars are defined in code blocks, where users specify labels, completed progress, and totals. Additional customization options include defining the fill, empty, and transition characters or emojis, along with prefixes, suffixes, and bar length. The plugin supports partial completion with transitions and decimal progress values. Users can group multiple progress bars in a single block, making it ideal for tracking progress across multiple goals or tasks in a visually engaging format.

Reviews

No reviews yet.

Stats

46
stars
7,681
downloads
0
forks
1,296
days
1,234
days
1,234
days
13
total PRs
0
open PRs
0
closed PRs
13
merged PRs
7
total issues
4
open issues
3
closed issues
0
commits

Latest Version

3 years ago

Changelog

What's Changed

Full Changelog: https://github.com/michaeladams/obsidian-text-progress-bar/compare/0.1.0...0.2.0

README file from

Github

Text Progress Bars for Obsidian

Release Tests

Adds text-based and emoji progress bars to Obsidian.

Usage

To create a progress bar, start a code block with "text-progress-bar".

A minimal bar contains the bars label, how much is complete, and the total number.

Defaults will be taken from the plugin settings.

```text-progress-bar
Books read:1/10
```

Default example

Optionally, all the settings can be specified:

```text-progress-bar
Books read:5/10
transition:|
fill:▓
empty: 
prefix:[
suffix:]
length:10
```

Default example

Note that empty has "" - a special empty character.

Want emojis? We got em:

```text-progress-bar
Chickens hatched:5/10
fill:🐥
empty:🥚
prefix:[
suffix:]
length:10
```

Default example

Specify a transition to display a character for partial completion:

```text-progress-bar
Thats no moon:10/20
transition: 🌘,🌗,🌔
fill:🌕
empty:🌑
prefix:[
suffix:]
length:3
```

Default example

And use decimal numbers to specify the partial completion of emojis

```text-progress-bar
Books read:5.5/10
transition:📖
fill:📗
empty:📕
length:10
```

Or use ASCII characters for the transition:

```text-progress-bar
Books read:5/10
transition:⣦
fill:⣿
empty:⣀
prefix:⎸
suffix:⎹
length:3
```

ASCII Transition

Multiple progress bars.

Progress bars can be grouped together in one block using multiple labels.

```text-progress-bar
JAN:10.0/10
FEB:1.0/10
MAR:5.5/10
transition:📖
fill:📗
empty:📕
length:10
```

Grouped progress

Installation

The plugin can be installed manually:

  1. Download the latest release
  2. Extract the contents into your ./obsidian/plugins/ folder
  3. Reload Obsidian
  4. Enable the plugin from your settings

Similar Plugins

info
• Similar plugins are suggested based on the common tags between the plugins.