Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/8bitgentleman/Roam-Render-Components
A collection of custom components for Roam Research written in clojurescript
https://github.com/8bitgentleman/Roam-Render-Components
Last synced: about 1 month ago
JSON representation
A collection of custom components for Roam Research written in clojurescript
- Host: GitHub
- URL: https://github.com/8bitgentleman/Roam-Render-Components
- Owner: 8bitgentleman
- Created: 2021-05-04T16:45:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-23T18:17:07.000Z (over 1 year ago)
- Last Synced: 2024-08-02T20:44:07.329Z (4 months ago)
- Language: Clojure
- Homepage:
- Size: 3.96 MB
- Stars: 48
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- my-awesome - 8bitgentleman/Roam-Render-Components - 04 star:0.0k fork:0.0k A collection of custom components for Roam Research written in clojurescript (Clojure)
README
Roam/Render Components
[]()
[](/LICENSE)
---
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](#getting_started)
- [Usage](#usage)
- [Components](#components)
- [TODO Progress Bar](#progress)
- [Count Child Blocks](#count)
- [Namespace Pages List](#namespace)
- [Shopping List Sum Prices](#sum)
- [WIP - Highlight Review](#highlight)
- [WIP - Roam to Orbit](#orbit)
- [WIP - Stopwatch](#stopwatch)
- [Authors](#authors)
### 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
- ### 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](https://roamresearch.com/#/app/developer-documentation/page/7l31uEMqA)
- [Clojurescript](https://clojurescript.org/)
## ✍️ Authors
- [Matt Vogel](https://github.com/8bitgentleman) - Idea & Initial work