A Roam Research extension that implements the "reference path" for the active block being edited.
Based on previous work done by:
- Dhrumil Shah (@wandcrafting) and Robert Haisfield (@RobertHaisfield): https://www.figma.com/file/5shwLdUCHxSaPNEO7pazbe/
- Azlen Elza (@azlenelza): https://gist.github.com/azlen/cc8d543f0e46e17d978e705650df0e9e
This extension should be installed using Roam Depot. It doesn't manipulate your notes in any way. The reference path is added using a few css rules and css variables.
Demo:
The settings can be grouped in 3 categories:
- settings for the bullets
- settings for the lines
- settings for the references
(more details soon)
2 modes: edit and hover (each of them can be enabled/disabled)
- Edit mode: the reference path is shown when some block is being edited
- Hover mode: the reference path is shown when the mouse hover over a block
If both modes are enabled, hover mode works only when there is no block being edited
(more details soon)
This extension was carefully tested with the default Roam theme and with Roam Studio. It should be possible to use it safely with other extensions or custom themes available in Roam Depot. If you notice any incompatibility with other extensions, please open an issue on github so that it can be fixed.
- document the available options (or at least show a printscreen of the settings screen)
- review the extension name: "reference path" is also used in Settings -> User (in the context of block references), so it can be confusing.
- test with different themes available in roam depot to check if there are conflicts in the css
- handle right-to-left
- [DONE] add options for left,top fine tuning
- [DONE] show the line in the reference path
- [DONE] add as inline array of hex strings (instead of relying on roam to have the tailwind css)
- [DONE] highlight references/tags in the reference path
- [DONE] adjust the top/left according to the scale
- [DONE] improve the reference path for embeded blocks