Text Progress Bar

approved

by Michael Adams

Display low-fi text progress bars in your notes.

45 stars7,319 downloadsUpdated 2y agoMIT
View on 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

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.