obsidian-plugin/rama1997_Image-Preview-On-Icon-Hover
1
0
Fork 0
mirror of https://github.com/rama1997/Image-Preview-On-Icon-Hover.git synced 2026-07-22 11:40:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
20 commits 1 branch 4 tags 22 MiB
TypeScript 88.3%
CSS 6.8%
JavaScript 4.9%
Find a file
rama1997 e51c05acee Added "manager" folder for manager files
2025-02-19 14:46:57 -08:00
.github/workflows Add release workflow 2024-12-17 15:12:18 -08:00
assets Initial commit 2024-12-17 15:11:28 -08:00
src Added "manager" folder for manager files 2025-02-19 14:46:57 -08:00
.editorconfig Add ignored files 2024-12-17 15:57:14 -08:00
.eslintignore Add ignored files 2024-12-17 15:57:14 -08:00
.eslintrc Add ignored files 2024-12-17 15:57:14 -08:00
.gitignore Add ignored files 2024-12-17 15:57:14 -08:00
.npmrc Add ignored files 2024-12-17 15:57:14 -08:00
esbuild.config.mjs Initial commit 2024-12-17 15:11:28 -08:00
LICENSE Initial commit 2024-12-17 15:10:27 -08:00
manifest.json Update version to 1.0.3 2025-01-28 02:05:02 -08:00
package-lock.json Initial commit 2024-12-17 15:11:28 -08:00
package.json Initial commit 2024-12-17 15:11:28 -08:00
README.md Update README.md 2025-02-19 13:19:06 -08:00
styles.css Edit data attribute in styles 2025-01-16 15:36:43 -08:00
tsconfig.json Initial commit 2024-12-17 15:11:28 -08:00
version-bump.mjs Initial commit 2024-12-17 15:11:28 -08:00
versions.json Initial commit 2024-12-17 15:11:28 -08:00

README.md

Image Preview on Icon Hover

Enhance your Obsidian experience by adding image popups when hovering over various icons in the user interface!

Descriptive Alt Text

✨ 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 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.