Roam-Render-Components

Roam-Render-Components copied to clipboard

Roam/Render Components

A collection of custom components for Roam Research, writing in roam/render with clojurescript.
Interested in Roam JS plugins? Check some of mine here

📝 Table of Contents

• Installing

• Usage

• Components

  • TODO Progress Bar
  • Count Child Blocks
  • Namespace Pages List
  • Shopping List Sum Prices
  • WIP - Highlight Review
  • WIP - Roam to Orbit
  • WIP - Stopwatch

• Authors

🏁 Installing

Prerequisites

Make sure "Custom Code" is enabled within your settings.

Importing

To install, import the .JSON file for the desired component into Roam.

🎈 Usage

To add the progress bar you can trigger it with the included Roam template. From within Roam type

;;COMPONENT_NAME_HERE

and select the item

🤖 Components

• TODO Progress Bar

  Look for and download the latest JSON Release then import into Roam here

  

• Count Block Children

  Counts the number of children a block has. Look for and download the latest JSON Release then import into Roam here

  

• Namespace Page List

  This component will create a dynamic list of all pages within a certain namespace (roam for example would include roam/js, roam/css, etc ). This can be useful to see a dynamic list of all Projects, Books, People, etc. To use simply trigger the included template ( ;;) and pass your desired namespace into the component as an argument Look for and download the latest JSON Release then import into Roam here

  

• Shopping List Sum Prices

  Searches all block children for prices in USD (eg. $10) and sums everything up. Look for and download the latest JSON Release then import into Roam here

  

• WIP Highlight Review

  This is a WIP component which creates a custom UI where highlights/quotes in your graph can be reviewed. For this extension to work highlights must be nested under a specific tag/page/attribute quotes. It's currently extremely picky about the format and metadata that your pages have. I've included my personal template but any block nested under #quotes should be seen by the component. Look for and download the latest JSON Release then import into Roam here

  

• WIP Roam to Orbit

  THIS IS A WORK IN PROGRESS AND NOT READY FOR GENERAL USAGE

  This is a component that will integrate with Andy Matuschak's new open-source experimental spaced repetition platform Orbit. You will pass a page name string into the component and it will load all prompts and answers that reference that page. You can find the code and optional CSS here.

• WIP Roam Stopwatch

  THIS IS A WORK IN PROGRESS AND NOT READY FOR GENERAL USAGE

  This is a component that acts as a stopwatch, counting up instead of counting down (like POMO). When clicking the button the current lap length will be added as a child block and the lap will reset. To set a custom title pass in a string in quotes to the componenet. See the code and optional CSS here.

⛏️ Built Using

• roam/render
• Clojurescript

✍️ Authors

• Matt Vogel - Idea & Initial work