Obsidian Widget for Android

A feature-rich Android home screen widget for Obsidian. View your notes, check off tasks, and capture ideas — all without opening the app.

Install

Option 1: Download the APK (easiest)

1. Go to the Releases page
2. Download the latest .apk file
3. On your Android device, open the APK and tap Install
   • You may need to enable "Install from unknown sources" in Settings

Option 2: Build from source

git clone https://github.com/YOUR_USERNAME/obsidian-widget.git
cd obsidian-widget
./gradlew assembleRelease
# APK will be at app/build/outputs/apk/release/app-release-unsigned.apk

Or open in Android Studio and click Run.

Setup

1. Open the Obsidian Widget app and select your vault folder
2. Long-press your home screen → Widgets → drag Obsidian Widget
3. Tap the ⚙ gear icon on the widget to configure it

Features

• Daily note or pinned notes — show today's daily note or pick specific files
• Multiple notes per widget — cycle between notes with the swap arrow
• Interactive checkboxes — tap to toggle - [ ] / - [x] directly from the widget
• Quick capture — "Note" button appends to today's daily note
• Append with + — one-tap add to whichever note the widget is currently showing
• TODO counter — optional live count of unchecked tasks in the header
• Markdown rendering — bold, italic, links, headings, and bullet lists
• Clickable links — tap URLs and Markdown links to open in your browser
• Nested indentation — sub-items display with matching indent levels
• Sort unchecked first — push completed tasks to the bottom
• Accent color presets — 8 color choices (terracotta, purple, blue, green, red, teal, pink, amber)
• Dark & light themes — choose your preferred look
• Widget transparency — adjustable opacity to blend with your wallpaper
• Auto-refresh — updates every 15 minutes and on screen unlock
• Deep link to Obsidian — tap the title to open the note in Obsidian
• Per-widget settings — each widget has independent configuration

Widget Configuration

All settings are per-widget. Tap the ⚙ icon on any widget to access:

Setting	Description
Vault	Select your Obsidian vault folder
Note Mode	Daily note or specific note(s)
Notes	Add/remove multiple pinned notes
Daily Subfolder	e.g. Daily Notes
Date Format	Any Java date pattern (yyyy-MM-dd, dd-MM-yyyy, etc.)
Show Buttons	Toggle the + Add / Note button bar
Sort Unchecked	Move incomplete tasks to the top
Tap Checkbox Only	Require tapping the checkbox circle to toggle
Show Add-to-Top	Show the add-to-top toggle on capture dialogs
Show TODO Count	Display unchecked task count in the header
Theme	Dark or Light
Accent Color	Pick from 8 color presets
Widget Opacity	0–100% transparency slider

Requirements

• Android 8.0+ (API 26)
• Obsidian vault accessible on device (local or synced)
• No root or special permissions needed — uses Android's Storage Access Framework

Project Structure

app/src/main/java/com/obsidianwidget/
├── ObsidianWidgetApp.kt          # Application class (screen-unlock auto-refresh)
├── MainActivity.kt               # Welcome screen & vault selection
├── WidgetConfigActivity.kt       # Per-widget settings (gear icon)
├── ObsidianWidgetProvider.kt     # Widget rendering & action handling
├── ChecklistWidgetService.kt     # ListView adapter (checkboxes, text, headings)
├── QuickCaptureActivity.kt       # Quick capture & add-line dialogs
└── VaultManager.kt               # Vault I/O, preferences, themes, markdown parsing

Tech Stack

• Kotlin + AndroidX
• Storage Access Framework — secure file access, no broad storage permissions
• AppWidgetProvider + RemoteViewsService — native widget framework
• SharedPreferences — per-widget settings with _widgetId key suffixing

License

MIT