HyperOnion
/
json_as_html
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

edit readme. 

elaborate on how to use with different kinds of input. also mention that
the name isn't literal; this takes javascript data, not json, as input.
This commit is contained in:
trans_soup 2023-07-16 15:40:57 +02:00
parent 1097974534
commit a4191ed3df
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,9 +1,13 @@
small utility for creating DOM trees from javascript arrays.
note that this doesn't actually take a json string, but rather an actual array, as input. `array_as_html` would be a bit inaccurate though, since it also handles some other things such as functions and strings in ways that make sense.
to use, clone/submodule/subtree/whatever the `main` branch, and import `json_as_html` from `export.mjs`.
to see a demo, or contribute, clone the `dev` branch.
# example
here's the demo array being used at the time of writing this:
```javascript
@ -30,3 +34,25 @@ here's the demo array being used at the time of writing this:
```
it assumes a function `render` which replaces the contents of the `<body>` with the result of calling `json_as_html` with this array as argument. it also assumes a `Map` called `state`.
# how to use
the `json_as_html` function takes two arguments:
1. a required `json` argument that gets transformed into a tree of `Node`s.
2. an optional `state` argument which defaults to an empty `Map`.
this is how the function returns, given certain types of `json` input:
- `Node` object: return it as it is.
- string: return a text node containing the string.
- function: evaluate the function, with `state` as argument, and recursively call `json_as_html` on the result. return what that recursive call returns.
- array: see below.
when given an array as `json` input, the function treats its elements as the tag name, attributes, and children, of the `Node` to create, in that order. call these `type`, `attributes`, and `children`:
- `type` is expected to be a string.
- `attributes` is expected to be an array, where each element is a key-value pair.
- `children` is expected to be an array containing valid inputs for `json_as_html`. if it's not an array, it's treated as an array containing a single element.
both `attributes` and `children` default to empty arrays, and may thus be omitted.