Portals

by samaraliwarsi
5
4
3
2
1
Score: 60/100

Description

Obsidian plugin to create pinned folder trees for easier navigation

Reviews

No reviews yet.

Stats

84
stars
16,223
downloads
5
forks
162
days
2
days
2
days
1
total PRs
0
open PRs
0
closed PRs
1
merged PRs
29
total issues
1
open issues
28
closed issues
687
commits

Latest Version

3 days ago

Changelog

Version 1.5.1

Portals lets you pin any folder or tag as a customisable tab – a Portal into your selected folder trees.

CHANGES

  • Reminders now operate using a cache to incrementally update instead of vault read on file changes. This improves performance on vaults with many files with many reminders.
  • New Notice on save data. When user data changes and the issues like system disk full or any system level issues prevent writing to portals data file, a user notice is shown on the screen showing that data writing has failed.

IMPROVEMENTS & FIXES

  • Fixed a bug where File Previews on new files would only generate after a render or tree rebuild. Now updates surgically with debounced render.
  • Fixed a bug where Sections required a full render or tree rebuild to show updates when file properties change. Now updates surgically with debounced render.
  • Fixed an issue where closing the Portals view would not clear certain Portals related items out of the memory.
  • Fixed an issue regarding stale items lingering in memory on Obsidian app close or Portals plugin disable.

[!Note]

  •  Releases 1.4.3 onwards, Portals requires Obsidian 1.13.0 or later. If you're on an older version, update Obsidian first — your Portals settings will be preserved.
  • Please make sure to backup your data file after a full setup of your preferences, color & icon choices. You can backup by copying the file .obsidian/plugins/portals/data.json to safe location. You can also export the same via Settings and later import it. Make sure to backup before any plugin updates for safety measure.
  • For best results,
    • On mobile: Works best with Baseline Theme right now as the theme renders vault on the top side. On other themes, turn off floating navigation in settings, i.e. Settings > Appearance > Floating Navigation.
    • On desktop, you may need to turn off vault hiding if your theme hides the vault on the lower side.

✨ General feature list

  • Pin folders & tags as tabs at the top of the file pane.
  • Stacks – group multiple tabs into collapsible stacks.
  • Custom icons & colors – tabs, folders, files, tag groups.
  • Six visual styles + compact tree view + bold folder names.
  • Tag grouping & subtag support for tag portals.
  • Multi‑select files, folders, and tags with Alt+Click or Swipe right. Use multi-select toolbar for actions.
  • Command palette to add or remove portals and configure side portals.
  • Foldable floating action buttons for note/ folder creation, tag grouping, collapse and sort.
  • Custom display names for tabs, stacks.
  • Side Portal - A modular, collapsible, resizable view containing, Bookmarks, Recent Files, Context notes, Hidden, Properties and Journal.
    • Context Notes - an expansion to the older Folder notes feature. Context notes apply to folder as well as tags.
    • Recents - Shows recent files list from across the vault.
    • Bookmarks - Shows bookmarked files, folders or web links.
    • Journal - A viewing and marking tool for Daily Notes with a quote display feature.
    • Hidden - Place to show files, tags and folders hidden from the main view.
    • Properties - A viewing tool for markdown files, based on their properties.
  • Drag & drop reordering for portal tabs and stacks (desktop).
  • Mobile friendly – Responsive design that works on small screens. Tested on Android (more platforms coming).
  • Export/Import settings – Backup your tab configuration or transfer it to another vault using json files from Settings.

⚙️ Installation

Using Community Plugins

  1. Enable community plugins: Go to Settings → Community plugins → Turn on community plugins
  2. Install Portals: Click "Browse" → Search for "Portals" → Install

Using BRAT (Beta Reviewers Auto-update Tester)

  1. Install the BRAT plugin from the Obsidian community plugins (if you haven’t already).
  2. Open BRAT settings and click Add Beta plugin.
  3. Enter the repository URL: https://github.com/samaraliwarsi/obsidian-portals.
  4. Click Add Plugin – BRAT will download and enable the latest release.

Manual installation

  1. Download the latest release from the releases page.
  2. Extract the files into your vault’s .obsidian/plugins/portals/ folder.

📝 Notes

README file from

Github

Portals for Obsidian

Portals enhances your Obsidian file navigation by letting you pin any folder or tag as a customisable tab, a Portal into your selected folder trees. Add icons to Tabs, background colours, gradients and rearrange them to suit your workflow.

Portals_Main

Portals_Side

✨ Features

  • Pin folders & tags as tabs at the top of the file pane.
  • Stacks – group multiple tabs into collapsible stacks.
  • Custom icons, colours & emojis – Use Phosphor, Lucide, or native emojis; picker includes favourites and a custom paste field.
  • Auto collapse folders - Automatically fold and unfold folders or tag summaries that are in use.
  • File preview – Show content snippets below filenames; toggle per file or globally.
  • Sections – Organise folders or tags into collapsible section breaks (by property or extension).
  • Dynamic commands – Every portal tab (folder or tag) is registered as its own command in the command palette for quick switching without leaving the keyboard.
  • Auto backups – Automatically save data.json on Obsidian reload.
  • Six visual styles + compact tree view + bold folder names.
  • Tag grouping & subtag support for tag portals.
  • Multi‑select files, folders, and tags with Alt+Click or Swipe right. Use multi-select toolbar for actions.
  • Command palette support includes many commands that can enhance workflow, especially when coupled with hotkeys.
  • Foldable floating action buttons for note/ folder creation, tag grouping, sections, collapse and sort.
  • Quick-add buttons for folders, tags to quickly create new items inside the target folder or tag.
  • Custom display names for tabs, stacks.
  • Side Portal - A modular, collapsible, resizable view containing, Bookmarks, Recent Files, Context notes, Hidden, Reminders, Properties and Journal.
    • Context Notes - an expansion to the older Folder notes feature. Context notes apply to folder as well as tags.
    • Recents - Shows recent files list from across the vault.
    • Bookmarks - Shows bookmarked files, folders or web links.
    • Journal - A viewing and marking tool for Daily Notes with a quote display feature.
    • Hidden - Place to show files, tags and folders hidden from the main view.
    • Properties - a full database view with multi-property filtering, saved views, grouped lists and much more for property based querying.
    • Trash - A trash explorer for notes and folders based on Obsidian's .trash folder at vault root.
    • Reminders - A side portal view for tracking due dates on notes.
  • Drag & drop reordering for portal tabs and stacks (desktop).
  • Mobile friendly – Responsive design that works on small screens. Tested on Android (more platforms coming).
  • Export/Import settings – Backup your tab configuration or transfer it to another vault using json files from Settings.

For a full featured guide, checkout Portals guide

[!Note]

  • Please back up your data file after preferences setup, colour & icon choices. Copy the file .obsidian/plugins/portals/data.json to a safe location. You can also export the same via Settings and later import it. Make sure to backup before any plugin updates.
  • Portals requires Obsidian 1.13.0 or later. If you're on an older version, update Obsidian please.
  • For best results,
    • On mobile: Works best with Baseline Theme as the theme renders vault on the top side. On other themes, turn off floating navigation in settings, i.e. Settings > Appearance > Floating Navigation.
    • On desktop, you may need to turn off vault hiding if your theme hides the vault selector on the lower side.
    • Auto backups – Enable in settings to save your configuration automatically on Obsidian reload.

⚙️ Installation

Using Community Plugins

  1. Enable community plugins: Go to Settings → Community plugins → Turn on community plugins
  2. Install Portals: Click "Browse" → Search for "Portals" → Install

Using BRAT (Beta Reviewers Auto-update Tester)

  1. Install the BRAT plugin from the Obsidian community plugins (if you haven’t already).
  2. Open BRAT settings and click Add Beta plugin.
  3. Enter the repository URL: https://github.com/samaraliwarsi/obsidian-portals.
  4. Click Add Plugin – BRAT will download and enable the latest release.

Manual installation

  1. Download the latest release from the releases page.
  2. Extract the files into your vault’s .obsidian/plugins/portals/ folder.
  3. Enable the plugin in Obsidian settings.

🚀 Quick start

  • First installation - use Ribbon menu or command palette to open Portals view.
  • Add portal tabs using settings or command palette.
  • Add existing portals to stacks using Right-click context menu on tabs.
  • Drag tabs left/right to reorder.
  • Add Side Portals using settings, command palette.
  • Side Portal can be turned off for mobile devices.
  • Customise tags, stacks and folders.

For detailed walkthroughs and tips, read the Portals Guide.

🧑‍💻 Development

Clone the repository, install dependencies, and build:


git clone https://github.com/samaraliwarsi/obsidian-portals.git

cd obsidian-portals

npm install

npm run build

The built main.js and styles.css will be in the root folder. Copy them into your test vault’s .obsidian/plugins/portals/ directory.

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.