No description
Find a file
2025-11-27 10:55:45 -05:00
.github/workflows Add GitHub Actions workflow for plugin release 2025-11-26 23:01:27 -05:00
src Update changelog for version 1.0.4 and implement 'Keep in Tablet Mode' feature 2025-11-27 10:55:45 -05:00
.editorconfig Refactor toolbar extension and styles for improved readability and consistency 2025-11-26 16:58:12 +00:00
.eslintignore Initial commit 2025-11-26 06:22:53 -05:00
.eslintrc Initial commit 2025-11-26 06:22:53 -05:00
.gitignore Initial commit 2025-11-26 06:22:53 -05:00
.npmrc Initial commit 2025-11-26 06:22:53 -05:00
.prettierrc Add Prettier configuration and improve code formatting 2025-11-27 08:50:45 -05:00
AGENTS.md Initial commit 2025-11-26 06:22:53 -05:00
CHANGELOG.md Update changelog for version 1.0.4 and implement 'Keep in Tablet Mode' feature 2025-11-27 10:55:45 -05:00
esbuild.config.mjs Move main.ts into src directory 2025-11-26 11:39:16 +00:00
gestures.png Refactor code structure for improved readability and maintainability 2025-11-27 03:20:23 +00:00
keyboard.png Refactor code structure for improved readability and maintainability 2025-11-27 03:20:23 +00:00
LICENSE Update copyright holder in LICENSE file 2025-11-26 22:56:00 -05:00
manifest.json Release 1.0.3 2025-11-27 08:54:49 -05:00
package-lock.json Release 1.0.3 2025-11-27 08:54:49 -05:00
package.json Update changelog for version 1.0.4 and implement 'Keep in Tablet Mode' feature 2025-11-27 10:55:45 -05:00
README.md Update link for mobile friendly features request 2025-11-26 22:52:51 -05:00
release.sh Add release script for automated versioning and tagging 2025-11-27 03:45:55 +00:00
Settings.png Refactor code structure for improved readability and maintainability 2025-11-27 03:20:23 +00:00
styles.css Fix all ESLint and code quality issues from automated plugin review 2025-11-27 13:35:02 +00:00
ToolbarEditing.png Refactor code structure for improved readability and maintainability 2025-11-27 03:20:23 +00:00
tsconfig.json Initial commit 2025-11-26 06:22:53 -05:00
version-bump.mjs Initial commit 2025-11-26 06:22:53 -05:00
versions.json Initial commit 2025-11-26 06:22:53 -05:00

Mobile UX

A mobile-optimized UX enhancement plugin for Obsidian that provides a floating action button (FAB) and context-aware toolbars.

Ask me for mobile friendly features

Gestures

Gestures are the heart of this plugin. You can create completely custom gestures to trigger any command in Obsidian.

  1. Draw a gesture: Drag the Floating Action Button (FAB) to draw a shape.
  2. Assign a command: When you release the FAB, if the gesture is not recognized, you will be prompted to assign a command to it.
  3. Execute: Next time you draw the same shape, the assigned command will be executed.

Gestures are matched based on the shape, so you can draw them at any size or speed.

Features

Customizable Floating Action Button (FAB)

  • Tap: Executes a primary command (default: Create new note).
  • Long-press: Executes a secondary command (default: Open command palette).
  • Gestures: Drag the button to draw shapes and trigger any command.
  • Smart positioning: Anchors to the active editor leaf, ensuring it doesn't overlap navigation elements.
alt text alt text alt text alt text

Context-Aware Toolbars

Dynamic toolbars that adapt based on your cursor position and selection:

Context Description
Selection Text is selected
List Cursor in bullet/ordered list
Task Cursor in task list item
Heading Cursor in heading
Code Block Cursor in code block
Table Cursor in table
Blockquote Cursor in blockquote
Link Cursor on a link
Default Fallback when no other context matches

Toolbar Features

  • Two-section settings: Define toolbars in a library, then bind them to contexts.
  • Auto-concatenation: Multiple toolbars bound to the same context are automatically merged.
  • Icon support: Use Lucide icons with custom override capability.
  • Horizontal scrolling: Scrolls when too many buttons to fit.
  • Editor focus preservation: Keyboard stays open when using toolbar buttons.

Installation

Brat

  1. Install BRAT from the Community Plugins in Obsidian.
  2. Open the command palette and run BRAT: Add a beta plugin for testing.
  3. Enter the URL of this repository: https://github.com/TheJusticeMan/obsidian-mobile-plugin.
  4. Click Add Plugin.
  5. Enable the plugin in Settings → Community Plugins.

Configuration

Settings

Setting Description
Command confirmation Show confirmation before selecting a new command for a gesture
Use Icons Toggle between icon and text display in toolbars
Plus long press command Commands available for long press on the FAB button.
Plus press command Commands available for press on the FAB button.
Enable haptic feedback Vibrate on FAB and toolbar button interactions
Gesture Commands Manage your created gestures (rename, reassign, delete)
Reset to default Restore all settings to their original defaults

Toolbar Library

Create reusable toolbars with custom command sets:

  1. Click Add Toolbar.
  2. Give it a name (e.g., "Formatting").
  3. Add commands by their ID (e.g., editor:toggle-bold).
  4. Optionally set custom icons for each command.

Context Bindings

Bind toolbars to editing contexts:

  1. Click Add Binding.
  2. Select a context type (Selection, List, Table, etc.).
  3. Select a toolbar from your library.
  4. Multiple bindings to the same context are auto-concatenated.

Commands

Command Description
Toggle wake lock Keeps the screen awake while editing
Plus press Executes the command configured for FAB press
Plus long press Executes the command configured for FAB long press
Open mobile plugin settings Opens the settings modal for this plugin

Development

Prerequisites

  • Node.js v16 or higher
  • npm

Setup

# Clone the repository
git clone https://github.com/TheJusticeMan/obsidian-mobile-plugin.git

# Install dependencies
npm install

# Build for development (watch mode)
npm run dev

# Build for production
npm run build

Project Structure

src/
├── main.ts              # Plugin entry point
├── fab.ts               # Floating Action Button manager
├── toolbar-extension.ts # Context-aware toolbar ViewPlugin
└── settings.ts          # Settings tab and interfaces

License

MIT

Author

Justice Vellacott

Support

If you encounter any issues or have feature requests, please open an issue on GitHub.