Skip to content

mlava/sticky-headings

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 

Repository files navigation

Do you ever get lost in your document, and not know where you are? Make your Roam Research headings 'sticky' so that when you scroll down your headings stick at the top of the page.

New:

  • now compatible with the new user-defined hotkeys function - see Hotkeys option in Roam Research Settings
  • always on mode (turn on in Roam Depot settings) - keep Sticky Headings enabled. You can still turn it off while on an individual page using the Command Palette or keyboard shortcut, but when you change pages it will turn back on. If you keep this setting off, Sticky Headings will behave as it always has - you will have to toggle it on and off manually.
  • now compatible with Augmented Headings extension, which allows H4-H6 level headings in addition to the Roam native H1-H3

No configuration is required. When the extension is loaded you have two options to turn on Sticky Headings such that any blocks set as headings in your graph will be sticky:

  1. via Command Palette using 'Toggle Sticky Headings'
  2. using a configurable keyboard shortcut via Roam Settings > Hotkeys

Both of these will toggle Sticky Headings on and off.

sticky-headings

The extension will adjust for any css tweaks you apply, including using themes or even Roam Studio and Roam "Native" Dark. Just make sure to toggle the Sticky Headings state after changing your styles and the extension will pick up the new styles and correct for them. If you find a theme in which the headings don't render properly, please let me know!

Note: In order to determine the height of the headings, the extension looks for headings on your page and gets their calculated height from css. If you don't have any headings on your page it won't be able to do so. In that case, add some headings of H1, H2 and H3 and then toggle Sticky Headings. It will then re-calculate the size and you should be right to go.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published