bkindler_imagefull/README.md
Björn Kindler 64c92137fe Prepare for community plugin submission
- Replace img.style.transform with setCssProps/CSS custom properties (lint-compliant)
- Switch classList to Obsidian toggleClass/addClass/removeClass helpers
- Remove unused async from onload, remove dead panning state
- Track open viewers so onunload closes all overlays cleanly
- Translate hint text and description to English for directory
- Add LICENSE (MIT), README, .gitignore, package.json, eslint config
- Stop tracking MEMORY.md (dev-only artifact)
2026-04-17 11:33:08 +02:00

46 lines
1.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ImageFull
Minimal Obsidian plugin that opens embedded images in a clean fullscreen viewer with gesture-based zoom and pan. No settings, no toolbar — just the image.
## Features
- **Double-click** (or double-tap on touch) an embedded image → fullscreen overlay
- **Pinch** (touch or trackpad) → zoom up to 10×
- **Two-finger swipe** / trackpad swipe → shift the visible image section
- **Mouse drag** when zoomed → pan
- **Double-click overlay** → close
- **Keyboard**: `Esc` closes · `0` resets the zoom
- Works in reading view and live preview, desktop and mobile
## Installation
### From the community directory (once approved)
Settings → Community plugins → Browse → search "ImageFull" → Install → Enable.
### Manual
1. Download `main.js`, `manifest.json`, `styles.css` from the latest release.
2. Place them in `<Vault>/.obsidian/plugins/imagefull/`.
3. Settings → Community plugins → enable *ImageFull*.
## Usage
Double-click any embedded image in a note (works in both reading and live-preview modes). The image opens centered on a dimmed overlay. Use pinch or two-finger swipe to zoom and pan. Double-click anywhere on the overlay to close.
## Why a separate plugin?
Obsidian's built-in image preview opens in a side pane and doesn't offer a clean fullscreen flow with pinch zoom. ImageFull keeps the interaction minimal — one gesture to open, one to close, and standard pinch/pan in between.
## Development
No build step. The plugin is a single `main.js` plus `styles.css`. Edit directly and reload the plugin in Obsidian.
Run the community-submission linter locally:
```bash
npm install
npm run lint
```
## License
MIT © Björn Kindler