https://github.com/claremacrae/reveal-active-file-button-plugin

Obsidian plugin to add a button to the top of the Obsidian File Explorer, to reveal the active file.
https://github.com/claremacrae/reveal-active-file-button-plugin

Last synced: 2 months ago
JSON representation

Obsidian plugin to add a button to the top of the Obsidian File Explorer, to reveal the active file.

• Host: GitHub
• URL: https://github.com/claremacrae/reveal-active-file-button-plugin
• Owner: claremacrae
• License: mit
• Created: 2021-10-31T12:45:22.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-30T13:27:57.000Z (over 1 year ago)
• Last Synced: 2024-10-31T17:12:28.341Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 446 KB
• Stars: 58
• Watchers: 7
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
## "Reveal Active File Button" Obsidian Plugin

## Contents

  * [Purpose](#purpose)

  * [Usage](#usage)

  * [Tips](#tips)

    * [If scroll position isn't quite correct](#if-scroll-position-isnt-quite-correct)

    * [If you tested version 1.0.0](#if-you-tested-version-100)

  * [Changelog](#changelog)

  * [Related Plugins](#related-plugins)

  * [Thanks](#thanks)

## Purpose

**Reveal Active File Button** is an Obsidian plugin that adds a single-click button to **make the [Obsidian.md](https://obsidian.md) File Explorer/Navigator show your active file**, for example to find neighbouring files.

This is a convenient addition to these built-in options already included in Obsidian:

- The command "File explorer: Reveal active file in navigation"

- The pane menu option "Reveal file in navigation"

## Usage

To scroll Obsidian File Explorer/Navigator show your active file, click on the crosshairs icon:

![RevealActiveFile](docs/images/reveal-active-file-icon.png)

The result:

![ActiveFileRevealed](docs/images/active-file-highlighted.png)

## Tips

### If scroll position isn't quite correct

- If the File Explorer/Navigator does not quite scroll to the correct position, click the button a second time and it will work.

  - Explanation: the button simply invokes the built-in Obsidian command "File explorer: Reveal active file in navigation".

  - In large vaults, or for a file in a folder with a large number of files, the command does not always move to the correct position the first time.

  - A second request appears to work reliably. 

### If you tested version 1.0.0

If you are one of a few people that tested this plugin before it was added to the list of Community Plugins, you should remove that old version, as the plugin has been renamed.

For help with doing that, see [Removing version 1.0.0](docs/RemoveV100.md).

## Changelog

See [Changelog](CHANGELOG.md).

## Related Plugins

- [Collapse All](https://github.com/OfficerHalf/obsidian-collapse-all)

  - This plugin collapses and expands the file explorer

  - It is compatible with this plugin: both can be installed, and are useful alongside each other, as shown in this image:  

  ![collapse-all-and-reveal-active](docs/images/collapse-all-and-reveal-active.png)

- [Automatically Reveal Active File](https://github.com/shichongrui/obsidian-reveal-active-file)

  - Use this if you always want the navigator to show the active file

  - And you don't mind Obsidian jumping away from other views, like Search results or the Tags panel

## Thanks

- This code is heavily based on Nathan Smith's [Collapse All](https://github.com/OfficerHalf/obsidian-collapse-all) plugin, with thanks.