peritus_obsidian-interactiv.../README.md

# Interactive Ratings Plugin for Obsidian

Add interactive rating symbols to your notes that update with a click.

<img alt="demo of the Interactive Ratings Plugin for Obsidian" src="screencast.gif" width="400" />


## Supported Symbol Sets

| Symbol Type | Full | Empty | Half | Examples |
|-------------|------|-------|------|----------|
| Stars | ★ | ☆ |  | `★★★☆☆ (3/5)` Book rating |
| Star Symbols | ✦ | ✧ |  | `✦✦✦✧✧ (3/5)` Stargazing |
| Moon Phases | 🌕 | 🌑 | 🌗 | `🌕🌕🌗🌑🌑 (2.5/5)` Lunar observation |
| Circles | ● | ○ | ◐ | `●●●○○○○○○○ 3/10` Movie review scale |
| Squares | ■ | □ | ◧ | `■■■□ (3/4)` Recipe difficulty |
| Triangles | ▲ | △ |  | `▲▲▲▲▲△△△△△△△ 5/12` Hiking difficulty |
| Red Hearts | ❤️ | 🤍 |  | `❤️❤️❤️🤍🤍 (3/5)` Celebrity crush |
| Orange Hearts | 🧡 | 🤍 |  | `🧡🧡🧡🧡🤍 80%` Sunset addiction |
| Yellow Hearts | 💛 | 🤍 |  | `💛💛🤍🤍 2/4` Wizard vibes |
| Green Hearts | 💚 | 🤍 |  | `💚💚💚🤍🤍🤍 50%` Plant guilt |
| Blue Hearts | 💙 | 🤍 |  | `💙💙🤍🤍🤍 (2/5)` Ocean yearning |
| Purple Hearts | 💜 | 🤍 |  | `💜💜💜💜🤍 4/5` Unicorn belief |
| Black Hearts | 🖤 | 🤍 |  | `🖤🖤🖤🤍 75%` Villain sympathy |
| Brown Hearts | 🤎 | 🤍 |  | `🤎🤎🤍🤍🤍 (2/5)` Chocolate dependency |
| Block Progress | █ | ▁ |  | `███▁▁▁ (3/6)` Project completion |
| Braille Dots | ⣿ | ⣀ | ⡇ | `⣿⣿⡇⣀⣀⣀⣀⣀⣀⣀ 2.5/10` |
| Solid/Empty Circles | ⬤ | ○ |  | `⬤⬤⬤○○○○○○○○○ 25%` Budget spending |
| Solid/Empty Squares | ■ | □ | | `■■■□□□□ 3/7` Weekly progress |
| Dotted Squares | ▰ | ▱ | | `▰▰▰▱▱▱▱▱▱▱ (3/10)` Task complexity |
| Filled/Empty Rectangles | ◼ | ▭ | | `◼◼◼▭ 75%` Reading progress |
| Vertical Bars | ▮ | ▯ | | `▮▮▮▮▮▮▯▯▯▯▯▯ 50%` Battery level |
| Bold Circles | ⬤ | ◯ | | `⬤◯◯ 1/3` Quick product review |
| Black/White Circles | ⚫ | ⚪ | | `⚫⚫⚫⚫⚫⚪⚪⚪⚪⚪ (5/10)` Coffee strength |
| Block/Light Shade | █ | ░ | | `███░░░░░░░ 30%` Download progress |

## Usage

Type any supported symbol sequence (minimum 3 identical symbols) in your note. When you hover over these symbols in edit mode, clicking on one of the symbols allowing you to update the rating.

### Rating Text (optional)

Add numerical ratings with these formats:

- `★★★☆☆` - Only symbols, no rating text
- `★★★☆☆ 3/5` - Fraction without parentheses
- `★★★☆☆ (3/5)` - Fraction in parentheses
- `★★★☆☆ 60%` - Percentage
- `★★★☆☆ (60%)` - Percentage in parentheses

The numerical rating updates automatically when you change the symbols.

### Custom Emojis

You can configure which emojis are supported for rating interactions by going to Settings → Community Plugins → Interactive Ratings. In the "Emojis to support in ratings" setting, enter any emojis you want to use for ratings.

**Default emojis**: `🎥🏆⭐💎🔥⚡🎯🚀💰🎖️`

**ZWJ Sequence Support**: The plugin fully supports complex emojis including ZWJ (Zero Width Joiner) sequences such as:
- 🏴‍☠️ (Pirate Flag)
- 👨‍🚒 (Man Firefighter) 
- 🏳️‍🌈 (Rainbow Flag)
- And other compound emojis

**Example usage**:
- `🎥🎥🎥🎥🎥 (4/5)` Movie rating
- `🏆🏆🏆 3/5` Achievement level  
- `🔥🔥🔥🔥 80%` Spice level
- `🎯🎯🎯🎯🎯🎯 (5/6)` Accuracy rating
- `🏴‍☠️🏴‍☠️🏴‍☠️ (3/5)` Pirate movie rating


## Installation

1. In Obsidian settings, go to Community Plugins
2. Disable Safe Mode
3. Search for "Interactive Ratings"
4. Install and enable the plugin


## Use Cases

- **Book/Media Reviews**: `★★★★☆☆☆☆☆☆ Just okay, 4/10`
- **Habit Tracking**: `Exercise: ●●●○○○○ (3/7) days this week`
- **Project Status**: `Client project: ████████░░ 80% complete`
- **Recipe Notes**: `Pasta recipe: ■■■□ (3/4) difficulty, would make again`
- **Learning Progress**: `Spanish vocabulary: ⬤⬤⬤⬤⬤⬤◯◯◯◯ 60% mastered`

## Support

For issues or feature requests: [GitHub repository](https://github.com/peritus/obsidian-interactive-ratings)

## License

MIT
add README + screencast 2025-03-17 16:30:05 +00:00			`# Interactive Ratings Plugin for Obsidian`

			`Add interactive rating symbols to your notes that update with a click.`

fix resolution of screencast gif in README 2025-03-18 18:11:57 +00:00			`<img alt="demo of the Interactive Ratings Plugin for Obsidian" src="screencast.gif" width="400" />`
add README + screencast 2025-03-17 16:30:05 +00:00

			`## Supported Symbol Sets`

			`\| Symbol Type \| Full \| Empty \| Half \| Examples \|`
			`\|-------------\|------\|-------\|------\|----------\|`
			\| Stars \| ★ \| ☆ \| \| `★★★☆☆ (3/5)` Book rating \|
Add missing Star Symbols (✦/✧) to README documentation table 2025-06-09 11:55:20 +00:00			\| Star Symbols \| ✦ \| ✧ \| \| `✦✦✦✧✧ (3/5)` Stargazing \|
Add moon phase emoji symbol set (🌕🌑🌗) with Unicode-aware parsing support Fix multibyte emoji handling: replace pattern.length with Unicode-aware length calculation and fix regex generation for emojis Fix emoji rating text parsing by converting UTF-16 positions to Unicode positions 2025-06-09 12:05:09 +00:00			\| Moon Phases \| 🌕 \| 🌑 \| 🌗 \| `🌕🌕🌗🌑🌑 (2.5/5)` Lunar observation \|
add README + screencast 2025-03-17 16:30:05 +00:00			\| Circles \| ● \| ○ \| ◐ \| `●●●○○○○○○○ 3/10` Movie review scale \|
			\| Squares \| ■ \| □ \| ◧ \| `■■■□ (3/4)` Recipe difficulty \|
			\| Triangles \| ▲ \| △ \| \| `▲▲▲▲▲△△△△△△△ 5/12` Hiking difficulty \|
Add support for colored hearts - Add red hearts (❤️/🤍) - Add orange, yellow, green, blue, purple, black, and brown hearts - All heart patterns use white heart (🤍) as empty symbol - No half-heart support (half: null) for all heart patterns Add heart rating examples to README 2025-06-09 19:20:22 +00:00			\| Red Hearts \| ❤️ \| 🤍 \| \| `❤️❤️❤️🤍🤍 (3/5)` Celebrity crush \|
			\| Orange Hearts \| 🧡 \| 🤍 \| \| `🧡🧡🧡🧡🤍 80%` Sunset addiction \|
			\| Yellow Hearts \| 💛 \| 🤍 \| \| `💛💛🤍🤍 2/4` Wizard vibes \|
			\| Green Hearts \| 💚 \| 🤍 \| \| `💚💚💚🤍🤍🤍 50%` Plant guilt \|
			\| Blue Hearts \| 💙 \| 🤍 \| \| `💙💙🤍🤍🤍 (2/5)` Ocean yearning \|
			\| Purple Hearts \| 💜 \| 🤍 \| \| `💜💜💜💜🤍 4/5` Unicorn belief \|
			\| Black Hearts \| 🖤 \| 🤍 \| \| `🖤🖤🖤🤍 75%` Villain sympathy \|
			\| Brown Hearts \| 🤎 \| 🤍 \| \| `🤎🤎🤍🤍🤍 (2/5)` Chocolate dependency \|
add README + screencast 2025-03-17 16:30:05 +00:00			\| Block Progress \| █ \| ▁ \| \| `███▁▁▁ (3/6)` Project completion \|
			\| Braille Dots \| ⣿ \| ⣀ \| ⡇ \| `⣿⣿⡇⣀⣀⣀⣀⣀⣀⣀ 2.5/10` \|
			\| Solid/Empty Circles \| ⬤ \| ○ \| \| `⬤⬤⬤○○○○○○○○○ 25%` Budget spending \|
			\| Solid/Empty Squares \| ■ \| □ \| \| `■■■□□□□ 3/7` Weekly progress \|
			\| Dotted Squares \| ▰ \| ▱ \| \| `▰▰▰▱▱▱▱▱▱▱ (3/10)` Task complexity \|
			\| Filled/Empty Rectangles \| ◼ \| ▭ \| \| `◼◼◼▭ 75%` Reading progress \|
			\| Vertical Bars \| ▮ \| ▯ \| \| `▮▮▮▮▮▮▯▯▯▯▯▯ 50%` Battery level \|
			\| Bold Circles \| ⬤ \| ◯ \| \| `⬤◯◯ 1/3` Quick product review \|
			\| Black/White Circles \| ⚫ \| ⚪ \| \| `⚫⚫⚫⚫⚫⚪⚪⚪⚪⚪ (5/10)` Coffee strength \|
			\| Block/Light Shade \| █ \| ░ \| \| `███░░░░░░░ 30%` Download progress \|

Re-arrange README 2025-06-10 06:34:53 +00:00			`## Usage`

			`Type any supported symbol sequence (minimum 3 identical symbols) in your note. When you hover over these symbols in edit mode, clicking on one of the symbols allowing you to update the rating.`

			`### Rating Text (optional)`

			`Add numerical ratings with these formats:`

			- `★★★☆☆` - Only symbols, no rating text
			- `★★★☆☆ 3/5` - Fraction without parentheses
			- `★★★☆☆ (3/5)` - Fraction in parentheses
			- `★★★☆☆ 60%` - Percentage
			- `★★★☆☆ (60%)` - Percentage in parentheses

			`The numerical rating updates automatically when you change the symbols.`

			`### Custom Emojis`

			`You can configure which emojis are supported for rating interactions by going to Settings → Community Plugins → Interactive Ratings. In the "Emojis to support in ratings" setting, enter any emojis you want to use for ratings.`

			Default emojis: `🎥🏆⭐💎🔥⚡🎯🚀💰🎖️`

Fix ZWJ sequence emoji support in custom emoji settings - Add getGraphemeClusters.ts utility for proper emoji segmentation - Update updateSymbolPatternsFromSettings.ts to handle ZWJ sequences correctly - Enhance Unicode utilities to use grapheme clusters instead of UTF-16 code units - Support complex emojis like 🏴‍☠️ (Pirate Flag), 👨‍🚒 (Man Firefighter), etc. - Uses Intl.Segmenter when available, with regex fallback for older environments - Fully backward compatible with existing emoji configurations - Update documentation and add changelog entry Fixes bug where ZWJ sequence emojis were split into component parts instead of being treated as single emojis. Simplify ZWJ sequence fix by inlining Intl.Segmenter - Remove overengineered getGraphemeClusters.ts utility - Inline simple Intl.Segmenter usage directly where needed - Assume Intl.Segmenter is available in all target environments - Reduced bundle size and simplified codebase - Update documentation to reflect simplified approach 2025-09-06 12:58:16 +00:00			`ZWJ Sequence Support: The plugin fully supports complex emojis including ZWJ (Zero Width Joiner) sequences such as:`
			`- 🏴‍☠️ (Pirate Flag)`
			`- 👨‍🚒 (Man Firefighter)`
			`- 🏳️‍🌈 (Rainbow Flag)`
			`- And other compound emojis`

Re-arrange README 2025-06-10 06:34:53 +00:00			`Example usage:`
			- `🎥🎥🎥🎥🎥 (4/5)` Movie rating
			- `🏆🏆🏆 3/5` Achievement level
			- `🔥🔥🔥🔥 80%` Spice level
			- `🎯🎯🎯🎯🎯🎯 (5/6)` Accuracy rating
Fix ZWJ sequence emoji support in custom emoji settings - Add getGraphemeClusters.ts utility for proper emoji segmentation - Update updateSymbolPatternsFromSettings.ts to handle ZWJ sequences correctly - Enhance Unicode utilities to use grapheme clusters instead of UTF-16 code units - Support complex emojis like 🏴‍☠️ (Pirate Flag), 👨‍🚒 (Man Firefighter), etc. - Uses Intl.Segmenter when available, with regex fallback for older environments - Fully backward compatible with existing emoji configurations - Update documentation and add changelog entry Fixes bug where ZWJ sequence emojis were split into component parts instead of being treated as single emojis. Simplify ZWJ sequence fix by inlining Intl.Segmenter - Remove overengineered getGraphemeClusters.ts utility - Inline simple Intl.Segmenter usage directly where needed - Assume Intl.Segmenter is available in all target environments - Reduced bundle size and simplified codebase - Update documentation to reflect simplified approach 2025-09-06 12:58:16 +00:00			- `🏴‍☠️🏴‍☠️🏴‍☠️ (3/5)` Pirate movie rating
Re-arrange README 2025-06-10 06:34:53 +00:00

			`## Installation`

			`1. In Obsidian settings, go to Community Plugins`
			`2. Disable Safe Mode`
			`3. Search for "Interactive Ratings"`
			`4. Install and enable the plugin`


add README + screencast 2025-03-17 16:30:05 +00:00			`## Use Cases`

			- Book/Media Reviews: `★★★★☆☆☆☆☆☆ Just okay, 4/10`
			- Habit Tracking: `Exercise: ●●●○○○○ (3/7) days this week`
			- Project Status: `Client project: ████████░░ 80% complete`
			- Recipe Notes: `Pasta recipe: ■■■□ (3/4) difficulty, would make again`
			- Learning Progress: `Spanish vocabulary: ⬤⬤⬤⬤⬤⬤◯◯◯◯ 60% mastered`

			`## Support`

			`For issues or feature requests: [GitHub repository](https://github.com/peritus/obsidian-interactive-ratings)`

			`## License`

			`MIT`