Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rama1997/image-preview-on-icon-hover
Plugin for Obsidian that adds custom image previews when hovering over various icons in the user interface
https://github.com/rama1997/image-preview-on-icon-hover
obsidian obsidian-md obsidian-plugin
Last synced: 7 days ago
JSON representation
Plugin for Obsidian that adds custom image previews when hovering over various icons in the user interface
- Host: GitHub
- URL: https://github.com/rama1997/image-preview-on-icon-hover
- Owner: rama1997
- License: mit
- Created: 2024-12-17T23:10:27.000Z (8 days ago)
- Default Branch: main
- Last Pushed: 2024-12-17T23:57:20.000Z (8 days ago)
- Last Synced: 2024-12-18T00:28:41.509Z (8 days ago)
- Topics: obsidian, obsidian-md, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 21.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Image Preview on Icon Hover
Enhance your Obsidian experience by adding custom image previews when hovering over various icons in the user interface!
## ✨ Features
- **Custom Image Previews**: Add your own images to hover over various Obsidian icons
- **Flexible Configuration**: Customize images for:
- Vault Switcher
- Help Icon
- Settings Icon
- Left/Right Sidebar Toggles
- Ribbon Bar Icons
- Status Bar Icons
- **Interactive Icon Management**:
- Add, remove, and customize ribbon bar icons and status bar icons
- Search and select from a wide range of Obsidian icons
- Easily assign custom images to any icon
## 🚀 Installation
### From Obsidian's Community Plugins
1. Open Obsidian
2. Go to Settings → Community Plugins
3. Enable Community Plugins if not already done
4. Click "Browse" and search for "Image on Icon Hover"
5. Click "Install"
### From GitHub
1. Download the Latest Release from the Releases section of the GitHub Repository
2. Put files to your vault's plugins folder: `/.obsidian/plugins/image-preview-on-icon-hover`
3. Reload Obsidian
## 🎨 Usage
### Configuring Core Obsidian Icons
1. Open Obsidian Settings
2. Navigate to the "Image on Icon Hover" tab
3. You'll find sections for:
- Left/Right Sidebar Toggle
- Vault Switcher
- Help Icon
- Setting Icon
4. Enter the path to your desired image (e.g., `images/example.png`)
### Managing Ribbon and Status Bar Icons
1. In the plugin settings, you can:
- Add new icons with the "+" button
- Select custom icons
- Choose unique images for each icon
- Delete existing icons
### Image Path Guidelines
- Use relative paths from your vault root
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## 🐛 Reporting Issues
If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository.
Found a bug? Please open an issue on our GitHub repository with:
- Obsidian version
- Plugin version
- Detailed description of the issue
---
**Enjoy customizing your Obsidian icons!** 🖼️