https://github.com/4542elgh/obsidian_customjs_demo
https://github.com/4542elgh/obsidian_customjs_demo
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/4542elgh/obsidian_customjs_demo
- Owner: 4542elgh
- License: mit
- Created: 2023-08-19T22:03:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-19T22:33:59.000Z (almost 2 years ago)
- Last Synced: 2024-11-13T17:45:54.401Z (7 months ago)
- Language: JavaScript
- Size: 1.04 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - 4542elgh/obsidian_customjs_demo - (JavaScript)
README
# CustomJS and Dataview API demo
This is a very simple demo of `CustomJS` and `Dataview` plugin.
- I use CustomJS to fetch data from
- Weather API `https://www.weather.gov/documentation/services-web-api`
- HackersNews API `https://hacker-news.firebaseio.com/v0/topstories.json`
- Dataview to display the data inside note. (I usually place this inside banner dashboard so I see it first thing in the morning)
You might need some programming knowledge to get this working or just modify this demo project to your need.
I will try my best to explain every single detail so you can create your own customJS script.
At anytime you having issue with javascript, use `Ctrl + Shift + i` to open the developer console and see if you can track the error.
Also there is a chance you need to restart your obsidian vault for plugin things to work properly the first time, try restarting if something weird is happening
# Dataview
You need to install the plugin but I leave everything as default
# CustomJS setup
You can specify to the parent folder of your scripts, all my scripts are inside `__data__/javascript` and I only have to specify to `__data__` folder
## Weather
### In the notes where you want to display the content add the following:
1. Import the class using `const {WeatherGov} = customJS;`. This `WeatherGov` is the same name as your javascript file's class name.
2. Create a new div container in your note page to hold the data
3. Call the class function `.getWeather(element)` and wait for asynchronous function to finish
1. Passing in the div container so it can be modify by javascript functions
2. Asynchronous function are function that process in the background, so this fetching process (if very long) will not block your UI from freezing/waiting on the request to finish
### Code
Just read the code, it got comment on every line
```dataviewjs
const {WeatherGov} = customJS;
let element = this.container.createEl('div', {cls: ["tailwind"]});
await WeatherGov.getWeather(element)
```
## Hacker News
### In the notes where you want to display the content add the following:
1. Import the class using `const {News} = customJS;`. This `Newr` is the same name as your javascript file's class name.
2. Create a new div container in your note page to hold the data
3. Call the class function `.getNews(element)` and wait for asynchronous function to finish
1. Passing in the div container so it can be modify by javascript functions
2. Asynchronous function are function that process in the background, so this fetching process (if very long) will not block your UI from freezing/waiting on the request to finish
### Code
Just read the code, it got comment on every line
```dataviewjs
const {News} = customJS;
let element = this.container.createEl('div', {cls: ["tailwind"]});
await News.listNews(element, 15);
```